Skip to main content

Events

This pages documents the events that can be listened for in FAR.

Inside the FAR resource there is a directory called editable, then editable/server, and within that there is a file called events.lua (editable/server/events.lua). That file documents all the available events for FAR, as well as their parameters. This page serves to compliment that file.

note

This page does not cover events inside of editable/client/targeting.lua, see here for information on those events.

Be sure to consult the Data Structures page to understand the structure of the parameters.

Alarm Systems​

Alarm Activation​

Fired when an Alarm System enters into Alarm. This is the recommended event to listen for when actioning Fire Alarm activations, as this event will only fire one-time per system, per activation.

For example, if a Pull Station is pulled, the system will go into alarm, and this event will fire. A second Pull Station in the same system is pulled, the system is already in alarm, this event will not re-fire, whereas PullStationTriggered will re-fire.

note

This event fires after PullStationTriggered, DetectorActivation, SprinklerActivation, and RandomAlarmActivation.

Event Name​

Inferno-Collection:Server:FireAlarmReborn:Editable:AlarmActivation

Parameters​

  • alarmSystem - AlarmSystem
    • Alarm System that has been triggered.

Muted​

Fired when an Alarm System that was in alarm, is muted via the Control Panel.

Event Name​

Inferno-Collection:Server:FireAlarmReborn:Editable:AlarmMuted

Parameters​

  • source - string
    • Server handle of the player who muted the Alarm System.
  • alarmSystem - AlarmSystem
    • Alarm System that was muted.

Sounded​

Fired when an Alarm System that was muted, is sounded again via the Control Panel.

Event Name​

Inferno-Collection:Server:FireAlarmReborn:Editable:AlarmSounded

Parameters​

  • source - string
    • Server handle of the player who sounded the Alarm System.
  • alarmSystem - AlarmSystem
    • Alarm System that was sounded.

Test​

Fired when an Alarm System is tested via the Control Panel.

Event Name​

Inferno-Collection:Server:FireAlarmReborn:Editable:SystemTest

Parameters​

  • source - string
    • Server handle of the player who tested the Alarm System.
  • alarmSystem - AlarmSystem
    • Alarm System that was tested.

Announcement​

Fired when an Alarm System plays an announcement via the Control Panel.

Event Name​

Inferno-Collection:Server:FireAlarmReborn:Editable:SystemAnnouncement

Parameters​

  • source - string
    • Server handle of the player who played the announcement.
  • alarmSystem - AlarmSystem
    • Alarm System that played the announcement.

WalkTest​

Fired when an Alarm System is placed into or out of WalkTest mode.

Event Name​

Inferno-Collection:Server:FireAlarmReborn:Editable:WalkTest

Parameters​

  • source - string
    • Server handle of the player who made the change.
  • alarmSystem - AlarmSystem
    • Alarm System change applied to.
  • enabled - bool
    • true if WalkTest enabled, false if WalkTest disabled.

Disabled​

Fired when an Alarm System is disabled or enabled.

Event Name​

Inferno-Collection:Server:FireAlarmReborn:Editable:SystemDisabled

Parameters​

  • source - string
    • Server handle of the player who made the change.
  • alarmSystem - AlarmSystem
    • Alarm System change applied to.
  • enabled - bool
    • true if system enabled, false if system disabled.

Monitoring​

Fired when an Alarm System's Monitoring is disabled or enabled.

Event Name​

Inferno-Collection:Server:FireAlarmReborn:Editable:MonitoringDisabled

Parameters​

  • source - string
    • Server handle of the player who made the change.
  • alarmSystem - AlarmSystem
    • Alarm System change applied to.
  • enabled - bool
    • true if monitoring enabled, false if monitoring disabled.

Random Activation​

Fired when a random Alarm System is activated, either via Command or scheduled Random Alarms.

Event Name​

Inferno-Collection:Server:FireAlarmReborn:Editable:RandomAlarmActivation

Parameters​

  • alarmSystem - AlarmSystem
    • Alarm System that has been triggered.
  • activationType - int
    • 1 - Detector activation
    • 2 - Sprinkler activation
    • 3 - Pull Station activation
  • activationComponent - Detector | Sprinkler | PullStation
    • The component that was activated.

Pull Stations​

Pulled​

Fired when a Pull Station is pulled.

Event Name​

Inferno-Collection:Server:FireAlarmReborn:Editable:PullStationTriggered

Parameters​

  • source - string
    • Server handle of the player who pulled the Pull Station.
  • alarmSystem - AlarmSystem
    • Alarm System that has been triggered.
  • pullStation - PullStation
    • Pull Station that was pulled.

Reset​

Fired when a Pull Station is reset.

Event Name​

Inferno-Collection:Server:FireAlarmReborn:Editable:PullStationReset

Parameters​

  • source - string
    • Server handle of the player who reset the Pull Station.
  • alarmSystem - AlarmSystem
    • Alarm System that has been triggered.
  • pullStation - PullStation
    • Pull Station that was reset.

Control Panels​

Opened​

Fired when a Control Panel is opened.

Event Name​

Inferno-Collection:Server:FireAlarmReborn:Editable:OpenControlPanel

Parameters​

  • source - string
    • Server handle of the player who opened the Control Panel.
  • alarmSystem - AlarmSystem
    • Alarm System that has been triggered.
  • controlPanel - ControlPanel
    • Control Panel that was opened.

Closed​

Fired when a Control Panel is closed.

Event Name​

Inferno-Collection:Server:FireAlarmReborn:Editable:CloseControlPanel

Parameters​

  • source - string
    • Server handle of the player who closed the Control Panel.

Detectors​

Triggered​

Fired when a Detector is triggered.

Event Name​

Inferno-Collection:Server:FireAlarmReborn:Editable:DetectorActivation

Parameters​

  • alarmSystem - AlarmSystem
    • Alarm System that has been triggered.
  • detector - Detector
    • Detector that was activated
  • position - table
    • Position of the activation, in a table, as a Vector3. 
      •   local position = vector3(position.x, position.y, position.z)

Sprinklers​

Triggered​

Fired when a Sprinkler is triggered.

Event Name​

Inferno-Collection:Server:FireAlarmReborn:Editable:SprinklerActivation

Parameters​

  • alarmSystem - AlarmSystem
    • Alarm System that has been triggered.
  • sprinkler - Sprinkler
    • Sprinkler that was activated
  • position - table
    • Position of the activation, in a table, as a Vector3. 
      • local position = vector3(position.x, position.y, position.z)

Sprinkler Valve Change​

Fired when a Sprinkler Valve is Opened or Closed.

Event Name​

Inferno-Collection:Server:FireAlarmReborn:Editable:SprinklerValveChanged

Parameters​

  • source - string
    • Server handle of the player who opened changed the Sprinkler Valve.
  • alarmSystem - AlarmSystem
    • Alarm System that has been triggered.
  • sprinklerValve - SprinklerValve
    • Sprinkler Valve that was changed.