Data Structures

This page documents the data structures in FAR.

---

Alarm System

alarmSystem.id
alarmSystem.name
alarmSystem.status
alarmSystem.lastStatusChange
alarmSystem.passcode
alarmSystem.location
alarmSystem.monitoring
alarmSystem.postalCode
alarmSystem.position.x
alarmSystem.position.y
alarmSystem.position.z

id

int

ID of the Alarm System.

Example: 1

name

string

Name of the Alarm System.

Example: Mission Row Police Station

status

enum

Status of the Alarm System as an enum.

Values:

• 0 - Invalid status
• 1 - Entire system disabled
• 2 - System ready / standby
• 3 - Announcement in progress
• 4 - WalkTest in progress
• 5 - System has isolations
• 6 - System in Alarm
• 7 - System silenced
• 8 - System test in progress

Example: 2

lastStatusChange

date

The last time the Alarm System's status was changed.

Example: 2024-12-23T04:14:33.7711836Z

passcode

string

Passcode for Control Panels in this Alarm System.

Example: 1234

location

string

Human readable location of this Alarm System.

Example: Altee St, Mission Row

monitoring

bool

A boolean indicating if Monitoring for this Alarm System is active or inactive.

Example: true

postalCode

string | null

Postal Code this Alarm System is located within.

Example: 123

position

table

World coordinates of the center of this Alarm System.

Example:

local position = vector3(alarmSystem.position.x, alarmSystem.position.y, alarmSystem.position.z)

---

Alarm System Components

alarmSystemComponents.id
alarmSystemComponents.controlPanels
alarmSystemComponents.pullStations
alarmSystemComponents.detectors
alarmSystemComponents.sprinklers

id

int

ID of the Alarm System.

Example: 1

controlPanels

ControlPanel[]

Table containing data for all the Control Panels in this Alarm System.

pullStations

PullStation[]

Table containing data for all the Pull Stations in this Alarm System.

detectors

Detector[]

Table containing data for all the Detectors in this Alarm System.

sounders

Sounders[]

Table containing data for all the Sounders in this Alarm System.

sprinklers

Sprinkler[]

Table containing data for all the Sprinklers in this Alarm System.

---

Pull Station

pullStation.id
pullStation.name
pullStation.position.x
pullStation.position.y
pullStation.position.z
pullStation.rotation.x
pullStation.rotation.y
pullStation.rotation.z
pullStation.isVirtual
pullStation.modelName

id

int

ID of the Pull Station.

Example: 1

name

int

Name of the Pull Station.

Example: Near Front Doors

position

table

World coordinates of the Pull Station in a table.

Example:

local position = vector3(pullStation.position.x, pullStation.position.y, pullStation.position.z)

rotation

table

Rotation of the Pull Station in a table.

Example:

local rotation = vector3(pullStation.rotation.x, pullStation.rotation.y, pullStation.rotation.z)

isVirtual

bool

If the Pull Station is virtual.

Example: false

modelName

string

Name of the model this Pull Station uses.

Example: ic_prop_pull_station

---

Control Panel

controlPanel.id
controlPanel.name
controlPanel.position.x
controlPanel.position.y
controlPanel.position.z
controlPanel.rotation.x
controlPanel.rotation.y
controlPanel.rotation.z
controlPanel.isVirtual
controlPanel.modelName

id

int

ID of the Control Panel.

Example: 1

name

string

Name of the Control Panel.

Example: Entry Hallway

position

table

World coordinates of the Control Panel in a table.

Example:

local position = vector3(controlPanel.position.x, controlPanel.position.y, controlPanel.position.z)

rotation

table

Rotation of the Control Panel in a table.

Example:

local rotation = vector3(controlPanel.rotation.x, controlPanel.rotation.y, controlPanel.rotation.z)

isVirtual

bool

If the Control Panel is virtual.

Example: false

modelName

string

Name of the model this Control Panel uses.

Example: ic_prop_fire_panel

---

Sounder

sounder.id
sounder.position.x
sounder.position.y
sounder.position.z
sounder.rotation.x
sounder.rotation.y
sounder.rotation.z
sounder.isVirtual

id

int

ID of the Sounder.

Example: 1

position

table

World coordinates of the Sounder in a table.

Example:

local position = vector3(sounder.position.x, sounder.position.y, sounder.position.z)

rotation

table

Rotation of the Sounder in a table.

Example:

local rotation = vector3(sounder.rotation.x, sounder.rotation.y, sounder.rotation.z)

isVirtual

bool

If the Sounder is virtual.

Example: false

---

Sprinkler

sprinkler.id
sprinkler.position.x
sprinkler.position.y
sprinkler.position.z
sprinkler.rotation.x
sprinkler.rotation.y
sprinkler.rotation.z
sprinkler.isVirtual

id

int

ID of the Sprinkler.

Example: 1

position

table

World coordinates of the Sprinkler in a table.

Example:

local position = vector3(sprinkler.position.x, sprinkler.position.y, sprinkler.position.z)

rotation

table

Rotation of the Sprinkler in a table.

Example:

local rotation = vector3(sprinkler.rotation.x, sprinkler.rotation.y, sprinkler.rotation.z)

isVirtual

bool

If the Sprinkler is virtual.

Example: false

Detector

detector.id
detector.position.x
detector.position.y
detector.position.z
detector.rotation.x
detector.rotation.y
detector.rotation.z
detector.isVirtual

id

int

ID of the Detector.

Example: 1

position

table

World coordinates of the Detector in a table.

Example:

local position = vector3(detector.position.x, detector.position.y, detector.position.z)

rotation

table

Rotation of the Detector in a table.

Example:

local rotation = vector3(detector.rotation.x, detector.rotation.y, detector.rotation.z)

isVirtual

bool

If the Detector is virtual.

Example: false

Sprinkler Valve

sprinklerValve.status
sprinklerValve.position.x
sprinklerValve.position.y
sprinklerValve.position.z
sprinklerValve.rotation.x
sprinklerValve.rotation.y
sprinklerValve.rotation.z
sprinklerValve.isVirtual

status

enum

Status of the Sprinkler Valve as an enum.

Values:

• 0 - Invalid status
• 1 - Open
• 2 - Closed

Example: 1

position

table

World coordinates of the Sprinkler Valve in a table.

Example:

local position = vector3(sprinklerValve.position.x, sprinklerValve.position.y, sprinklerValve.position.z)

rotation

table

Rotation of the Sprinkler Valve in a table.

Example:

local rotation = vector3(sprinklerValve.rotation.x, sprinklerValve.rotation.y, sprinklerValve.rotation.z)

isVirtual

bool

If the Sprinkler Valve is virtual.

Example: false