GSC reference › Built-in
CodeGetClientField()
Built-in (engine)
Server
Gets the value for a given client field.
Signature
CodeGetClientField(<entity>, <name>)
Parameters
| Name | Required? | Details |
|---|---|---|
| entity | Required | The entity to search the name in |
| name | Required | Unique name to identify the field. |
Example (from Treyarch's docs)
val = CodeGetClientField(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 33
return codegetclientfield(self, field_name); - scripts/shared/clientfield_shared.gsc, line 169
return codegetclientfield(self, str_field_name);
Related built-ins
- CodeGetUIModelClientField()Gets the value for a given player uimodel client field.
- GetServerHighestClientFieldVersion()Returns the server's highest clientfield version.
- CodeGetPlayerStateClientField()Gets the value for a given player state 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.
- RegisterClientField()Register a client field.
- GetLocalClientNumber()Returns the local client number.
- CodeSetClientField()Sets the value for a given client field.
- GetClientTime()Gets the current client time in milliseconds
- GetCharacterFields()Returns info for the character pose playerbodytype
- GetMaxLocalClients()Get the max number of local clients
- setupclientfieldcodecallbacks()Registers a LUI code callback for each of the given clientfield names in a field pool.
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).