Class: game_PlayerState

Multiplayer player state replicated by multiplayer game modes.

Source

C++ class game_PlayerState

Custom Constructor

game_PlayerState

Remarks

This is the networked player state used by multiplayer server/client code. The public fields are the exact names exported by the Lua binding, which do not always match the underlying C++ member names.

Constructors

Constructor

new game_PlayerState(): game_PlayerState;

Create an empty player state.

Returns

game_PlayerState

Methods

clear()

clear(): void;

Reset this state to default values.

Returns

void

---

getName()

getName(): string;

Returns

string

Current multiplayer player name.

---

net_Export()

net_Export(packet: net_packet, full?: boolean): void;

Write this state to a network packet.

Parameters

Parameter	Type	Description
packet	net_packet	Target network packet.
full?	boolean	Whether to include account data in the packet.

Returns

void

---

net_Import()

net_Import(packet: net_packet): void;

Read this state from a network packet.

Parameters

Parameter	Type	Description
packet	net_packet	Source network packet.

Returns

void

---

resetFlag()

resetFlag(flag: number): void;

Clear a player flag bit.

Parameters

Parameter	Type	Description
flag	number	GAME_PLAYER_FLAG_* bit to clear.

Returns

void

---

setFlag()

setFlag(flag: number): void;

Set a player flag bit.

Parameters

Parameter	Type	Description
flag	number	GAME_PLAYER_FLAG_* bit to set.

Returns

void

---

setName()

setName(name: string): void;

Set multiplayer player name.

Parameters

Parameter	Type	Description
name	string	New player name.

Returns

void

---

testFlag()

testFlag(flag: number): boolean;

Check whether a player flag bit is set.

Parameters

Parameter	Type	Description
flag	number	GAME_PLAYER_FLAG_* bit to test.

Returns

boolean

Whether the bit is set.

Properties

deaths

deaths: number;

Death count.

---

flags

flags: number;

Packed GAME_PLAYER_FLAG_* bitmask.

---

GameID

GameID: number;

Current player game id.

---

kills

kills: number;

Rival kill count.

---

LastBuyAcount

LastBuyAcount: number;

Money difference from the last buy transaction.

---

lasthitter

lasthitter: number;

Object id of the last hitter.

---

lasthitweapon

lasthitweapon: number;

Weapon id used by the last hitter.

---

money_delta

money_delta: number;

Last money delta shown to the player.

---

money_for_round

money_for_round: number;

Current multiplayer money amount.

---

ping

ping: number;

Player network ping.

---

pItemList

pItemList: game_player_item_list;

Native item id vector containing selected buy/spawn item ids.

---

RespawnTime

RespawnTime: number;

Scheduled respawn time.

---

skin

skin: number;

Multiplayer skin id.

---

team

team: number;

Player team id.