GSC reference › Built-in
ClientSysSetState()
Built-in (engine)
Server
Sets the state of a pre registered client system for all clients. The state will be communicated to the client script system.
Signature
ClientSysSetState(<id>, <state>)
Parameters
| Name | Required? | Details |
|---|---|---|
| id | Required | The integer id of the client system. Returned from call to ClientSysRegister. |
| state | Required | Arbitrary string state. Will be sent to the client script system. |
Example (from Treyarch's docs)
ClientSysSetState(level._ClientSys["FakeFire"], "Event1Phase1")
Real uses in BO3's scripts
Called 2 times in the decompiled scripts. A few, zombies first:
- scripts/shared/util_shared.gsc, line 1686
player clientsyssetstate(level._clientsys[ssysname].sysid, ssysstate); - scripts/shared/util_shared.gsc, line 1690
clientsyssetstate(level._clientsys[ssysname].sysid, ssysstate);
Related built-ins
- SetZBarrierPieceState()Set's the state of the piece indexed in the zbarrier ent.
- SetLoopState()Set pitch and volume per entity/alias
- SetCorpseGibState()Sets the gib state for the body rendering.
- SetLightingState()Changes lighting state for the map
- SoundSetMusicState()Set the music state for the sound
- SetElectrifiedState()Sets the player into the electrified state for 3rd person anim purposes.
- SetPlayerStateLoadoutWeapons()Set the player state to have primary and secondary weapon info, for codcaster to view it
- CodeSetPlayerStateClientField()Sets the value for a given player state client field.
- SetPlayerStateLoadoutBonusCards()Set the player state to have bonus card info, for codcaster to view it
- SetDvar()Sets the value of a dvar.
- SetModel()Set the model for the entity
- SetHintString()Set the hint string for the entity
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).