cinematic

Cinematic datum. Used to show an animation to everyone.

Vars
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 TRAIT_NO_TRANSFORM 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
Procs
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)
lock_mob	Locks a mob, preventing them from moving, being hurt, or acting
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.
unlock_mob	Unlocks a previously locked weakref

Var Details

var
cleanup_time
–

How long for the final screen remains shown

var
is_global
–

Whether the cinematic is a global cinematic or not

var
locked
– /list/datum/weakref

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

var
screen
– /atom/movable/screen/cinematic

Refernce to the cinematic screen shown to everyohne

var
special_callback
– /datum/callback

Callbacks passed that occur during the animation

var
stop_ooc
–

Whether the cinematic turns off ooc when played globally.

var
watching
– /list/client

A list of all clients watching the cinematic

Proc Details

proc
clean_up_cinematic
(was_ooc_toggled)

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

proc
handle_replacement_cinematics
(/datum/source, /datum/cinematic/other)

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

proc
invoke_special_callback
()

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

proc
lock_mob
(/mob/to_lock)

Locks a mob, preventing them from moving, being hurt, or acting

proc
play_cinematic
()

The actual cinematic occurs here.

proc
play_cinematic_sound
(sound_to_play)

Simple helper for playing sounds from the cinematic.

proc
remove_watcher
(/client/no_longer_watching)

Removes the passed client from our watching list.

proc
show_to
(/mob/watching_mob, /client/watching_client)

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

proc
start_cinematic
(/list/watchers)

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

proc
stop_cinematic
()

Stops the cinematic and removes it from all the viewers.

proc
unlock_mob
(/datum/weakref/mob_ref)

Unlocks a previously locked weakref

cinematic /datum/cinematic

Vars

Procs

Var Details

var cleanup_time –

var is_global –

var locked – /list/datum/weakref

var screen – /atom/movable/screen/cinematic

var special_callback – /datum/callback

var stop_ooc –

var watching – /list/client

Proc Details

proc clean_up_cinematic(was_ooc_toggled)

proc handle_replacement_cinematics(/datum/source, /datum/cinematic/other)

proc invoke_special_callback()

proc lock_mob(/mob/to_lock)

proc play_cinematic()

proc play_cinematic_sound(sound_to_play)

proc remove_watcher(/client/no_longer_watching)

proc show_to(/mob/watching_mob, /client/watching_client)

proc start_cinematic(/list/watchers)

proc stop_cinematic()

proc unlock_mob(/datum/weakref/mob_ref)