Five On It

Appearance

five-on-it / packages/protocol/src/messages / parseDebugCommand

Function: parseDebugCommand() ​

parseDebugCommand(text): { ahead?: number; carClass?: number; climate?: "none" | "temperate" | "meadow" | "forest" | "alpine" | "farmland" | "steppe" | "desert" | "autumn" | "coast"; cmd: "police" | "clock" | "invincible" | "maxHealth" | "weather" | "spawnChaser" | "clearChasers" | "teleport" | "wanted" | "pedestrian" | "carHealth" | "rtcDrop" | "fit" | "ignite"; crew?: number; health?: number; heat?: number; hours?: number; intensity?: number; kind?: "clear" | "overcast" | "rain" | "storm" | "fog" | "snow"; minutes?: number; mode?: "foot" | "car"; mods?: ("runFlats" | "caltrops" | "oil" | "bullBar" | "plating" | "nitro")[]; night?: boolean; on?: boolean; pace?: number; profile?: string; road?: string; stars?: number; tune?: Record<string, number | boolean>; type: "debug"; unit?: "boat" | "apc" | "dart" | "grappler" | "helicopter" | "sniper" | "cannon" | "bike"; } | undefined

Defined in: packages/protocol/src/messages.ts:526

Parses a text frame as a debug command; undefined when it is not one.

Parameters ​

text ​

string

Returns ​

Type Literal ​

{ ahead?: number; carClass?: number; climate?: "none" | "temperate" | "meadow" | "forest" | "alpine" | "farmland" | "steppe" | "desert" | "autumn" | "coast"; cmd: "police" | "clock" | "invincible" | "maxHealth" | "weather" | "spawnChaser" | "clearChasers" | "teleport" | "wanted" | "pedestrian" | "carHealth" | "rtcDrop" | "fit" | "ignite"; crew?: number; health?: number; heat?: number; hours?: number; intensity?: number; kind?: "clear" | "overcast" | "rain" | "storm" | "fog" | "snow"; minutes?: number; mode?: "foot" | "car"; mods?: ("runFlats" | "caltrops" | "oil" | "bullBar" | "plating" | "nitro")[]; night?: boolean; on?: boolean; pace?: number; profile?: string; road?: string; stars?: number; tune?: Record<string, number | boolean>; type: "debug"; unit?: "boat" | "apc" | "dart" | "grappler" | "helicopter" | "sniper" | "cannon" | "bike"; }

ahead? ​

optional ahead?: number

carClass? ​

optional carClass?: number

climate? ​

optional climate?: "none" | "temperate" | "meadow" | "forest" | "alpine" | "farmland" | "steppe" | "desert" | "autumn" | "coast"

cmd ​

cmd: "police" | "clock" | "invincible" | "maxHealth" | "weather" | "spawnChaser" | "clearChasers" | "teleport" | "wanted" | "pedestrian" | "carHealth" | "rtcDrop" | "fit" | "ignite"

crew? ​

optional crew?: number

health? ​

optional health?: number

heat? ​

optional heat?: number

hours? ​

optional hours?: number

intensity? ​

optional intensity?: number

kind? ​

optional kind?: "clear" | "overcast" | "rain" | "storm" | "fog" | "snow"

minutes? ​

optional minutes?: number

mode? ​

optional mode?: "foot" | "car"

mods? ​

optional mods?: ("runFlats" | "caltrops" | "oil" | "bullBar" | "plating" | "nitro")[]

fit: the upgrades fitted to the player's car (the simulation's MOD_SHOP ids).

night? ​

optional night?: boolean

on? ​

optional on?: boolean

pace? ​

optional pace?: number

profile? ​

optional profile?: string

road? ​

optional road?: string

stars? ​

optional stars?: number

tune? ​

optional tune?: Record<string, number | boolean>

type ​

type: "debug"

unit? ​

optional unit?: "boat" | "apc" | "dart" | "grappler" | "helicopter" | "sniper" | "cannon" | "bike"

police: a unit of the heavy response sent after the player now (@foi/ai's HEAVY_UNITS), at stars first when given; on, alone (the police send them nothing else).

undefined