Interface: GarrysModData

Garry's Mod data collected from its game-port A2S endpoint. Its keywords are space-separated key:value pairs, so tags splits on spaces as well as commas.

Extends

• SteamA2sData

Properties

appId?

readonly optional appId?: number

Steam App ID for modern Source-style Info responses. It comes from the 64-bit game ID when the server sends one, because the base Info field is 16 bits and truncates larger IDs.

Inherited from

SteamA2sData.appId

bots

readonly bots: number

Inherited from

SteamA2sData.bots

build?

readonly optional build?: string

Game build date as YYMMDD, from the ver keyword.

environment

readonly environment: "linux" | "macos" | "windows"

Inherited from

SteamA2sData.environment

folder

readonly folder: string

Game content directory, such as tf or garrysmod, which also identifies Source mods.

Inherited from

SteamA2sData.folder

game

readonly game: string

Game description advertised by the server, such as a mode, mission, or product name.

Inherited from

SteamA2sData.game

gamemode?

readonly optional gamemode?: string

Active gamemode folder name, such as sandbox or darkrp, from the gm keyword.

gamemodeCategory?

readonly optional gamemodeCategory?: string

Server-browser category, such as rp or pvp, from the gmc keyword.

gamemodeWorkshopId?

readonly optional gamemodeWorkshopId?: string

Steam Workshop item ID of the gamemode, from the gmws keyword.

gamePort?

readonly optional gamePort?: number

Game port the server advertises, which may differ from the queried Steam port.

Inherited from

SteamA2sData.gamePort

location?

readonly optional location?: string

Operator-set location code from the loc keyword (sv_location).

players?

readonly optional players?: readonly SteamA2sPlayer[]

Omitted when Player is skipped or unavailable; empty means the server confirmed no players.

Inherited from

SteamA2sData.players

serverSteamId?

readonly optional serverSteamId?: string

Server's 64-bit Steam ID as decimal text, when advertised.

Inherited from

SteamA2sData.serverSteamId

serverType

readonly serverType: "dedicated" | "listen" | "proxy"

Inherited from

SteamA2sData.serverType

sourceTv?

readonly optional sourceTv?: SourceTvEndpoint

SourceTV relay advertised by the server; never followed as a query destination.

Inherited from

SteamA2sData.sourceTv

tags?

readonly optional tags?: readonly string[]

Comma-delimited A2S Info keywords split in server order, when present.

Inherited from

SteamA2sData.tags

vac

readonly vac: boolean

Inherited from

SteamA2sData.vac