GSC reference › Built-in
CodeGetPlayerStateClientField()
Built-in (engine)
Server
Gets the value for a given player state client field.
Signature
CodeGetPlayerStateClientField(<player>, <name>)
Parameters
| Name | Required? | Details |
|---|---|---|
| player | Required | A player |
| name | Required | Unique name to identify the field. |
Example (from Treyarch's docs)
val = CodeGetPlayerStateClientField(ent, "my_field")
Real uses in BO3's scripts
Called 2 times in the decompiled scripts. A few, zombies first:
- scripts/shared/clientfield_shared.csc, line 47
return codegetplayerstateclientfield(self, field_name); - scripts/shared/clientfield_shared.gsc, line 183
return codegetplayerstateclientfield(self, field_name);
Related built-ins
- CodeIncrementPlayerStateClientField()Increments the value for a given player state client field.
- CodeSetPlayerStateClientField()Sets the value for a given player state client field.
- CodeGetUIModelClientField()Gets the value for a given player uimodel client field.
- GetServerHighestClientFieldVersion()Returns the server's highest clientfield version.
- CodeGetClientField()Gets the value for a given client field.
- CodeGetWorldClientField()Gets the value for a given client field.
- GetClientFieldVersion()Returns the version of the specifiec client field, in the specified client field set - or 0 if the field isn't registered.
- GetPlayerMovementState()Returns the player movement state for the match record.
- GetPlayers()Returns an array of the currently connected players.
- GetLocalPlayer()Get the local player predicted centity.
- GetPlayerAngles()Get the player view angles
- GetLocalPlayers()Get an array of all the local players
New to GSC?
Start with the basics, or paste a compile error to get the fix.
Built-in descriptions, parameters and examples come from Treyarch's BO3 mod tools docs. Usage links point at shiversoftdev/t7-source (decompiled BO3 scripts).