These interfaces are used when creating game objects.
For more info on TypeScript syntax, see https://www.typescriptlang.org/docs/
Updated @ Oct 16, 2026
Object
export interface IGameObjectConfig
{
options?: Matter.IChamferableBodyDefinition,
type?: GameObjectType | EditorObjectType | string,
position?: Matter.Vector,
positionOffset?: Matter.Vector,
width?: number,
height?: number,
team?: number,
loot?: IGameLoot,
material?: Material,
destroyTime?: number,
angle?: number,
items?: IGameObjectConfig[],
bHidden?: boolean,
gameModeIds?: string[],
reward?: number,
health?: number,
velocity?: Matter.Vector,
angularVelocity?: number,
buoyancy?: number,
bulletPenetrationFactor?: number;
damageModifiers?: {
[key in DamageType]?: number
},
damageMultiplier?: number,
gravityScale?: number,
bDisabled?: boolean,
bSurvivalEnemy?: boolean,
[key: string]: any | undefined
}
Pawn
export interface IGamePawnConfig extends IGameObjectConfig
{
bBot?: boolean,
botSkill?: BotSkill,
enemyConfig?: IFindEnemyConfig,
bRequireLOS?: boolean,
icon?: string,
iconColor?: number,
iconAnimation?: HUDIndicatorAnimation,
bHideHealthBar?: boolean,
name?: string,
nameFontSize?: number,
bExplore?: boolean,
headshotMaterial?: Material,
headshotDamageMultiplier?: number,
bRegenHealth?: boolean,
bHoldPosition?: boolean,
patrol?: Matter.Vector[],
destination?: Matter.Vector
}
/**
* Bot move types in order of priority.
*/
export enum BotMoveType
{
Explore = 1,
Move,
Investigate,
Enemy,
Patrol,
Objective,
CampZone,
Interactable,
PriorityObjective,
Command,
Cover
}
export interface IBotAI
{
bDisabled?: boolean,
botSkill: BotSkill,
aimSpeed: number,
aimOffsetThreshold?: number,
minimumAimOffsetDistance?: number,
aimOffset?: Matter.Vector,
ticker: number,
randomizer?: number,
fireBurstTimer: number,
fireBurstTimerMax: number,
fireCooldownTimer: number,
fireCooldownTimerMax: number,
semiCooldownTimer: number,
semiCooldownTimerMax: number,
bFireCooldown: boolean,
bHasEnemyLOS?: boolean,
bHasNodeLOS?: boolean,
enemy?: GameObject | GamePawn,
enemyDistance?: number,
initialMoveTarget?: Matter.Vector,
moveTo?: Matter.Vector,
destinationDistanceThreshold?: number,
path?: Node[],
moveType?: BotMoveType,
bNeedsCover?: boolean,
coverTimer?: number,
bNeedsNewPath?: boolean,
cover?: GameObject,
bDisableInteraction?: boolean,
bDisableCover?: boolean,
bDisableSliding?: boolean,
bEnableCamping?: boolean,
enemyConfig: IFindEnemyConfig,
pathCooldownTimer?: number,
followTarget?: GameObject,
followOffset?: Matter.Vector,
followDistanceMax?: number,
bHoldPosition?: boolean,
bIgnoreCommands?: boolean,
bIgnoreVehicles?: boolean,
bIgnoreDroppedWeapons?: boolean,
bDisableCommands?: boolean,
bDisableCrouch?: boolean,
bDisableSprint?: boolean,
interactionTarget?: GameObject,
bUseSimplePathfinding?: boolean,
activeCommand?: PlayerCommand,
bCanInvestigate?: boolean,
/**
* Time of when the last investigation started.
*/
startInvestigateTime?: number,
patrol?: {
currentIndex?: number,
points?: Matter.Vector[]
},
bExplore?: boolean
}
Character
export interface IGameCharacterConfig extends IGamePawnConfig
{
bUnlimitedAmmo?: boolean,
presetId?: CharacterPresetID,
avatar?: ICharacterAppearance,
inventory?: IWeaponItem[],
grenade?: IWeaponItem,
equipment?: IWeaponItem,
melee?: IWeaponItem,
bDisableParachute?: boolean,
bDisableInteraction?: boolean,
bDisableCover?: boolean,
bCanInvestigate?: boolean,
bHostage?: boolean,
speedMultiplier?: number,
swimSpeedMultiplier?: number,
zombieType?: ZombieType,
bRegenHealth?: boolean,
bSuicideBomber?: boolean,
bDisableSpawnProtection?: boolean,
perks?: (PlayerPerkID | WeaponPerkID)[],
bDisableDroppedWeapons?: boolean,
bJuggernaut?: boolean,
bIgnoreCommands?: boolean,
followId?: string
}
Infestor
export interface IGameInfestorConfig extends IGamePawnConfig
{
infestorType?: InfestorType
}
export enum InfestorType
{
Normal = "infestor",
King = "infestor_king",
Ranged = "infestor_ranged"
}
Vehicle
export interface IGameVehicleConfig extends IGamePawnConfig
{
vehicleType?: VehicleType,
bBot?: boolean,
seats?: IVehicleSeat[],
instigatorId?: string,
bRemoveWeapons?: boolean,
maxAutomatedRange?: number,
bUnlimitedAmmo?: boolean
itemConfig?: IWeaponConfig,
bUseSimplePathfinding?: boolean,
fuel?: number,
maxFuel?: number
}
export interface IVehicleSeat
{
pawnId?: string,
position: Matter.Vector,
bShowHands?: boolean,
legFrame?: CharacterLegFrame,
bAllowPlayerInput?: boolean,
bSingleHanded?: boolean,
bLayerPawnFront?: boolean,
bLayerWeaponBack?: boolean,
bHideOccupant?: boolean,
weapons?: IVehicleSeatWeapon[]
}
export interface IVehicleSeatWeapon
{
weaponPosition?: Matter.Vector,
weaponFirePosition?: Matter.Vector,
aimAngle?: number,
aimLimits?: { min?: number, max?: number },
item?: IWeaponItem,
weapon?: IWeaponComponent,
bHidden?: boolean,
bTurret?: boolean
}
export enum VehicleType
{
Quad = "quad",
Growler = "growler",
MRAP = "mrap",
LAV25 = "lav25",
MH6 = "mh6",
Cobra = "cobra",
Kiowa = "kiowa",
Blackhawk = "blackhawk",
Osprey = "osprey",
Pavelow = "pavelow",
Abrams = "abrams",
T90 = "t90",
RCXD = "rcxd",
UGV = "ugv",
Reaper = "reaper",
Dragonfire = "dragonfire",
Drone = "drone",
Harrier = "harrier",
QuadRunner = "quadrunner"
}
Animal
export interface IGameAnimalConfig extends IGamePawnConfig
{
animalType?: AnimalType
}
export enum AnimalType
{
Chicken = "chicken"
}
Interactables
export interface IInteractableGameObjectConfig extends IGameObjectConfig
{
interactTeam?: number,
bLimitInteractions?: boolean,
uses?: number,
maxUses?: number,
interactTime?: number
}
Trigger Conditions
/**
* Game trigger.
*/
export interface IGameTrigger
{
id: string;
event: IGameServerEvent;
actions: IGameTriggerAction[];
conditions?: IGameTriggerCondition[];
bDisabled?: boolean;
numExecutions?: number;
bIsExecuting?: boolean;
}
/**
* Trigger action.
*/
export interface IGameTriggerAction
{
gameEvent: IGameServerEvent;
delay?: number;
[key: string]: any
}
/**
* Trigger condition.
*/
export interface IGameTriggerCondition
{
target: string;
value: any;
operator: GameTriggerConditionOperator,
modulusValue?: number
}
/**
* Trigger condition operator.
*/
export enum GameTriggerConditionOperator
{
Equals = "==",
StrictEquals = "===",
LessThan = "<",
LessThanOrEqual = "<=",
GreaterThan = ">",
GreaterThanOrEqual = ">=",
Modulus = "%",
Or = "||",
And = "&&",
NotEqual = "!="
}
