QueryHost
Esc

Documentation menu

API reference · interfaces

Interface: ArkSurvivalEvolvedData

Generated from the QueryHost package public TypeScript contract.

ARK: Survival Evolved data collected from its Steam A2S query port.

Extends

Properties

allowDownloadCharacters?

readonly optional allowDownloadCharacters?: boolean


allowDownloadItems?

readonly optional allowDownloadItems?: boolean


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


battlEye?

readonly optional battlEye?: boolean


bots

readonly bots: number

Inherited from

SteamA2sData.bots


buildId?

readonly optional buildId?: number

Build compatibility ID from BUILDID; clients must match it to join.

Inherited from

UnrealSessionData.buildId


clusterId?

readonly optional clusterId?: string

Cluster that shares character and item transfers between servers.


customServerName?

readonly optional customServerName?: string

Untruncated server name from CUSTOMSERVERNAME_s; ARK sends it lowercased.


dayTime?

readonly optional dayTime?: string

In-game time or day count exactly as advertised; its format changed between builds.


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

Game mode class, such as TestGameMode_C or a total-conversion mod's mode.


gamePort?

readonly optional gamePort?: number

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

Inherited from

SteamA2sData.gamePort


mods?

readonly optional mods?: readonly ArkSurvivalEvolvedMod[]

Omitted when Rules are unavailable; empty means the server confirmed no active mods.


official?

readonly optional official?: boolean

Whether Studio Wildcard runs the server.


openPublicSlots?

readonly optional openPublicSlots?: number

Open public connection slots from NUMOPENPUBCONN.

Inherited from

UnrealSessionData.openPublicSlots


players?

readonly optional players?: readonly SteamA2sPlayer[]

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

Inherited from

SteamA2sData.players


pve?

readonly optional pve?: boolean


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


sessionFlags?

readonly optional sessionFlags?: UnrealSessionFlags

Inherited from

UnrealSessionData.sessionFlags


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