Home

Welcome to the scumm-8 wiki!

Below you will find the SCUMM-8 API reference. This API was heavily inspired by the original SCUMM command reference, and kept close to the original (where possible/applicable).

SCUMM-8 API Reference

startup_script()

TODO: Document this...

find_default_verb()

TODO: Document this...

unsupported_action(verb, obj1, obj2)

Actions to perform when object doesn't have an entry for verb TODO: Document this...

camera_at(val)

TODO: Document this...

camera_follow(actor)

TODO: Document this...

camera_pan_to(val)

TODO: Document this...

wait_for_camera()

TODO: Document this...

cutscene(flags, func_cutscene, func_override)

TODO: Document this...

dialog_add(msg)

TODO: Document this...

dialog_start(col, hlcol)

TODO: Document this...

dialog_hide()

TODO: Document this...

dialog_clear()

TODO: Document this...

dialog_end()

TODO: Document this...

get_use_pos(obj)

TODO: Document this...

do_anim(actor, cmd_type, cmd_value)

TODO: Document this...

open_door(door_obj1, door_obj2)

open one (or more) doors TODO: Document this...

close_door(door_obj1, door_obj2)

close one (or more) doors TODO: Document this...

come_out_door(door_obj, fade_effect)

TODO: Document this...

fades(fade, dir)

1=down, -1=up TODO: Document this...

change_room(new_room, fade)

TODO: Document this...

pickup_obj(objname)

TODO: Document this...

owner_of(objname)

TODO: Document this...

state_of(objname, state)

TODO: Document this...

set_state(objname, state)

TODO: Document this...

find_object(name)

find object by ref or name TODO: Document this...

start_script(func, bg, noun1, noun2)

create new thread for script and add to list of local_scripts (or background scripts) TODO: Document this...

script_running(func)

TODO: Document this...

stop_script(func)

find script and stop it running TODO: Document this...

break_time(jiffies)

wait for cycles specified (min 1 cycle) TODO: Document this...

wait_for_message()

TODO: Document this...

say_line(actor, msg)

TODO: Document this...

stop_talking()

stop everyone talking & remove displayed text TODO: Document this...

print_line(msg, x, y, col, align)

punctuation...

":" new line, shown after text prior expires "," new line, shown immediately note: an actor's talk animation is not activated as it is with say-line. TODO: Document this...

put_actor_at(actor, x, y, room)

TODO: Document this...

walk_to(actor, x, y)

walk actor to position TODO: Document this...