light

Vars
base_state	Base description and `icon_state`.
construct_type	Type path for the machine to create when dismantled. Should be `/obj/machinery/light_construct` or a subtype.
current_mode	The light's current lighting mode. One of `LIGHTMODE_*`.
flickering	Whether or not the light is currently flickering.
light_type	Type path of the light bulb item. Used for initialization and to determine what bulbs fit.
lightbulb	The installed light bolb.
on	Whether or not the light is turned on.
s	`spark_spread` effect datum.
Procs
broken	Break the light and make sparks if it was on.
fix	Fixes a broken light.
flicker	Causes the light to start flickering.
get_color_from_area	Fetches the light's color based on area flags. Used for Init and for smartly installing new bulbs during runtime (See light replacers).
get_fitting_name	Fetches the name of `light_type`.
get_mode_color	Return's the current mode's `l_color` value or, if there is no `current_mode`, the lightbulb's color.
get_status	Returns `lightbulb.status`.
insert_bulb	Attempts to insert a given light bulb. Called by `use_tool()`.
remove_bulb	Attempts to remove an installed light bulb. Called by `attack_hand()`.
set_emergency_lighting	Toggles the light's emergency lighting mode (`LIGHTMODE_EMERGENCY`).
set_mode	Set's the lights `current_mode`. `new_mode` should be one of `LIGHTMODE_*`.
seton	Sets the light's `on` state, if there's a functional light bulb installed.
switch_check	Calls `lightbulb.switch_on()` and updates the lighting and icon accordingly.

Var Details

var
base_state
–

Base description and icon_state.

var
construct_type
–

Type path for the machine to create when dismantled. Should be /obj/machinery/light_construct or a subtype.

var
current_mode
–

The light's current lighting mode. One of LIGHTMODE_*.

var
flickering
–

Whether or not the light is currently flickering.

var
light_type
–

Type path of the light bulb item. Used for initialization and to determine what bulbs fit.

var
lightbulb
– /obj/item/light

The installed light bolb.

var
on
–

Whether or not the light is turned on.

var
s
– /datum/effect/spark_spread

spark_spread effect datum.

Proc Details

proc
broken
(skip_sound_and_sparks)

Break the light and make sparks if it was on.

proc
fix
()

Fixes a broken light.

proc
flicker
(amount)

Causes the light to start flickering.

proc
get_color_from_area
()

Fetches the light's color based on area flags. Used for Init and for smartly installing new bulbs during runtime (See light replacers).

proc
get_fitting_name
()

Fetches the name of light_type.

proc
get_mode_color
()

Return's the current mode's l_color value or, if there is no current_mode, the lightbulb's color.

proc
get_status
()

Returns lightbulb.status.

proc
insert_bulb
(/obj/item/light/L)

Attempts to insert a given light bulb. Called by use_tool().

proc
remove_bulb
()

Attempts to remove an installed light bulb. Called by attack_hand().

proc
set_emergency_lighting
(enable)

Toggles the light's emergency lighting mode (LIGHTMODE_EMERGENCY).

proc
set_mode
(new_mode)

Set's the lights current_mode. new_mode should be one of LIGHTMODE_*.

proc
seton
(state)

Sets the light's on state, if there's a functional light bulb installed.

proc
switch_check
()

Calls lightbulb.switch_on() and updates the lighting and icon accordingly.

light /obj/machinery/light

Vars

Procs

Var Details

var base_state –

var construct_type –

var current_mode –

var flickering –

var light_type –

var lightbulb – /obj/item/light

var on –

var s – /datum/effect/spark_spread

Proc Details

proc broken(skip_sound_and_sparks)

proc fix()

proc flicker(amount)

proc get_color_from_area()

proc get_fitting_name()

proc get_mode_color()

proc get_status()

proc insert_bulb(/obj/item/light/L)

proc remove_bulb()

proc set_emergency_lighting(enable)

proc set_mode(new_mode)

proc seton(state)

proc switch_check()