Skip to main content

Server Exports

This page documents the server exports that can be used with SA.

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

All the exports listed below are server exports, not client exports.

info

All the exports on this page required Station Alert, and do not work for Sonoran Edition.
For more info, see here.

Locations​

Get All Locations​

Use this export to get all Station Locations.

Export Name​

getAllLocations

Parameters​

None

Example​

local value = exports["inferno-station-alert"]:getAllLocations()

Return Value​

Location[]

Get Nearest Location To Position​

Use this export to get the nearest Station Location to a given position within a radius.

Export Name​

getNearestLocationToPosition

Parameters​

  • position - vector3
    • Position to use to search for nearest Station Location.
  • radius
    • Search radius in meters. -1 for no radius.

Example​

local value = exports["inferno-station-alert"]:getNearestLocationToPosition(vec3(1, 1, 1))

Return Value​

Location | null

Get Nearest Location With Players To Position​

Use this export to get the nearest Station Location to a given position only if it has players nearby.

Export Name​

getNearestLocationWithPlayersToPosition

Parameters​

  • position - vector3
    • Position to use to search for nearest Station Location.

Example​

local value = exports["inferno-station-alert"]:getNearestLocationWithPlayersToPosition(vec3(1, 1, 1))

Return Value​

Location | null

Alerts​

Create New Alert​

Use this export to create a new Alert.

Export Name​

newAlert

Parameters​

  • alert - table
    • locations - table
      • Location - object
        • Location Name - string
        • Door Names - table
          • Door Name - string
        • If empty table provided, all doors will open.
    • message - string
      • Optional Text-to-Speech message.
      • Requires Voice Turnout Addon, see here for details.
    • unitColors - table
      • Color Name - string
      • Optionally provide unit indicator colors, or no colors show.
    • tone - string
      • Optionally provide a specific tone to use, or default tone is used.

Example​

local success = exports["inferno-station-alert"]:newAlert({
    ["message"] = "Some message.",
    ["locations"] = {
        ["Davis"] = {"Bay One", "Bay Three"},
    },
    ["unitColors"] = {"blue", "red"},
    ["tone"] = "Tone 1"
})

Return Value​

bool

Create New Alert At Nearest Station​

Use this export to create a new Alert at the Station Location nearest to the provided position within a radius.

Export Name​

newAlertNearestStation

Parameters​

  • position - vector3
    • Position to use to search for nearest Station Location.
  • radius
    • Search radius in meters. -1 for no radius.
  • alert - table
    • message - string
      • Optional Text-to-Speech message.
      • Requires Voice Turnout Addon, see here for details.
    • unitColors - table
      • Color Name - string
      • Optionally provide unit indicator colors, or no colors show.
    • tone - string
      • Optionally provide a specific tone to use, or default tone is used.

Example​

local success = exports["inferno-station-alert"]:newAlertNearestStation(vec3(1, 1, 1), 300, {
    ["message"] = "Some message.",
    ["unitColors"] = {"blue", "red"},
    ["tone"] = "Tone 1"
})

Return Value​

bool

Create New Alert At Nearest Station With Players​

Use this export to create a new Alert at the Station Location nearest to the provided position only if it has players nearby.

Export Name​

newAlertNearestStationWithPlayers

Parameters​

  • position - vector3
    • Position to use to search for nearest Station Location.
  • alert - table
    • message - string
      • Optional Text-to-Speech message.
      • Requires Voice Turnout Addon, see here for details.
    • unitColors - table
      • Color Name - string
      • Optionally provide unit indicator colors, or no colors show.
    • tone - string
      • Optionally provide a specific tone to use, or default tone is used.

Example​

local success = exports["inferno-station-alert"]:newAlertNearestStationWithPlayers(vec3(1, 1, 1), {
    ["message"] = "Some message.",
    ["unitColors"] = {"blue", "red"},
    ["tone"] = "Tone 1"
})

Return Value​

bool