/tg/ Station 13 - Modules - TypesVar Details - Proc Details

alarm_listener

Vars

accepting_alarm_changesShould we allow alarm changes to go through or not
alarmsList of alarm type -> list of area name -> list(area, ref to area's cameras, list(sources))
allowed_areasList of allowed areas. if this is null it's ignored
allowed_z_levelsList of valid source z levels, ignored if null

Procs

NewAccepts a list of alarm types to pay attention to, a list of valid z levels, and a list of valid areas. areas and zlevels are ignored if null
add_alarmAdds an alarm to our alarms list, you shouldn't be calling this manually It should all be handled by the signal listening we do, unless you want to only send an alarm to one listener
allow_alarm_changesDoes what it says on the tin, exists for signal hooking
clear_alarmRemoves an alarm to our alarms list, you probably shouldn't be calling this manually It should all be handled by the signal listening we do, unless you want to only remove an alarm to one listener
clear_camera_refUsed to manually clear camera refs if one is ref'd directly
prevent_alarm_changesDoes what it says on the tin, exists for signal hooking

Var Details

accepting_alarm_changes

Should we allow alarm changes to go through or not

alarms

List of alarm type -> list of area name -> list(area, ref to area's cameras, list(sources))

allowed_areas

List of allowed areas. if this is null it's ignored

allowed_z_levels

List of valid source z levels, ignored if null

Proc Details

New

Accepts a list of alarm types to pay attention to, a list of valid z levels, and a list of valid areas. areas and zlevels are ignored if null

add_alarm

Adds an alarm to our alarms list, you shouldn't be calling this manually It should all be handled by the signal listening we do, unless you want to only send an alarm to one listener

allow_alarm_changes

Does what it says on the tin, exists for signal hooking

clear_alarm

Removes an alarm to our alarms list, you probably shouldn't be calling this manually It should all be handled by the signal listening we do, unless you want to only remove an alarm to one listener

clear_camera_ref

Used to manually clear camera refs if one is ref'd directly

prevent_alarm_changes

Does what it says on the tin, exists for signal hooking