JRAD at 12:09, 21 November 2007

2007-11-21T12:09:26Z

New page

__NOEDITSECTION__
== Class Tree ==
* [[:UserInterfaceLocal]]

== Overview ==
This is the GUI itself, all window defs must be inside it. You may set properties, flags, cache materials, cache sounds, set atmospheres and add events directly on the GUI. GUI script functions may be called from any event or timeline by using a "gui." prefix to the function name.

'''Example:'''
gui guis/vehicles/edf_titan {
// Properties for the GUI.
properties {
float flags = immediate( flags ) | GUI_FULLSCREEN;
}
_class_icons

// Cache the titan icon material.
materials {
"icon" "guis/assets/hud/gdf/vehicles/titan"
}

_base_icon // Template: setup background material, player list, etc.
_hud_materials // Template: Cache all materials used in the HUD.
_position( 0, 2, 10 ) // Template: Setup icon for player position 0
_position( 1, 2, 24 ) // Template: Setup icon for player position 1

// Template: Draw a generic GDF missile sight.
_gdf_generic_missile_sight( "dontshowlines", "0,0,0,1", "0,0,0,1" )
}

== Properties ==
{{:UserInterfaceLocal Properties}}

== Flags ==
{{:UserInterfaceLocal Flags}}

== Functions ==
=== Evaluator Functions ===
[[UserInterfaceLocal:compare|compare]] String comparison.
[[UserInterfaceLocal:icompare|icompare]] Case insensitive string comparison.
[[UserInterfaceLocal:wcompare|wcompare]] Wide string comparison.
[[UserInterfaceLocal:iwcompare|iwcompare]] Case insensitive string comparison. Ignores color codes.
[[UserInterfaceLocal:hcompare|hcompare]] Compare handles.
[[UserInterfaceLocal:toString|toString]] Float to string conversion.
[[UserInterfaceLocal:toWString|toWString]] Float to wide string conversion.
[[UserInterfaceLocal:toFloat|toFloat]] String value converted to a float.
[[UserInterfaceLocal:localizeArgs|localizeArgs]] Localize text with additional string arguments.
[[UserInterfaceLocal:localizeHandle|localizeHandle]] Localize text given a text declaration handle.
[[UserInterfaceLocal:localize|localize]] Localize text.
[[UserInterfaceLocal:square|square]] Squares the input value.
[[UserInterfaceLocal:vec2Length|vec2Length]] Length of a 2D vector.
[[UserInterfaceLocal:vec2Normalize|vec2Normalize]] Normalize a 2D vector.
[[UserInterfaceLocal:abs|abs]] Absolute value of a float.
[[UserInterfaceLocal:min|min]] Returns the minimum of two values.
[[UserInterfaceLocal:max|max]] Returns the maximum of two values.
[[UserInterfaceLocal:clamp|clamp]] Clamp value between min and max.
[[UserInterfaceLocal:msToHMS|msToHMS]] Converts from milliseconds to hours, minutes, seconds.
[[UserInterfaceLocal:sToHMS|sToHMS]] Converts from seconds to hours, minutes, seconds.
[[UserInterfaceLocal:toggle|toggle]] Returns the opposite boolean value of the input value.
[[UserInterfaceLocal:floor|floor]] The floor of the input value.
[[UserInterfaceLocal:ceil|ceil]] The ceiling of the input value.
[[UserInterfaceLocal:toUpper|toUpper]] Convert a string to upper case.
[[UserInterfaceLocal:toLower|toLower]] Convert a string to lower case.
[[UserInterfaceLocal:toWStr|toWStr]] Convert a string to a wide string.
[[UserInterfaceLocal:toStr|toStr]] Convert a wide string to a string.
[[UserInterfaceLocal:isValidHandle|isValidHandle]] Check if handle is valid.
[[UserInterfaceLocal:floatToHandle|floatToHandle]] Convert a float to a handle.
[[UserInterfaceLocal:color|color]] Convert a string to a color.
[[UserInterfaceLocal:strLen|strLen]] Length of the string.
[[UserInterfaceLocal:wstrLen|wstrLen]] Length of the wide string.
[[UserInterfaceLocal:sin|sin]] Sine of the input value.
[[UserInterfaceLocal:cos|cos]] Cosine of the input value.
[[UserInterfaceLocal:colorForIndex|colorForIndex]] Color for the index where the index is between 0 and 31.
[[UserInterfaceLocal:stringToVec4|stringToVec4]] Convert a string to a 4D vector.
=== Utility Functions ===
[[UserInterfaceLocal:consoleCommand|consoleCommand]] Exectue a console command, append to the command buffer.
[[UserInterfaceLocal:consoleCommandImmediate|consoleCommandImmediate]] Exectue a console command, immediate execution of the command.
[[UserInterfaceLocal:playSound|playSound]] Play a sound in the current sound world.
[[UserInterfaceLocal:playGameSound|playGameSound]] Play a sound in the game sound world.
[[UserInterfaceLocal:playMusic|playMusic]] Play a sound on the music channel.
[[UserInterfaceLocal:stopMusic|stopMusic]] Stop any sound on the music channel.
[[UserInterfaceLocal:querySpeakers|querySpeakers]] Desired number of speakers.
[[UserInterfaceLocal:fadeSoundClass|fadeSoundClass]] Fade a sound class to a volume in X milliseconds.
[[UserInterfaceLocal:cacheMaterial|cacheMaterial]] Store a material to the material cache.
[[UserInterfaceLocal:activate|activate]] Activate the GUI if it is not active. Calls onActivate events for windows.
[[UserInterfaceLocal:deactivate|deactivate]] Deactivate the GUI. Calls onDeactivate events for windows.
[[UserInterfaceLocal:sendCommand|sendCommand]] Send a script command, The GUI must be attached to an entity. Script event OnNetworkMessage for the player will be called with the command data.
[[UserInterfaceLocal:sendNetworkCommand|sendNetworkCommand]] Send a script command. Script event OnNetworkMessage for the player will be called with the command data.
[[UserInterfaceLocal:postNamedEvent|postNamedEvent]] Call a named event.
[[UserInterfaceLocal:postNamedEventOn|postNamedEventOn]] Call a named event on a window.
[[UserInterfaceLocal:scriptCall|scriptCall]] Call a script event on the entity this GUI is bound to. The script parameters should be pushed.on the stack using scriptPush<type>() script calls.
[[UserInterfaceLocal:setCookieString|setCookieString]] Set a key/val which will be saved in the user profile.
[[UserInterfaceLocal:getCookieString|getCookieString]] Return value for the key.
[[UserInterfaceLocal:setCookieInt|setCookieInt]] Set an integer key/val which will be saved in the user profile.
[[UserInterfaceLocal:getCookieInt|getCookieInt]] Return integer value for the key.
[[UserInterfaceLocal:setShaderParm|setShaderParm]] Sets a shader parameter value. This is for example used while drawing the command map so different material stages can be used depending on if the command map is drawn in a circle or a rectangle
[[UserInterfaceLocal:getKeyBind|getKeyBind]] Get the key for a binding.
[[UserInterfaceLocal:print|print]] Print a string to the console. _newline or _quote should be used instead of the escape characters \n and \" respectively.
[[UserInterfaceLocal:getStringForProperty|getStringForProperty]] Get string for a window property.
[[UserInterfaceLocal:setPropertyFromString|setPropertyFromString]] Set a property from a string.
[[UserInterfaceLocal:broadcastEvent|broadcastEvent]] Broadcast a named event to a window. If no window is specified post the event on the GUI.
[[UserInterfaceLocal:broadcastEventToChildren|broadcastEventToChildren]] Broadcast an event only to immediate children.
[[UserInterfaceLocal:broadcastEventToDescendants|broadcastEventToDescendants]] Broadcast an event recursively to all children.
[[UserInterfaceLocal:getParentName|getParentName]] Get parent name.
[[UserInterfaceLocal:copyHandle|copyHandle]] Copy a handle. Should be used instead of immediate for integers.
[[UserInterfaceLocal:activateMenuSoundWorld|activateMenuSoundWorld]] Activates the menu sound world and pauses the game sound world or deactivates the menu sound world and unpauses the game sound world.
[[UserInterfaceLocal:getStringMapValue|getStringMapValue]] Get value for a key for the give string map def. Used to cache crosshair material used by the player.
[[UserInterfaceLocal:isBackgroundLoadComplete|isBackgroundLoadComplete]] Check if loading of menu models (earth/stars/strogg fleet etc.) has been loaded.
[[UserInterfaceLocal:copyText|copyText]] Copy the text to the clipboard.
[[UserInterfaceLocal:pasteText|pasteText]] Copy the clipboard data.
[[UserInterfaceLocal:uploadLevelShot|uploadLevelShot]] Upload an image to a target image. Used for map screenshots.
[[UserInterfaceLocal:getGameTag|getGameTag]] Game build name.
[[UserInterfaceLocal:getLoadTip|getLoadTip]] Get a load tooltip intended for the map loading screen.
[[UserInterfaceLocal:cancelToolTip|cancelToolTip]] Set float property active to false for the toolTip window.
[[UserInterfaceLocal:checkCVarsAgainstCFG|checkCVarsAgainstCFG]] Used in game options to check the machine spec the user has chosen.
[[UserInterfaceLocal:collapseColors|collapseColors]] Collapse all color codes.
=== Game Functions ===
[[UserInterfaceLocal:getSpectatorList|getSpectatorList]] List of spectators separated with commas. Used with the marquee window type for scrolling.
[[UserInterfaceLocal:getTeamPlayerCount|getTeamPlayerCount]] Get the number of players on a team.
[[UserInterfaceLocal:getWeaponData|getWeaponData]] Get weapon value given a key. Mainly used for getting model and model/joint names for player in the limbo menu.
[[UserInterfaceLocal:getNumWeaponPackages|getNumWeaponPackages]] Get number of weapon packages for a class.
[[UserInterfaceLocal:getWeaponBankForName|getWeaponBankForName]] Get bank number for slot name.
[[UserInterfaceLocal:updateLimboProficiency|updateLimboProficiency]] Set new player class and update the proficiency related limbo properties. Used for updating limbo properties when selecting a class.
[[UserInterfaceLocal:getRoleCountForTeam|getRoleCountForTeam]] Number of players with a specific role on a team.
[[UserInterfaceLocal:getEquivalentClass|getEquivalentClass]] Get the equivalent class on the target team to the class on the current team.
[[UserInterfaceLocal:getClassSkin|getClassSkin]] Get skin name for class.
[[UserInterfaceLocal:toggleReady|toggleReady]] Toggle the local player to be ready during warmup.
[[UserInterfaceLocal:execVote|execVote]] Execute a vote on client or listen server. The vote index then the vote key should have been pushed on the GUI stack before calling this function.
[[UserInterfaceLocal:getCommandMapTitle|getCommandMapTitle]] Get the command map title for a playzone on the current map.
[[UserInterfaceLocal:getPersistentRankInfo|getPersistentRankInfo]] Get the current rank or rank material name for the local player.
[[UserInterfaceLocal:setSpawnPoint|setSpawnPoint]] Set the current spawn point for the local player. Send the name to the server if a client.
[[UserInterfaceLocal:highlightSpawnPoint|highlightSpawnPoint]] Call script event OnHighlight on the spawnpoint for the team.
[[UserInterfaceLocal:mutePlayer|mutePlayer]] Toggle mute for a player.
[[UserInterfaceLocal:spectateClient|spectateClient]] Spectate a specific client, works on client and listen server.
[[UserInterfaceLocal:chatCommand|chatCommand]] Send a chat command.
=== CVar Functions ===
[[UserInterfaceLocal:setCVar|setCVar]] Set a cvar.
[[UserInterfaceLocal:getCVar|getCVar]] Get a cvar value.
[[UserInterfaceLocal:resetCVar|resetCVar]] Reset a CVar, gives it the default value.
[[UserInterfaceLocal:setCVarFloat|setCVarFloat]] Set a cvar.
[[UserInterfaceLocal:getCVarFloat|getCVarFloat]] Get a cvar value.
[[UserInterfaceLocal:setCVarInt|setCVarInt]] Set a cvar.
[[UserInterfaceLocal:getCVarInt|getCVarInt]] Get a cvar value.
[[UserInterfaceLocal:setCVarBool|setCVarBool]] Set a cvar.
[[UserInterfaceLocal:getCVarBool|getCVarBool]] Get a cvar value.
[[UserInterfaceLocal:getCVarColor|getCVarColor]] Get a cvar value.
[[UserInterfaceLocal:isCVarLocked|isCVarLocked]] Check if a CVar has the CVAR_GUILOCKED flag set.
=== Stack Functions ===
[[UserInterfaceLocal:scriptPushString|scriptPushString]] Push a string on the stack.
[[UserInterfaceLocal:scriptPushFloat|scriptPushFloat]] Push a float on the stack.
[[UserInterfaceLocal:scriptPushVec2|scriptPushVec2]] Push a vec2 on the stack.
[[UserInterfaceLocal:scriptPushVec3|scriptPushVec3]] Push a vec3 on the stack.
[[UserInterfaceLocal:scriptPushVec4|scriptPushVec4]] Push a vec4 on the stack.
[[UserInterfaceLocal:scriptGetWStringResult|scriptGetWStringResult]] Pop a wide string from the stack.
[[UserInterfaceLocal:scriptGetStringResult|scriptGetStringResult]] Pop a string from the stack.
[[UserInterfaceLocal:scriptGetFloatResult|scriptGetFloatResult]] Pop a float from the stack.
[[UserInterfaceLocal:scriptGetVec2Result|scriptGetVec2Result]] Pop a vec2 from the stack.
[[UserInterfaceLocal:scriptGetVec4Result|scriptGetVec4Result]] Pop a vec4 from the stack.
[[UserInterfaceLocal:pushGeneralString|pushGeneralString]] Push a string on the stack with the given name. Any literal stack name is valid.
[[UserInterfaceLocal:popGeneralString|popGeneralString]] Pop a string on the stack with the given name. Any literal stack name is valid.
[[UserInterfaceLocal:getGeneralString|getGeneralString]] Get the string on the top of the stack with the given name, does not pop the stack. Any literal stack name is valid.
[[UserInterfaceLocal:generalStringAvailable|generalStringAvailable]] Check if a stack with the given name is available.
[[UserInterfaceLocal:clearGeneralStrings|clearGeneralStrings]] Clear the stack with the given name.

== Events ==
[[UserInterfaceLocal:onCreate|onCreate]] Called on window creation
[[UserInterfaceLocal:onActivate|onActivate]] This happens when the GUI is activated.
[[UserInterfaceLocal:onDeactivate|onDeactivate]] This happens when the GUI is activated.
[[UserInterfaceLocal:onNamedEvent|onNamedEvent]] Called when one of the events specified occurs
[[UserInterfaceLocal:onPropertyChanged|onPropertyChanged]] Called when one of the properties specified occurs
[[UserInterfaceLocal:onCVarChanged|onCVarChanged]] Called when one of the CVars' value changes
[[UserInterfaceLocal:onCancel|onCancel]] Called when any key bound to the _menuCancel is pressed

[[Category:GUIs]]

UserInterfaceLocal - Revision history

JRAD at 12:09, 21 November 2007