Player

Summary

Properties

Name Type
name string
id int
onlineId int
teamId TeamId
squadId SquadId
inVehicle bool
soldier SoldierEntity | nil
corpse SoldierEntity | nil
attachedControllable ControllableEntity | nil
controlledControllable ControllableEntity | nil
isSquadLeader bool
alive bool
kills int
deaths int
time float
score int
input EntryInput | nil
controlledEntryId int
customization DataContainer | nil
selectedUnlocks DataContainer{}
ping int
isSquadPrivate bool
isAllowedToSpawnOn bool

Methods

Method Returns
EnableInput(action: EntryInputActionEnum, enable: bool) void

Operators

Operator Rhs Returns
== Player bool

Properties

name

string

id

int

onlineId

int

teamId

TeamId

squadId

SquadId

inVehicle

bool

soldier

SoldierEntity | nil

corpse

SoldierEntity | nil

attachedControllable

ControllableEntity | nil

controlledControllable

ControllableEntity | nil

isSquadLeader

bool

alive

bool

kills

int

deaths

int

time

float

score

int

input

EntryInput | nil

controlledEntryId

int

customization

DataContainer | nil

The CharacterCustomizationAsset currently applied to this player's soldier.

selectedUnlocks

DataContainer{}

A table of specializations (UnlockAssetBase) this player currently has equipped.

ping

int

The players ping to the server.

isSquadPrivate

bool

Always false for non squad leaders.

isAllowedToSpawnOn

bool

Describes if the local player is allowed to spawn on this other player.

Methods

EnableInput

EnableInput(action: EntryInputActionEnum, enable: bool)

Parameters

Name Type Description
action EntryInputActionEnum
enable bool

Operators

operator==

operator==(rhs: Player): bool

Parameters

Name Type Description
rhs Player

Returns

Type Description
bool