GSC reference › Built-in
SetClientScriptMainMenu()
Built-in (engine)
Server
Player Called on: player
Sets g_scriptMainMenu dvar only on this client
Signature
<player> SetClientScriptMainMenu(<value>)
Called on an entity: player SetClientScriptMainMenu(...)
Parameters
| Name | Required? | Details |
|---|---|---|
| value | Required | The value to set |
Example (from Treyarch's docs)
self SetClientScriptMainMenu( game["menu_class"] )
Real uses in BO3's scripts
Called 22 times in the decompiled scripts. A few, zombies first:
- scripts/zm/gametypes/_globallogic_player.gsc, line 278
self setclientscriptmainmenu(game["menu_start_menu"]); - scripts/zm/gametypes/_globallogic_ui.gsc, line 232
self setclientscriptmainmenu(game["menu_start_menu"]); - scripts/zm/gametypes/_zm_gametype.gsc, line 838
self setclientscriptmainmenu(game["menu_start_menu"]); - scripts/mp/gametypes/_globallogic_player.gsc, line 947
self setclientscriptmainmenu(game["menu_start_menu"]); - scripts/mp/gametypes/_globallogic_ui.gsc, line 332
self setclientscriptmainmenu(game["menu_start_menu"]);
Related built-ins
- PopulateScriptDebugMenu()Sets a UIModel from the model being passed in.
- SetHideonClientWhenScriptedAnimCompleted()Hides the entity on the client side onces its scripted animation ends
- SetLUIMenuData()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.
- SetClientUIVisibilityFlag()Sets a HUD visibility flag only on this client
- CloseLUIMenu()Closes the given lui menu and returns true if it finds the menu and succeeds in closing it, false otherwise.
- OpenLUIMenu()Opens a lui menu( has to be precahced ) and returns a handle to it.
- CloseInGameMenu()Close the in game menu for this client.
- GetLUIMenu()Returns a handle to a lui menu.
- OpenMenu()Open the menu with the given menu index
- SetClientThirdPerson()Set the client to be third person
- CloseMenu()Close the specified menu for this client.
- SetClientCGObjectiveText()Sets the objective text only on this client
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).