light

The standard light tube fixture

Vars
brightness_color	Light colour when on
brightness_power	Light intensity
brightness_range	Light range (Also used in power calculation)
bulb_emergency_colour	The colour of the light while it's in emergency mode
extinguished	Was this light extinguished with an antag ability? Used to ovveride flicker events
fitting	Type of light bulb that goes into the fixture
flickering	Is the light currently flickering?
light_state	If the light state has changed since the last 'update()', also update the power requirements
light_type	Item type of the light bulb
lightmaterials	Materials the light is made of
nightshift_allowed	Allowed to be switched to night shift mode?
nightshift_enabled	Currently in night shift mode?
nightshift_light_color	The colour of the light while it's in night shift mode
nightshift_light_power	Light intensity when in night shift mode
nightshift_light_range	Light range when in night shift mode
on	Is the light on or off?
rigged	Is the light rigged to explode?
static_power_used	How much power does it use?
status	Light fixture status (LIGHT_OK \| LIGHT_EMPTY \| LIGHT_BURNED \| LIGHT_BROKEN)
switchcount	How many times has the light been switched on/off? (This is used to calc the probability the light burns out)
turning_on	Is the light currently turning on?
Procs
_turn_on	The actual proc to turn on the lightbulb.
flicker_event	Flicker routine for the light. Called by invoke_async so the parent proc can return immediately.
update	Updates the light's 'on' state and power consumption based on /obj/machinery/light/var/on.

Var Details

var
brightness_color
–

Light colour when on

var
brightness_power
–

Light intensity

var
brightness_range
–

Light range (Also used in power calculation)

var
bulb_emergency_colour
–

The colour of the light while it's in emergency mode

var
extinguished
–

Was this light extinguished with an antag ability? Used to ovveride flicker events

var
fitting
–

Type of light bulb that goes into the fixture

var
flickering
–

Is the light currently flickering?

var
light_state
–

If the light state has changed since the last 'update()', also update the power requirements

var
light_type
–

Item type of the light bulb

var
lightmaterials
–

Materials the light is made of

var
nightshift_allowed
–

Allowed to be switched to night shift mode?

var
nightshift_enabled
–

Currently in night shift mode?

var
nightshift_light_color
–

The colour of the light while it's in night shift mode

var
nightshift_light_power
–

Light intensity when in night shift mode

var
nightshift_light_range
–

Light range when in night shift mode

var
on
–

Is the light on or off?

var
rigged
–

Is the light rigged to explode?

var
static_power_used
–

How much power does it use?

var
status
–

Light fixture status (LIGHT_OK | LIGHT_EMPTY | LIGHT_BURNED | LIGHT_BROKEN)

var
switchcount
–

How many times has the light been switched on/off? (This is used to calc the probability the light burns out)

var
turning_on
–

Is the light currently turning on?

Proc Details

proc
_turn_on
(trigger, play_sound)

The actual proc to turn on the lightbulb.

Private proc, do not call directly. Use /obj/machinery/light/proc/update instead.

Sets the light power, range, and colour based on environmental conditions such as night shift and fire alarms. Also handles light bulbs burning out and exploding if trigger is TRUE.

proc
flicker_event
(amount)

Flicker routine for the light. Called by invoke_async so the parent proc can return immediately.

proc
update
(trigger, instant, play_sound)

Updates the light's 'on' state and power consumption based on /obj/machinery/light/var/on.

Arguments:

trigger - Should this update check if the light will explode/burn out.
instant - Will the lightbulb turn on instantly, or after a short delay.
play_sound - Will the lightbulb play a sound when it's turned on.

Light fixture /obj/machinery/light

Vars

Procs

Var Details

var brightness_color –

var brightness_power –

var brightness_range –

var bulb_emergency_colour –

var extinguished –

var fitting –

var flickering –

var light_state –

var light_type –

var lightmaterials –

var nightshift_allowed –

var nightshift_enabled –

var nightshift_light_color –

var nightshift_light_power –

var nightshift_light_range –

var on –

var rigged –

var static_power_used –

var status –

var switchcount –

var turning_on –