QueryHost
Esc

Documentation menu

API reference · interfaces

Interface: KillingFloor2Data

Generated from the QueryHost package public TypeScript contract.

Killing Floor 2 data collected from its Steam A2S query port.

Extends

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


currentWave?

readonly optional currentWave?: number

Wave the match is on; waves are counted from 1.


custom?

readonly optional custom?: boolean

Whether the server is custom (unranked) rather than ranked.


difficulty?

readonly optional difficulty?: "normal" | "hard" | "suicidal" | "hell-on-earth"


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 name from the Mode rule, such as Survival.


gamePort?

readonly optional gamePort?: number

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

Inherited from

SteamA2sData.gamePort


inProgress?

readonly optional inProgress?: boolean


mutators?

readonly optional mutators?: boolean

Whether the server runs mutators.


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


spectators?

readonly optional spectators?: number


tags?

readonly optional tags?: readonly string[]

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

Inherited from

SteamA2sData.tags


totalWaves?

readonly optional totalWaves?: number

Waves in the match's game length, from the NumWaves rule.


vac

readonly vac: boolean

Inherited from

SteamA2sData.vac