cmtv

Vars
camera_mob	For convenience, a reference to their camera mob
camera_operator	Our perspective, based on a specific ckey, either found in init or post-join via DCS
current_perspective	A hardref to the person we are currently watching, with a bunch of signals subscribed.
future_perspective	A weakref of who we will be switching to after the delay to ensure they can cancel, if they want to.
minimum_screentime	How long until we should start polling to change perspective excluding mobs dying or other factors that make a mob ineligible based on DCS
next_show_time	How long our next contestant will be shown for
opted_out_ckeys	Ckeys that have opted out -> when they opted outs. If within the last 5 minutes, they're excluded
priority_list	The cached list of priority groups for observing. This is used so we can ensure we're only switching perspective if there is someone more interesting to watch instead.
subscribers	List of subscriber IDs, retrieved from the cmtv_api endpoint
switch_at	The time that we should switch to our new perspective
temporarily_observing_turf	While we're currently checking out a different turf, the time remaining till we switch back
to_switch_to	Who we should check out when we're finished observing turfs. Can be null, or a hardref to a mob
Procs
change_observed_mob	Takes a new mob to observe. If there is already a queued up mob, or a current perspective, they will be notified and dropped. This will become the new perspective in 10 seconds. If set to instant, we immediately switch to observe nothing. If set_showtime is set, the camera will stay on the new perspective for at least this long, unless they die or something.
do_init_chat	To ensure the chat is fully initialised after we nuke it, we wait a bit before sending it an action
get_active_player	From the cached priority list, pulls an active player in priority order
get_active_priority_player_list	Returns a list of weakrefs of mobs in certain priority groups. Priority 1 are active combatants, Priority 2 are mobs that are active and on the groundmap (except in hijack, where they must just be active) and Priority 3 are mobs that are, at least, active.
get_most_active_list	Returns the mob list with the greatest priority. If there are priority 1 mobs, it will return that list, even if there is only one.
handle_new_camera	Sets up the camera client, including assigning a new mob, making it widescreen, winsetting() for clarity
handle_new_client	Signal handler for if the client disconnects/rejoins midround
handle_reset_signal	Generic reset handler, will keep the perspective on the old mob till the new one accepts
handle_reset_signal_immediate	Reset handler that immediately switches perspective to something generic while we wait
handle_roundstart	For events we want to occur at the beginning of the round - eg, when the map becomes actually visible
handle_z_change	Signal handler - it might be dull if a player wanders off to medical on the ship.
is_active	If a player is still categorised as being active
is_combatant	Checks if the latest /datum/cause_data was generated within the given delay_time
reset_perspective	Generic signal handler for deaths, nestings, logouts, etc. Immediately queues up a new perspective to be switched to

Var Details

var
camera_mob
– /mob/dead/observer

For convenience, a reference to their camera mob

var
camera_operator
– /client

Our perspective, based on a specific ckey, either found in init or post-join via DCS

var
current_perspective
– /mob

A hardref to the person we are currently watching, with a bunch of signals subscribed.

var
future_perspective
– /datum/weakref

A weakref of who we will be switching to after the delay to ensure they can cancel, if they want to.

var
minimum_screentime

How long until we should start polling to change perspective excluding mobs dying or other factors that make a mob ineligible based on DCS

var
next_show_time

How long our next contestant will be shown for

var
opted_out_ckeys
– /alist

Ckeys that have opted out -> when they opted outs. If within the last 5 minutes, they're excluded

var
priority_list
– /list

The cached list of priority groups for observing. This is used so we can ensure we're only switching perspective if there is someone more interesting to watch instead.

var
subscribers
– /list

List of subscriber IDs, retrieved from the cmtv_api endpoint

var
switch_at

The time that we should switch to our new perspective

var
temporarily_observing_turf

While we're currently checking out a different turf, the time remaining till we switch back

var
to_switch_to
– /datum/weakref

Who we should check out when we're finished observing turfs. Can be null, or a hardref to a mob

Proc Details

proc
change_observed_mob
(/mob/new_perspective, instant_switch_away, instant_switch_to, set_showtime, change_reason)

Takes a new mob to observe. If there is already a queued up mob, or a current perspective, they will be notified and dropped. This will become the new perspective in 10 seconds. If set to instant, we immediately switch to observe nothing. If set_showtime is set, the camera will stay on the new perspective for at least this long, unless they die or something.

proc
do_init_chat
()

To ensure the chat is fully initialised after we nuke it, we wait a bit before sending it an action

proc
get_active_player
()

From the cached priority list, pulls an active player in priority order

proc
get_active_priority_player_list
()

Returns a list of weakrefs of mobs in certain priority groups. Priority 1 are active combatants, Priority 2 are mobs that are active and on the groundmap (except in hijack, where they must just be active) and Priority 3 are mobs that are, at least, active.

proc
get_most_active_list
()

Returns the mob list with the greatest priority. If there are priority 1 mobs, it will return that list, even if there is only one.

proc
handle_new_camera
(/client/camera_operator, round_start)

Sets up the camera client, including assigning a new mob, making it widescreen, winsetting() for clarity

proc
handle_new_client
(SSdcs, /client/new_client)

Signal handler for if the client disconnects/rejoins midround

proc
handle_reset_signal
()

Generic reset handler, will keep the perspective on the old mob till the new one accepts

proc
handle_reset_signal_immediate
()

Reset handler that immediately switches perspective to something generic while we wait

proc
handle_roundstart
()

For events we want to occur at the beginning of the round - eg, when the map becomes actually visible

proc
handle_z_change
(/atom/movable/moving, old_z, new_z)

Signal handler - it might be dull if a player wanders off to medical on the ship.

proc
is_active
(/mob/possible_player, delay_time)

If a player is still categorised as being active

proc
is_combatant
(/mob/possible_combatant, delay_time)

Checks if the latest /datum/cause_data was generated within the given delay_time

proc
reset_perspective
(reason, instant)

Generic signal handler for deaths, nestings, logouts, etc. Immediately queues up a new perspective to be switched to

CMTV /datum/controller/subsystem/cmtv

Vars

Procs

Var Details

var camera_mob – /mob/dead/observer

var camera_operator – /client

var current_perspective – /mob

var future_perspective – /datum/weakref

var minimum_screentime

var next_show_time

var opted_out_ckeys – /alist

var priority_list – /list

var subscribers – /list

var switch_at

var temporarily_observing_turf

var to_switch_to – /datum/weakref

Proc Details

proc change_observed_mob(/mob/new_perspective, instant_switch_away, instant_switch_to, set_showtime, change_reason)

proc do_init_chat()

proc get_active_player()

proc get_active_priority_player_list()

proc get_most_active_list()

proc handle_new_camera(/client/camera_operator, round_start)

proc handle_new_client(SSdcs, /client/new_client)

proc handle_reset_signal()

proc handle_reset_signal_immediate()

proc handle_roundstart()

proc handle_z_change(/atom/movable/moving, old_z, new_z)

proc is_active(/mob/possible_player, delay_time)

proc is_combatant(/mob/possible_combatant, delay_time)

proc reset_perspective(reason, instant)