/tg/ Station 13 - Modules - TypesVar Details - Proc Details

cinematic

Cinematic datum. Used to show an animation to everyone.

Vars

cleanup_timeHow long for the final screen remains shown
is_globalWhether the cinematic is a global cinematic or not
lockedA list of all mobs who have notransform set while watching the cinematic
screenRefernce to the cinematic screen shown to everyohne
special_callbackCallbacks passed that occur during the animation
stop_oocWhether the cinematic turns off ooc when played globally.
watchingA list of all clients watching the cinematic

Procs

clean_up_cinematicCleans up the cinematic after a set timer of it sticking on the end screen.
handle_replacement_cinematicsWhenever another cinematic starts to play over us, we have the chacne to block it.
invoke_special_callbackInvoke any special callbacks for actual effects synchronized with animation. (Such as a real nuke explosion happening midway)
play_cinematicThe actual cinematic occurs here.
play_cinematic_soundSimple helper for playing sounds from the cinematic.
remove_watcherRemoves the passed client from our watching list.
show_toWhenever a mob watching the cinematic logs in, show them the ongoing cinematic
start_cinematicActually goes through the process of showing the cinematic to the list of watchers.
stop_cinematicStops the cinematic and removes it from all the viewers.

Var Details

cleanup_time

How long for the final screen remains shown

is_global

Whether the cinematic is a global cinematic or not

locked

A list of all mobs who have notransform set while watching the cinematic

screen

Refernce to the cinematic screen shown to everyohne

special_callback

Callbacks passed that occur during the animation

stop_ooc

Whether the cinematic turns off ooc when played globally.

watching

A list of all clients watching the cinematic

Proc Details

clean_up_cinematic

Cleans up the cinematic after a set timer of it sticking on the end screen.

handle_replacement_cinematics

Whenever another cinematic starts to play over us, we have the chacne to block it.

invoke_special_callback

Invoke any special callbacks for actual effects synchronized with animation. (Such as a real nuke explosion happening midway)

play_cinematic

The actual cinematic occurs here.

play_cinematic_sound

Simple helper for playing sounds from the cinematic.

remove_watcher

Removes the passed client from our watching list.

show_to

Whenever a mob watching the cinematic logs in, show them the ongoing cinematic

start_cinematic

Actually goes through the process of showing the cinematic to the list of watchers.

stop_cinematic

Stops the cinematic and removes it from all the viewers.