Skip to content
San Andreas Online Docs

getNeonClientSetting

Client-side
SA:O APISan Andreas Online client visuals

Reads one allowlisted effective San Andreas Online radar or SkyGFX setting.

Syntax

bool|number|string getNeonClientSetting(string name)

Arguments

namestring

Allowlisted radar.* or skygfx.* setting name.

Returns

The effective boolean, number, or string value; false for an unknown setting.

Ownership and lifecycle

Visual overrides belong to the calling client resource, stack by resource ownership, never replace the player's saved preferences, and are removed automatically when the resource stops.

Important behavior
  • Readable settings include radar style/position/size and SkyGFX status/effect fields.

Where this comes from

SOURCECLuaClientDefs.cppClient/mods/deathmatch/logic/luadefs/CLuaClientDefs.cpp INTRODUCED / EXTENDEDfb8ee02c4Read the commit and why the change was made
RELATED SA:O APIS

Continue exploring

Read the system guide →
setNeonClientSetting Applies a resource-owned session override for an allowlisted San Andreas Online radar or SkyGFX setting. resetNeonClientSettings Clears every San Andreas Online visual override owned by the calling resource. engineSetRadarMapTile Registers or replaces a resource-owned TXD in one cell of San Andreas Online's sparse 40 × 40 native radar grid.

← Back to the SA:O Lua API · How San Andreas Online client visuals works →