GSC reference › Built-in
SetControllerUIModelValue()
Built-in (engine)
Server
Player Called on: player
Sets a data value for a given lui menu, the data name has to be precached and the value as well, if its a string.
Signature
<player> SetControllerUIModelValue(<ui model data path from controller>, <ui model value>)
Called on an entity: player SetControllerUIModelValue(...)
Parameters
| Name | Required? | Details |
|---|---|---|
| ui model data path from controller | Required | precached name string for the data which we're trying to set. |
| ui model value | Required | value for the data which we're trying to set on the controller. |
Example (from Treyarch's docs)
player SetControllerUIModelValue( "hudItems.regenDelayProgress", 0.2 )
Real uses in BO3's scripts
Called 24 times in the decompiled scripts. A few, zombies first:
- scripts/shared/weapons/_weaponobjects.gsc, line 440
self setcontrolleruimodelvalue("spikeLauncherCounter.spikesReady", currentitemcount); - scripts/mp/_armor.gsc, line 28
self setcontrolleruimodelvalue("hudItems.armorPercent", lightarmorpercent); - scripts/cp/_hazard.gsc, line 136
self setcontrolleruimodelvalue("hudItems.hess1.type", 0); - scripts/cp/_laststand.gsc, line 1707
self setcontrolleruimodelvalue("hudItems.regenDelayProgress", 1); - scripts/cp/cybercom/_cybercom_gadget.gsc, line 445
self setcontrolleruimodelvalue("AbilityWheel.Selected" + (ability.type + 1), abilityindex);
Related built-ins
- GetControllerUIModelValue()Gets a data value for a given lui menu, the data name has to be precached and the value as well, if its a string.
- SetUIModelValue()Sets a UIModel from the model being passed in.
- GetUIModelForController()Returns the UIModel from the controller root.
- GetUIModelValue()Returns the value of the UIModel passed in.
- Objective_SetUIModelValue()Set a UI Model Value for an objective
- GetCharacterBodyModel()Gets the body model for this player as selected in character customization
- GetCharacterHelmetModel()Gets the helmet model for this player as selected in character customization
- SetModelLodBias()Sets the model lod bias
- ShowViewModel()Show the player's current view model.
- GetCharacterHeadModel()Gets the head model for this player
- HideViewModel()Hide the player's current view model.
- GetEnemyDogTagModel()Get the enemy of the dog tag model currently associated character body
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).