beacon

This component is used to give stuff beacon functionality.

Vars
activator	The mob who activated this beacon
active	Is the beacon active?
active_icon_state	The icon state when this beacon is active
anchor	Should the parent anchor on activation?
anchor_time	How long it takes for this item to activate it's signal/deploy
beacon_cam	The camera attached to the beacon
beacon_datum	The reference to the beacon datum
Procs
activate	Activates the beacon
clean_beacon_datum	If the signal source dies, the beacon datum should as well
deactivate	Deactivates the beacon
on_attack_hand	This will only get called when you want to deactivate a beacon, ie clicking a deployed beacon
on_attack_self	The proc that gets called when the user uses the item in their hand
on_examine	Adds an extra line of instructions to the examine
on_update_icon_state	Updates the icon state of the object to an active state, if it has one
on_update_name	Gives the beacon broadcaster object the appropriate, descriptive name
on_z_change	What happens when we change Z level
toggle_activation	Toggles the active state of the beacon

Var Details

var
activator
– /mob

The mob who activated this beacon

var
active
–

Is the beacon active?

var
active_icon_state
–

The icon state when this beacon is active

var
anchor
–

Should the parent anchor on activation?

var
anchor_time
–

How long it takes for this item to activate it's signal/deploy

var
beacon_cam
– /obj/machinery/camera

The camera attached to the beacon

var
beacon_datum
– /datum/supply_beacon

The reference to the beacon datum

Proc Details

proc
activate
(/atom/movable/source, /mob/user)

Activates the beacon

proc
clean_beacon_datum
()

If the signal source dies, the beacon datum should as well

proc
deactivate
(/atom/movable/source, /mob/user)

Deactivates the beacon

proc
on_attack_hand
(/atom/movable/source, /mob/user)

This will only get called when you want to deactivate a beacon, ie clicking a deployed beacon

proc
on_attack_self
(/atom/movable/source, /mob/user)

The proc that gets called when the user uses the item in their hand

proc
on_examine
(/atom/source, /mob/user, /list/examine_list)

Adds an extra line of instructions to the examine

proc
on_update_icon_state
(/atom/source, updates)

Updates the icon state of the object to an active state, if it has one

proc
on_update_name
(/atom/source, updates)

Gives the beacon broadcaster object the appropriate, descriptive name

proc
on_z_change
(/atom/source, old_z, new_z)

What happens when we change Z level

proc
toggle_activation
(/atom/movable/source, /mob/user)

Toggles the active state of the beacon

beacon /datum/component/beacon

Vars

Procs

Var Details

var activator – /mob

var active –

var active_icon_state –

var anchor –

var anchor_time –

var beacon_cam – /obj/machinery/camera

var beacon_datum – /datum/supply_beacon

Proc Details

proc activate(/atom/movable/source, /mob/user)

proc clean_beacon_datum()

proc deactivate(/atom/movable/source, /mob/user)

proc on_attack_hand(/atom/movable/source, /mob/user)

proc on_attack_self(/atom/movable/source, /mob/user)

proc on_examine(/atom/source, /mob/user, /list/examine_list)

proc on_update_icon_state(/atom/source, updates)

proc on_update_name(/atom/source, updates)

proc on_z_change(/atom/source, old_z, new_z)

proc toggle_activation(/atom/movable/source, /mob/user)