View source for Titanfall/Scripting/UI Script Functions

{{toc-right}}
Automatically generated Squirrel functions list for {{titanfall|4}} (R1Delta). These functions are only present in the UI Squirrel VM

== Classes ==
=== :: (Global functions) ===
==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>AmIPartyLeader</code>
| <code>bool AmIPartyLeader()</code>
| Returns true if the local player is the party leader.
|-
| <code>AngleNormalize</code>
| <code>float AngleNormalize( float )</code>
| Wraps given angle to [-180, 180] range
|-
| <code>AreWeMatchmaking</code>
| <code>bool AreWeMatchmaking()</code>
| Returns true if we are matchmaking
|-
| <code>BoxIntersectsBox</code>
| <code>bool BoxIntersectsBox( Vector, Vector, Vector, Vector )</code>
| Given an angle and vector, returns the angular difference needed to face from the given angle to the given vector
|-
| <code>CalcRelativeAngles</code>
| <code>Vector CalcRelativeAngles( Vector, Vector )</code>
| Given an angle and vector, returns the angular difference needed to face from the given angle to the given vector
|-
| <code>CalcRelativeVector</code>
| <code>Vector CalcRelativeVector( Vector, Vector )</code>
| Given an absolute angle and absolute direction vector, returns a local direction vector; one that is relative to the absolute angle's axes
|-
| <code>CanLoadGameLevels</code>
| <code>bool CanLoadGameLevels()</code>
| Returns true if this dedi can load game levels
|-
| <code>CanRunClientScript</code>
| <code>bool CanRunClientScript()</code>
| Returns true if the client script VM is available to be run
|-
| <code>ClientCommand</code>
| <code>void ClientCommand( string )</code>
| Sends a client command to the server
|-
| <code>ClientMountVPK</code>
| <code>void ClientMountVPK( string, bool )</code>
| Tells the file system on the client a VPK to mount, and whether to start caching it.
|-
| <code>CloseMenu</code>
| <code>void CloseMenu( handle )</code>
| Closes a menu created by CreateMenu
|-
| <code>CodeWarning</code>
| <code>void CodeWarning( string )</code>
| Print string that code uses for errors.
|-
| <code>CreateKeyBindingMenu</code>
| <code>handle CreateKeyBindingMenu( string, string )</code>
| Like CreateMenu, but with special functionality for the key binding menu
|-
| <code>CreateMenu</code>
| <code>handle CreateMenu( string, string )</code>
| Takes a .res file and creates a menu from it.
|-
| <code>CreateVideoOptionsMenu</code>
| <code>handle CreateVideoOptionsMenu( string, string )</code>
| Like CreateMenu, but with special functionality for video options
|-
| <code>CreateVisGroup</code>
| <code>int CreateVisGroup()</code>
| Returns a new visGroup handle.
|-
| <code>DeregisterButtonPressedCallback</code>
| <code>void DeregisterButtonPressedCallback( buttonID, callback )    ParameterMask:[.ic]</code>
| 
|-
| <code>DeregisterButtonReleasedCallback</code>
| <code>void DeregisterButtonReleasedCallback( buttonID, callback )    ParameterMask:[.ic]</code>
| 
|-
| <code>DeregisterStickMovedCallback</code>
| <code>void DeregisterStickMovedCallback( axisID, callback )    ParameterMask:[.ic]</code>
| 
|-
| <code>DisableBackgroundMovie</code>
| <code>void DisableBackgroundMovie()</code>
| Disable the background movie in the base panel
|-
| <code>DispatchServerListReq</code>
| <code>void DispatchServerListReq( str )    ParameterMask:[.ib]</code>
| Gets server list
|-
| <code>DoIHaveBadRep</code>
| <code>bool DoIHaveBadRep()</code>
| Returns true if you have bad rep
|-
| <code>DoIncludeScript</code>
| <code>bool DoIncludeScript( string, handle )</code>
| Execute a script (internal)
|-
| <code>DoWeHaveRequiredDLCForPlaylist</code>
| <code>bool DoWeHaveRequiredDLCForPlaylist( string )</code>
| Checks if the local player has at least one map group that the playlist requires
|-
| <code>DoesMyPartyHaveBadRep</code>
| <code>bool DoesMyPartyHaveBadRep()</code>
| Returns true if anyone in your party has bad rep
|-
| <code>Durango_AcceptInvite</code>
| <code>bool Durango_AcceptInvite()</code>
| Accept the party invite and connect to the party dedi.
|-
| <code>Durango_CanInviteFriends</code>
| <code>bool Durango_CanInviteFriends()</code>
| Returns true if you are in a state where you can invite friends.
|-
| <code>Durango_CreatePartyOfOneIfRequired</code>
| <code>void Durango_CreatePartyOfOneIfRequired()</code>
| Creates a party of one if required. Call this when you press 'PLAY' in the main menu.
|-
| <code>Durango_GetErrorString</code>
| <code>string Durango_GetErrorString()</code>
| The error string that should be displayed while in the error screen.
|-
| <code>Durango_GetGameDisplayName</code>
| <code>string Durango_GetGameDisplayName()</code>
| Returns the current game display name as a string. Valid only if Durango_IsSignedIn is true.
|-
| <code>Durango_GetNumPartyMembers</code>
| <code>int Durango_GetNumPartyMembers()</code>
| Gets the number of members in the X1 party. This may be different to the number of party members in your game with you.
|-
| <code>Durango_GetXUID</code>
| <code>string Durango_GetXUID()</code>
| Gets the current player's XUID
|-
| <code>Durango_GoToSplashScreen</code>
| <code>void Durango_GoToSplashScreen()</code>
| Discard the current user/controller pair and go to the splash screen.
|-
| <code>Durango_HasInvite</code>
| <code>bool Durango_HasInvite()</code>
| Returns true if we have a party invite.
|-
| <code>Durango_HasPermissionToPlayMultiplayer</code>
| <code>bool Durango_HasPermissionToPlayMultiplayer()</code>
| Returns true if the currently signed in user has permission to play multiplayer.
|-
| <code>Durango_InErrorScreen</code>
| <code>bool Durango_InErrorScreen()</code>
| Returns true if we are in the error screen. eg. "User signed out!"
|-
| <code>Durango_InSplashScreen</code>
| <code>bool Durango_InSplashScreen()</code>
| Returns true if we are in the splash screen.
|-
| <code>Durango_InviteFriends</code>
| <code>bool Durango_InviteFriends()</code>
| Invite your friends to join your party.
|-
| <code>Durango_IsControllerDisconnected</code>
| <code>bool Durango_IsControllerDisconnected()</code>
| Returns true if controller is disconnected post-main menu.
|-
| <code>Durango_IsDurango</code>
| <code>bool Durango_IsDurango()</code>
| Returns true if we are running on a Durango.
|-
| <code>Durango_IsGameFullyInstalled</code>
| <code>bool Durango_IsGameFullyInstalled()</code>
| Returns whether the game is fully installed. If the game is not then we can't load any levels other than lobby and training
|-
| <code>Durango_IsGuest</code>
| <code>bool Durango_IsGuest()</code>
| Returns whether the signed in Durango player is a guest
|-
| <code>Durango_IsJoinable</code>
| <code>bool Durango_IsJoinable()</code>
| 
|-
| <code>Durango_IsOnline</code>
| <code>bool Durango_IsOnline()</code>
| Returns true if we are currently online. eg: connected to the internet
|-
| <code>Durango_IsSignedIn</code>
| <code>bool Durango_IsSignedIn()</code>
| Returns true if we have a signed-in user on Durango.
|-
| <code>Durango_IsSigningIn</code>
| <code>bool Durango_IsSigningIn()</code>
| Returns true if we are in the middle of async signing in (eg. loading profile, checking if we have permission to play multiplayer).
|-
| <code>Durango_IsSuspended</code>
| <code>bool Durango_IsSuspended()</code>
| Returns true if we are currently in a suspended state
|-
| <code>Durango_OnLobbySessionStart</code>
| <code>void Durango_OnLobbySessionStart( int, int )</code>
| Call when enterring the lobby ( int gamemodeId, int difficultyLevelId )
|-
| <code>Durango_OnMultiplayerRoundStart</code>
| <code>void Durango_OnMultiplayerRoundStart( int, int, int, int, int )</code>
| Call when starting a multiplayer round ( int gamemodeId, int mapId, int difficultyLevelId, int roundId, int matchTypeId )
|-
| <code>Durango_OpenPartyApp</code>
| <code>void Durango_OpenPartyApp()</code>
| 
|-
| <code>Durango_SetGameProgress</code>
| <code>void Durango_SetGameProgress( float )</code>
| Update the currently signed in Durango player's game progress [0, 1] ( float progress )
|-
| <code>Durango_ShowAccountPicker</code>
| <code>void Durango_ShowAccountPicker()</code>
| Show the account picker UI. This should only be called when Durango_IsSignedIn is true.
|-
| <code>Durango_ShowHelpWindow</code>
| <code>bool Durango_ShowHelpWindow()</code>
| Show the Durango help window (probably snapped) that has a game manual. Returns true if the window will be shown
|-
| <code>Durango_SkippedSignIn</code>
| <code>bool Durango_SkippedSignIn()</code>
| Returns true if the user has skipped sign in. Always false in retail build.
|-
| <code>EmitUISound</code>
| <code>float EmitUISound( string )</code>
| Play a sound for the local client.
|-
| <code>EnableBackgroundMovie</code>
| <code>void EnableBackgroundMovie()</code>
| Enable the background movie in the base panel
|-
| <code>EverythingUnlockedConVarEnabled</code>
| <code>bool EverythingUnlockedConVarEnabled()</code>
| 
|-
| <code>ExecConfig</code>
| <code>void ExecConfig( string )</code>
| Executes a .cfg file
|-
| <code>FocusDefaultMenuItem</code>
| <code>void FocusDefaultMenuItem( handle )</code>
| Resets the focus to default for the menu
|-
| <code>ForceUpdateHUDAnimations</code>
| <code>void ForceUpdateHUDAnimations()</code>
| Forces HUD animations to update, which normally only happens when a frame is rendered. Useful for HUD animations with zero duration.
|-
| <code>GetAddonsPath</code>
| <code>string GetAddonsPath( str )    ParameterMask:[.I]</code>
| Get a persistent data value
|-
| <code>GetAimassistLookSensitivity</code>
| <code>int GetAimassistLookSensitivity()</code>
| Get the current aim assist sensitivity as a integer.
|-
| <code>GetBugReproNum</code>
| <code>int GetBugReproNum()</code>
| Gets the integer value of the 'bug_reproNum' convar
|-
| <code>GetConVarBool</code>
| <code>bool GetConVarBool( string )</code>
| Gets the value of a convar as a boolean
|-
| <code>GetConVarFloat</code>
| <code>float GetConVarFloat( string )</code>
| Gets the value of a convar as a float
|-
| <code>GetConVarInt</code>
| <code>int GetConVarInt( string )</code>
| Gets the value of a convar as an integer
|-
| <code>GetConVarString</code>
| <code>string GetConVarString( string )</code>
| Gets the value of a convar as a string
|-
| <code>GetCurrentPlaylistGamemodeByIndex</code>
| <code>string GetCurrentPlaylistGamemodeByIndex( int )</code>
| Returns the name of the gamemode by index from the list of maps in the current playlist
|-
| <code>GetCurrentPlaylistMapByIndex</code>
| <code>string GetCurrentPlaylistMapByIndex( int )</code>
| Returns the name of the map by index from the list of maps in the current playlist
|-
| <code>GetCurrentPlaylistName</code>
| <code>string GetCurrentPlaylistName()</code>
| Get the name of the current playlist
|-
| <code>GetCurrentPlaylistVar</code>
| <code>string GetCurrentPlaylistVar( string )</code>
| Get the value of a variable from the current playlist
|-
| <code>GetCurrentPlaylistVarOrUseValue</code>
| <code>string GetCurrentPlaylistVarOrUseValue( string, string )</code>
| Get the value of a variable from the current playlist, and if it doesn't exist, use the value passed in
|-
| <code>GetCurrentPlaylistVarOrUseValueOriginal</code>
| <code>string GetCurrentPlaylistVarOrUseValueOriginal( string, string )</code>
| Get the original value of a variable from the current playlist, and if it doesn't exist, use the value passed in
|-
| <code>GetDLCMapGroupForMap</code>
| <code>int GetDLCMapGroupForMap( string )</code>
| Gets the map group index for a given map name
|-
| <code>GetDatacenterName</code>
| <code>string GetDatacenterName()</code>
| Returns the name of the current datacenter
|-
| <code>GetDatacenterPing</code>
| <code>int GetDatacenterPing()</code>
| Returns the ping of the current datacenter
|-
| <code>GetDeveloperLevel</code>
| <code>int GetDeveloperLevel()</code>
| Gets the level of 'developer'
|-
| <code>GetEULAVersionAccepted</code>
| <code>int GetEULAVersionAccepted()</code>
| Gets version of the EULA that the user has accepted (convar eula_version_accepted)
|-
| <code>GetElementsByClassname</code>
| <code><unknown> GetElementsByClassname( handle, string )</code>
| Gets a list of elements within the given menu with the given classname
|-
| <code>GetFadeParams</code>
| <code><unknown> GetFadeParams()</code>
| Returns the clients desired screen fade settings
|-
| <code>GetFocus</code>
| <code>handle GetFocus()</code>
| Gets the focused element
|-
| <code>GetGlobalActiveTeamCount</code>
| <code>int GetGlobalActiveTeamCount()</code>
| Returns the number of active team names we have in our team name list
|-
| <code>GetGlobalActiveTeamName</code>
| <code>string GetGlobalActiveTeamName( int )</code>
| Returns the team name from the list of active teams (globally)
|-
| <code>GetHitgroupForHitboxOnEntity</code>
| <code>int GetHitgroupForHitboxOnEntity( handle, int )</code>
| Given ( entity, hitboxIndex ) - returns the hitgroup for the hitbox on that entity
|-
| <code>GetJoyInvert</code>
| <code>bool GetJoyInvert()</code>
| Get the current joy invert as a float.
|-
| <code>GetKeyBinding</code>
| <code>string GetKeyBinding( int )</code>
| Returns the binding for a given key (like BUTTON_A)
|-
| <code>GetLanguage</code>
| <code>string GetLanguage()</code>
| Returns the language the game is running at
|-
| <code>GetLevelForXP</code>
| <code>int GetLevelForXP( int )</code>
| Gets level for a player with a given amount of XP
|-
| <code>GetLobbyDevString</code>
| <code>string GetLobbyDevString()</code>
| 
|-
| <code>GetLobbyTeamsShowAsBalanced</code>
| <code>bool GetLobbyTeamsShowAsBalanced()</code>
| 
|-
| <code>GetLobbyType</code>
| <code>string GetLobbyType()</code>
| Returns 'party' or 'game' lobby type
|-
| <code>GetMapCountForCurrentPlaylist</code>
| <code>int GetMapCountForCurrentPlaylist()</code>
| Gets the total number of maps in the current playlist
|-
| <code>GetMapCountForPlaylist</code>
| <code>int GetMapCountForPlaylist( string )</code>
| Gets the total number of maps in a playlist
|-
| <code>GetMinimumR1DVersion</code>
| <code>void GetMinimumR1DVersion( str )    ParameterMask:[.]</code>
| Get r1d minimum server for filtering
|-
| <code>GetMods</code>
| <code>string GetMods( str )    ParameterMask:[.ss]</code>
| Get a persistent data value
|-
| <code>GetMusicReducedSetting</code>
| <code>bool GetMusicReducedSetting()</code>
| Returns true if the 'reduced music mode' setting is enabled
|-
| <code>GetMyTeamMatchmakingParam</code>
| <code>string GetMyTeamMatchmakingParam( int )</code>
| Gets the current matchmaking status parameter for the user's team
|-
| <code>GetMyTeamMatchmakingStatus</code>
| <code>string GetMyTeamMatchmakingStatus()</code>
| Gets the current matchmaking status for the user's team
|-
| <code>GetNumSuggestedTeamNames</code>
| <code>int GetNumSuggestedTeamNames()</code>
| Returns the number of team name suggestions that we have in the list
|-
| <code>GetOtherTeamMatchmakingParam</code>
| <code>string GetOtherTeamMatchmakingParam( int )</code>
| Gets the current matchmaking status parameter for the opposing team
|-
| <code>GetOtherTeamMatchmakingStatus</code>
| <code>string GetOtherTeamMatchmakingStatus()</code>
| Gets the current matchmaking status for opposing team
|-
| <code>GetPartyLeader</code>
| <code>handle GetPartyLeader()</code>
| Get the player who is the party leader.
|-
| <code>GetPartyMembers</code>
| <code>array GetPartyMembers( ent player )    ParameterMask:[.]</code>
| Returns an array of all players in the same party as the local player.
|-
| <code>GetPersistentString</code>
| <code>string GetPersistentString( str )    ParameterMask:[.ss]</code>
| Get a persistent data value
|-
| <code>GetPlayerSettingsFieldForClassName</code>
| <code>var GetPlayerSettingsFieldForClassName( ( "className", "fieldName" ) )    ParameterMask:[.ss.]</code>
| Returns the value for the requested field from the corresponding .set file.
|-
| <code>GetPlayerSettingsFieldForClassName_Health</code>
| <code>float GetPlayerSettingsFieldForClassName_Health( string className )    ParameterMask:[.s]</code>
| Returns the value for the default health field from the corresponding .set file.
|-
| <code>GetPlayerTrainingResumeChoiceUI</code>
| <code>int GetPlayerTrainingResumeChoiceUI()</code>
| Get the player's 'training_resumeChoice' convar setting.
|-
| <code>GetPlaylistCount</code>
| <code>int GetPlaylistCount()</code>
| Returns the total number of playlists
|-
| <code>GetPlaylistCountDescForMonthly</code>
| <code>string GetPlaylistCountDescForMonthly( string )</code>
| 
|-
| <code>GetPlaylistCountDescForRegion</code>
| <code>string GetPlaylistCountDescForRegion( string )</code>
| 
|-
| <code>GetPlaylistCountDescForWorld</code>
| <code>string GetPlaylistCountDescForWorld( string )</code>
| 
|-
| <code>GetPlaylistCountDescForWorldTotal</code>
| <code>string GetPlaylistCountDescForWorldTotal( string )</code>
| 
|-
| <code>GetPlaylistDebugDesc</code>
| <code>string GetPlaylistDebugDesc()</code>
| 
|-
| <code>GetPlaylistGamemodeByIndex</code>
| <code>string GetPlaylistGamemodeByIndex( string, int )</code>
| Returns the name of the gamemode by index from the list of maps in the specified playlist
|-
| <code>GetPlaylistMapByIndex</code>
| <code>string GetPlaylistMapByIndex( string, int )</code>
| Returns the name of the map by index from the list of maps in the specified playlist
|-
| <code>GetPlaylistName</code>
| <code>string GetPlaylistName( int )</code>
| Gets the name of the playlist, by index
|-
| <code>GetPlaylistVar</code>
| <code>string GetPlaylistVar( string, string )</code>
| Get the value of a variable from a playlist
|-
| <code>GetPlaylistVarOrUseValue</code>
| <code>string GetPlaylistVarOrUseValue( string, string, string )</code>
| Get the value of a variable from a playlist, and if it doesn't exist, use the value passed in
|-
| <code>GetPlaylistVarOrUseValueOriginal</code>
| <code>string GetPlaylistVarOrUseValueOriginal( string, string, string )</code>
| Get the original value of a variable from a playlist, and if it doesn't exist, use the value passed in
|-
| <code>GetPublicGameVersion</code>
| <code>string GetPublicGameVersion()</code>
| 
|-
| <code>GetR1DVersion</code>
| <code>void GetR1DVersion( str )    ParameterMask:[.]</code>
| Send discord server
|-
| <code>GetRandom3DPointIn2DCircle</code>
| <code>vector GetRandom3DPointIn2DCircle( radius, base3D_or_null )    ParameterMask:[.n.]</code>
| Get a random 2d point in a circle, as a 3d point, with optional 3d base
|-
| <code>GetRankedPlayDisplayEnabled</code>
| <code>bool GetRankedPlayDisplayEnabled()</code>
| Gets value of convar 'rankedplay_display_enabled'
|-
| <code>GetRankedPlayVoiceEnabled</code>
| <code>bool GetRankedPlayVoiceEnabled()</code>
| Gets value of convar 'rankedplay_voice_enabled'
|-
| <code>GetSettingsForClass_MeleeTable</code>
| <code>table GetSettingsForClass_MeleeTable( string className )    ParameterMask:[..]</code>
| Returns a table with all the melee related active settings for a given player
|-
| <code>GetSettingsForPlayer_DodgeTable</code>
| <code>table GetSettingsForPlayer_DodgeTable( player )    ParameterMask:[..]</code>
| Returns a table with all the dodge related active settings for a given player
|-
| <code>GetSettingsForPlayer_MeleeTable</code>
| <code>table GetSettingsForPlayer_MeleeTable( player )    ParameterMask:[..]</code>
| Returns a table with all the melee related active settings for a given player
|-
| <code>GetSoundVolume</code>
| <code>float GetSoundVolume()</code>
| Get the current sound volume as a float 0 to 1.
|-
| <code>GetTeam</code>
| <code>int GetTeam()</code>
| Gets the team of the local player
|-
| <code>GetTeamHashtag</code>
| <code>string GetTeamHashtag( int )</code>
| Get a team's hashtag, given a team index.
|-
| <code>GetTeamNameSuggestion</code>
| <code>string GetTeamNameSuggestion( int )</code>
| Returns the team name suggestion from the list of suggested team names
|-
| <code>GetTeamNameSuggestionSource</code>
| <code>string GetTeamNameSuggestionSource( int )</code>
| Returns the source of the suggestion
|-
| <code>GetTeamPendingPlayersConnecting</code>
| <code>int GetTeamPendingPlayersConnecting( int )</code>
| 
|-
| <code>GetTeamPendingPlayersLoading</code>
| <code>int GetTeamPendingPlayersLoading( int )</code>
| 
|-
| <code>GetTeamPendingPlayersReserved</code>
| <code>int GetTeamPendingPlayersReserved( int )</code>
| 
|-
| <code>GetTeamSize</code>
| <code>int GetTeamSize( int )</code>
| Returns the number of players in a certain team
|-
| <code>GetTrainingHasEverBeenStartedUI</code>
| <code>bool GetTrainingHasEverBeenStartedUI()</code>
| Returns true if the convar has been set.
|-
| <code>GetTrainingHasEverFinished</code>
| <code>bool GetTrainingHasEverFinished()</code>
| Returns true if the convar has been set.
|-
| <code>GetUnixTimestamp</code>
| <code>int GetUnixTimestamp()</code>
| 
|-
| <code>GetWeaponInfoFileKeyField_Global</code>
| <code><unknown> GetWeaponInfoFileKeyField_Global( string, string )</code>
| Given a weapon name and key, resolves a string key to its value in that weapons info file.
|-
| <code>GetWeaponInfoFileKeyField_WithMods_Global</code>
| <code><unknown> GetWeaponInfoFileKeyField_WithMods_Global( string, handle, string )</code>
| Given a weapon name, a list of weapon mods to apply, and key, returns the value of that field in that weapons info file.
|-
| <code>GetWeaponMods_Global</code>
| <code><unknown> GetWeaponMods_Global( string )</code>
| Given a weapon name, returns a list of the mods available on that weapon
|-
| <code>Graph</code>
| <code>float Graph( float, float, float, float, float )</code>
| Map a value V from C to D. Linier interpolate between A and B mapped to C and D
|-
| <code>GraphCapped</code>
| <code>float GraphCapped( float, float, float, float, float )</code>
| Map a value V from C to D. If V <= A, result = C. If V >= B, result = D. Otherwise linearly interpolate between A and B mapped to C and D
|-
| <code>GraphCappedVector</code>
| <code>Vector GraphCappedVector( float, float, float, Vector, Vector )</code>
| Map a value V from Vector C to Vector D. If V <= A, result = C. If V >= B, result = D. Otherwise linearly interpolate between A and B mapped to C and D
|-
| <code>HudChat_ClearTextFromAllChatPanels</code>
| <code>void HudChat_ClearTextFromAllChatPanels()</code>
| Clears all text from all hud chat panels
|-
| <code>InputGetAxis</code>
| <code>float InputGetAxis( int )</code>
| Given axis id (ex: ANALOG_LEFT_X) returns the value of the axis, in the (-1,1) range.
|-
| <code>InputIsButtonDown</code>
| <code>bool InputIsButtonDown( int )</code>
| Given button id (ex: BUTTON_A), returns true if button is down.
|-
| <code>Interpolate</code>
| <code>float Interpolate( startTime, moveTime, easeIn, easeOut )    ParameterMask:[.nnnn]</code>
| Interpolate with cubic hermite during ease-in and ease-out times
|-
| <code>IsBlurEnabled</code>
| <code>bool IsBlurEnabled()</code>
| Returns whether background is blurred
|-
| <code>IsClient</code>
| <code>bool IsClient()</code>
| Returns true if this is client script
|-
| <code>IsConnected</code>
| <code>bool IsConnected()</code>
| Returns whether the game is connected to a server
|-
| <code>IsControllerModeActive</code>
| <code>bool IsControllerModeActive()</code>
| Returns whether the user is using a controller instead of a keyboard
|-
| <code>IsCoopMatch</code>
| <code>bool IsCoopMatch()</code>
| 
|-
| <code>IsDLCMapGroupEnabledForLocalPlayer</code>
| <code>bool IsDLCMapGroupEnabledForLocalPlayer( int )</code>
| 
|-
| <code>IsFullyConnected</code>
| <code>bool IsFullyConnected()</code>
| Returns whether the game is fully connected to a server
|-
| <code>IsIntroViewed</code>
| <code>bool IsIntroViewed()</code>
| Whether the intro video has been viewed (convar intro_viewed)
|-
| <code>IsMagneticTarget</code>
| <code>bool IsMagneticTarget( handle )</code>
| Returns if an entity is a magnetic target
|-
| <code>IsOptimizedLobby</code>
| <code>bool IsOptimizedLobby()</code>
| Returns true if we are in the optimized lobby. eg. we are loading mp_lobby and optimized_lobby_enabled convar is non-zero.
|-
| <code>IsPartyMember</code>
| <code>bool IsPartyMember( handle )</code>
| Returns true if the player passed in is in a party with the local player.
|-
| <code>IsPlayingDemo</code>
| <code>bool IsPlayingDemo()</code>
| Returns whether a demo is being played back
|-
| <code>IsServer</code>
| <code>bool IsServer()</code>
| Returns true if this is server script
|-
| <code>IsThereNewDLC</code>
| <code>bool IsThereNewDLC()</code>
| Checks if new DLC is available since the player last looked at the DLC store
|-
| <code>IsTurret</code>
| <code>bool IsTurret( handle )</code>
| Is entity a turret
|-
| <code>IsUI</code>
| <code>bool IsUI()</code>
| Returns true if this is UI script
|-
| <code>IsVisGroupVisible</code>
| <code>bool IsVisGroupVisible( int )</code>
| Returns the current visibility state of the specified visGroup
|-
| <code>KeyBindings_Apply</code>
| <code>void KeyBindings_Apply( handle )</code>
| Applies key bindings in menu; pass in key binding menu
|-
| <code>KeyBindings_FillInCurrent</code>
| <code>void KeyBindings_FillInCurrent( handle )</code>
| Fills key bindings menu with current bindings; pass in key binding menu
|-
| <code>KeyBindings_NeedApply</code>
| <code>bool KeyBindings_NeedApply( handle )</code>
| Returns whether any bindings have changed
|-
| <code>KeyBindings_ResetToDefault</code>
| <code>void KeyBindings_ResetToDefault( handle )</code>
| Resets key bindings to default (cfg/config_default_pc.cfg); pass in key binding menu
|-
| <code>LerpVector</code>
| <code>vector LerpVector( vecFrom, vecTo, percent )    ParameterMask:[.xxn]</code>
| Linearly interpolate between two vectors
|-
| <code>Localize</code>
| <code>void Localize( str )    ParameterMask:[.s]</code>
| Set a persistent data value
|-
| <code>MatchmakingBegin</code>
| <code>void MatchmakingBegin( string )</code>
| Begins searching for a matchmaking server
|-
| <code>MatchmakingCancel</code>
| <code>void MatchmakingCancel()</code>
| Cancels searching for a matchmaking server
|-
| <code>NativeFuncTest</code>
| <code>int NativeFuncTest( int, bool, float )</code>
| empty function: takes int, bool, float, returns 1
|-
| <code>OpenDiscordURL</code>
| <code>void OpenDiscordURL( str )    ParameterMask:[]</code>
| Open a discord URL
|-
| <code>OpenMenu</code>
| <code>void OpenMenu( handle )</code>
| Opens a menu created by CreateMenu
|-
| <code>Origin_IsEnabled</code>
| <code>bool Origin_IsEnabled()</code>
| Returns true if origin is enabled.
|-
| <code>Origin_IsJoinable</code>
| <code>bool Origin_IsJoinable()</code>
| Returns true if the Origin session is joinable, eg. if Origin is enabled and we are ready and we have a valid session and our team is not full, and we are not in mp_npe level :D
|-
| <code>Origin_IsOnline</code>
| <code>bool Origin_IsOnline()</code>
| Returns true if origin is online. If Origin is not online please grey out "PLAY" in the main menu.
|-
| <code>Origin_IsOverlayAvailable</code>
| <code>bool Origin_IsOverlayAvailable()</code>
| Returns true if the Origin overlay is available. Perf is safe to call this function repeatedly as it uses a cached value. Value may dynamically change as the game is running
|-
| <code>Origin_IsReady</code>
| <code>bool Origin_IsReady()</code>
| Returns true if origin is ready to go. You should block leaving the main menu until this is true. If origin is enabled it needs to be ready before you connect to the party dedi
|-
| <code>Origin_RequestTicket</code>
| <code>void Origin_RequestTicket()</code>
| Origin gets a ticket on startup/restart, but you should request a new one before connecting to party dedi to make sure it is fresh. Call this when the user selects "PLAY" in the main menu.
|-
| <code>Origin_ShowInviteFriendsDialog</code>
| <code>bool Origin_ShowInviteFriendsDialog()</code>
| Show the Origin invite friends dialog. Returns false if for some reason it didn't work.
|-
| <code>PerfClearAll</code>
| <code>void PerfClearAll()</code>
| Clear all data
|-
| <code>PerfDump</code>
| <code>void PerfDump()</code>
| Print profile data.
|-
| <code>PerfEnd</code>
| <code>void PerfEnd( int )</code>
| End the timer for profile entry.
|-
| <code>PerfInitLabel</code>
| <code>void PerfInitLabel( int, string )</code>
| Initialize profile entry with name.
|-
| <code>PerfReset</code>
| <code>void PerfReset()</code>
| Reset just the timing data, keep labels.
|-
| <code>PerfStart</code>
| <code>void PerfStart( int )</code>
| Start timer for profile entry.
|-
| <code>PlayVideo</code>
| <code>void PlayVideo( string, bool )</code>
| Play a fullscreen video
|-
| <code>PollServerList</code>
| <code>void PollServerList( str )    ParameterMask:[.ib]</code>
| Gets server list
|-
| <code>PrecacheHUDMaterial</code>
| <code>void PrecacheHUDMaterial( string )</code>
| Precache a material for use with SetImage.
|-
| <code>PrecacheHUDMaterialAllowFailure</code>
| <code>bool PrecacheHUDMaterialAllowFailure( string )</code>
| Precache a material for use with SetImage; returns true if successful, won't error if the material doesn't exist
|-
| <code>PrecachePilotImpactEffectTables</code>
| <code>void PrecachePilotImpactEffectTables( string )</code>
| Precache pilot land impact table
|-
| <code>PrecacheTitanImpactEffectTables</code>
| <code>void PrecacheTitanImpactEffectTables( string, string, string )</code>
| Precache titan footstep, land, dodge impact tables
|-
| <code>RProfEnd</code>
| <code>void RProfEnd( int )</code>
| End rpof timer for index.
|-
| <code>RProfStart</code>
| <code>void RProfStart( int, string )</code>
| Start rpof timer for index.
|-
| <code>RandomFloat</code>
| <code>float RandomFloat( float, float )</code>
| Generate a random floating point number within a range, inclusive
|-
| <code>RandomInt</code>
| <code>void RandomInt(num, opmax)</code>
| If one number is supplied, generate a random number between 0 and that number minus one. If two numbers, return a random number between parm 1 and parm 2 minus one.
|-
| <code>RegisterButtonPressedCallback</code>
| <code>void RegisterButtonPressedCallback( buttonID, callback )    ParameterMask:[.ic]</code>
| 
|-
| <code>RegisterButtonReleasedCallback</code>
| <code>void RegisterButtonReleasedCallback( buttonID, callback )    ParameterMask:[.ic]</code>
| 
|-
| <code>RegisterMenuButtonPressedCallback</code>
| <code>void RegisterMenuButtonPressedCallback( buttonID, callback )    ParameterMask:[.ic]</code>
| 
|-
| <code>RegisterMenuButtonReleasedCallback</code>
| <code>void RegisterMenuButtonReleasedCallback( buttonID, callback )    ParameterMask:[.ic]</code>
| 
|-
| <code>RegisterStickMovedCallback</code>
| <code>void RegisterStickMovedCallback( axisID, callback )    ParameterMask:[.ic]</code>
| 
|-
| <code>RemoveAllRagdolls</code>
| <code>void RemoveAllRagdolls()</code>
| Remove all ragdolls
|-
| <code>RunAnimationScript</code>
| <code>void RunAnimationScript( string )</code>
| RunsAnimationScript
|-
| <code>RunClientScript0</code>
| <code>void RunClientScript0( string, bool )</code>
| Executes a client script function with no addition arguments
|-
| <code>RunClientScript1</code>
| <code>void RunClientScript1( string, bool, <unknown> )</code>
| Executes a client script function with one additional argument (only numbers are supported)
|-
| <code>SafeareaSettingIsEnabled</code>
| <code>bool SafeareaSettingIsEnabled()</code>
| Returns true if the safearea setting is enabled
|-
| <code>SaveFocusedItemForReopen</code>
| <code>void SaveFocusedItemForReopen( handle )</code>
| Remembers the currently focused item, so that it will be refocused the next time the menu is opened. (This normally happens when closing the menu.)
|-
| <code>SavePlayerSettings</code>
| <code>void SavePlayerSettings()</code>
| Save player config to storage.
|-
| <code>ScriptExists</code>
| <code>bool ScriptExists( string )</code>
| Check for the existence of a script file
|-
| <code>SendDiscordUI</code>
| <code>void SendDiscordUI( str )    ParameterMask:[.]</code>
| Send discord UI
|-
| <code>ServerHasDLCMapGroupEnabled</code>
| <code>bool ServerHasDLCMapGroupEnabled( int )</code>
| Returns whether the server can play maps from the given map group
|-
| <code>SetAimassistLookSensitivity</code>
| <code>void SetAimassistLookSensitivity( int )</code>
| Set the current aim assist sensitivity as a integer.
|-
| <code>SetBlurEnabled</code>
| <code>void SetBlurEnabled( bool )</code>
| Sets blurring of background behind menus
|-
| <code>SetEULAVersionAccepted</code>
| <code>void SetEULAVersionAccepted( int )</code>
| Sets version of the EULA that the user has accepted (convar eula_version_accepted)
|-
| <code>SetInMenuForButtonCallbacks</code>
| <code>void SetInMenuForButtonCallbacks( inMenu )    ParameterMask:[.b]</code>
| 
|-
| <code>SetIntroViewed</code>
| <code>void SetIntroViewed( bool )</code>
| Sets whether the intro video has been viewed (convar intro_viewed)
|-
| <code>SetJoyInvert</code>
| <code>void SetJoyInvert( bool )</code>
| Set the current joy invert as a float.
|-
| <code>SetPlayerTrainingResumeChoice</code>
| <code>void SetPlayerTrainingResumeChoice( int )</code>
| Set the local player's 'training_resumeChoice' convar setting.
|-
| <code>SetReloadingScripts</code>
| <code>void SetReloadingScripts( bool )</code>
| Set to true when reloading scripts
|-
| <code>SetSoundVolume</code>
| <code>void SetSoundVolume( float )</code>
| Set the current sound volume as a float 0 to 1.
|-
| <code>SetTrainingHasEverBeenStarted</code>
| <code>void SetTrainingHasEverBeenStarted()</code>
| Sets the convar true.
|-
| <code>SetTrainingHasEverFinished</code>
| <code>void SetTrainingHasEverFinished()</code>
| Sets the convar true.
|-
| <code>SetVisGroupVisible</code>
| <code>void SetVisGroupVisible( int, bool )</code>
| Set the specified visGroup to the specified state.
|-
| <code>SetXPForLevel</code>
| <code>void SetXPForLevel( int, int )</code>
| Sets the XP required for a player to get to a certain level
|-
| <code>ShowDLCStore</code>
| <code>void ShowDLCStore()</code>
| Opens the store for DLC
|-
| <code>ShowPlayerProfileCardForUID</code>
| <code>void ShowPlayerProfileCardForUID( string )</code>
| Brings up a player's profile card given that player's userId as a decimal string
|-
| <code>SmartGlass_SendEvent</code>
| <code>void SmartGlass_SendEvent( string, string, string, string )</code>
| Send an event to the SmartGlass device.
|-
| <code>SmartGlass_SetGameState</code>
| <code>void SmartGlass_SetGameState( string )</code>
| Set current SmartGlass game state, eg: MainMenu, PartyLobby, Lobby, Loading, InGame
|-
| <code>SmartGlass_SetGameStateProperty</code>
| <code>void SmartGlass_SetGameStateProperty( string, string )</code>
| Sets and remembers a property for the current game state. Property set is cleared automatically when game state changes. To clear a property pass a null value.
|-
| <code>SmartGlass_SetGlobalProperty</code>
| <code>void SmartGlass_SetGlobalProperty( string, string )</code>
| Sets and remembers a global property. Global properties are *not* cleared when game state changes. To clear a property pass a null value.
|-
| <code>SmartGlass_SetScriptVersion</code>
| <code>void SmartGlass_SetScriptVersion( int )</code>
| Set SmartGlass script version. Please call with a script version int on startup that you bump each time you change SmartGlass data sent from UI.
|-
| <code>SmartGlass_StartCountdown</code>
| <code>void SmartGlass_StartCountdown( string, float )</code>
| Start a named countdown until the specified time in the future.
|-
| <code>SmartGlass_StopCountdown</code>
| <code>void SmartGlass_StopCountdown( string )</code>
| Stop a named countdown.
|-
| <code>Smooth01</code>
| <code>float Smooth01( float )</code>
| Remap [0,1] to a cosine curved [0,1]
|-
| <code>SmoothCD</code>
| <code><unknown> SmoothCD( float, float, float, float, float )</code>
| Interpolate between values, preserving velocity (so it is smooth)
|-
| <code>SmoothCDVector</code>
| <code><unknown> SmoothCDVector( Vector, Vector, Vector, float, float )</code>
| Interpolate between values, preserving velocity (so it is smooth)
|-
| <code>SquirrelNativeFunctionTest</code>
| <code>string SquirrelNativeFunctionTest( string text, int a2, float a3, bool a4 )    ParameterMask:[.sifb]</code>
| Test registering and calling native function in Squirrel.
|-
| <code>StartMatchmaking</code>
| <code>void StartMatchmaking()</code>
| Start searching for a match
|-
| <code>StopMatchmaking</code>
| <code>void StopMatchmaking()</code>
| Start searching for a match
|-
| <code>StopUISound</code>
| <code>void StopUISound( string )</code>
| Stop a sound for the local client.
|-
| <code>StopVideo</code>
| <code>void StopVideo()</code>
| Stop fullscreen video currently playing
|-
| <code>Time</code>
| <code>float Time()</code>
| Get the current UI time
|-
| <code>TimerEnd</code>
| <code>float TimerEnd()</code>
| End the timer started with TimerStart.  Return milliseconds since TimerStart was called.  Only one Timer can be active at a time.
|-
| <code>TimerStart</code>
| <code>void TimerStart()</code>
| Start a timer.  Use TimerEnd to get the elapsed time.  Only one Timer can be active at a time.
|-
| <code>ToggleLookInvert</code>
| <code>void ToggleLookInvert()</code>
| Toggles the value of look invert (joy_inverty)
|-
| <code>TranslateTokenToUTF8</code>
| <code>string TranslateTokenToUTF8( string )</code>
| 
|-
| <code>TriggerBreakpoint</code>
| <code>void TriggerBreakpoint()</code>
| For debugging
|-
| <code>UpdateAddons</code>
| <code>int UpdateAddons( int index,bool enabled )    ParameterMask:[.ib]</code>
| Updates the selected addons
|-
| <code>VPKNotifyFile</code>
| <code>void VPKNotifyFile( string )</code>
| Tells the file system that a file at the exact path provided must exist in the currently loading VPK.
|-
| <code>VideoOptions_Apply</code>
| <code>void VideoOptions_Apply( handle )</code>
| Applies video options in menu; pass in video options menu
|-
| <code>VideoOptions_FillInCurrent</code>
| <code>void VideoOptions_FillInCurrent( handle )</code>
| Fills video options menu with current settings; pass in video options menu
|-
| <code>VideoOptions_RejectNewSettings</code>
| <code>void VideoOptions_RejectNewSettings( handle )</code>
| Rejects the new settings (for use after UICodeCallback_VideoSettingsChangedDialog)
|-
| <code>VideoOptions_ResetResolutionList</code>
| <code>void VideoOptions_ResetResolutionList( handle )</code>
| Resets the resolution list (for when the aspect ratio changes)
|-
| <code>VideoOptions_ResetToRecommended</code>
| <code>void VideoOptions_ResetToRecommended( handle )</code>
| Resets video options to recommended settings; pass in video options menu
|-
| <code>WaitingForLeader</code>
| <code>bool WaitingForLeader()</code>
| Returns true if the local player is waiting for party leader, eg. reservation is still active post dedi -> dedi hop.
|-
| <code>clamp</code>
| <code>float clamp( float, float, float )</code>
| Returns first parameter clamped between first and second parameter.
|}
=== CClientHudElement ===

==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>CClientHudElement::AddEventHandler</code>
| <code>void CClientHudElement::AddEventHandler( int, handle )</code>
| Adds a closure to handle an event such as UIE_CLICK
|-
| <code>CClientHudElement::ClearFriendlyVisibilityAlpha</code>
| <code>void CClientHudElement::ClearFriendlyVisibilityAlpha()</code>
| 
|-
| <code>CClientHudElement::ClearPulsate</code>
| <code>void CClientHudElement::ClearPulsate()</code>
| 
|-
| <code>CClientHudElement::ClearWorldOrigin</code>
| <code>void CClientHudElement::ClearWorldOrigin()</code>
| 
|-
| <code>CClientHudElement::ColorOverTime</code>
| <code> CClientHudElement::ColorOverTime( r, g, b, a, duration, [interpolator] )    ParameterMask:[.iiiin]</code>
| 
|-
| <code>CClientHudElement::ColorOverTimeDelayed</code>
| <code> CClientHudElement::ColorOverTimeDelayed( r, g, b, a, duration, delay, [interpolator] )    ParameterMask:[.iiiinn]</code>
| 
|-
| <code>CClientHudElement::Destroy</code>
| <code>void CClientHudElement::Destroy()</code>
| Destroy a hud element.
|-
| <code>CClientHudElement::DisableAutoText</code>
| <code>void CClientHudElement::DisableAutoText()</code>
| Disable the auto text updating
|-
| <code>CClientHudElement::DisableKeyBindingIcons</code>
| <code>void CClientHudElement::DisableKeyBindingIcons()</code>
| Disable replacing key bindings with the actual key
|-
| <code>CClientHudElement::EnableAutoText</code>
| <code>void CClientHudElement::EnableAutoText()</code>
| Enable the auto text updating
|-
| <code>CClientHudElement::EnableKeyBindingIcons</code>
| <code>void CClientHudElement::EnableKeyBindingIcons()</code>
| Enable replacing key bindings with the actual key
|-
| <code>CClientHudElement::FadeOverTime</code>
| <code> CClientHudElement::FadeOverTime( a, duration, [interpolator] )    ParameterMask:[.in]</code>
| 
|-
| <code>CClientHudElement::FadeOverTimeDelayed</code>
| <code> CClientHudElement::FadeOverTimeDelayed( a, duration, delay, [interpolator] )    ParameterMask:[.inn]</code>
| 
|-
| <code>CClientHudElement::GetAbsPos</code>
| <code><unknown> CClientHudElement::GetAbsPos()</code>
| 
|-
| <code>CClientHudElement::GetAbsX</code>
| <code>int CClientHudElement::GetAbsX()</code>
| 
|-
| <code>CClientHudElement::GetAbsY</code>
| <code>int CClientHudElement::GetAbsY()</code>
| 
|-
| <code>CClientHudElement::GetAlpha</code>
| <code>int CClientHudElement::GetAlpha()</code>
| 
|-
| <code>CClientHudElement::GetBarProgress</code>
| <code>float CClientHudElement::GetBarProgress()</code>
| 
|-
| <code>CClientHudElement::GetBaseAlpha</code>
| <code>int CClientHudElement::GetBaseAlpha()</code>
| 
|-
| <code>CClientHudElement::GetBaseColor</code>
| <code><unknown> CClientHudElement::GetBaseColor()</code>
| 
|-
| <code>CClientHudElement::GetBaseHeight</code>
| <code>int CClientHudElement::GetBaseHeight()</code>
| 
|-
| <code>CClientHudElement::GetBasePos</code>
| <code><unknown> CClientHudElement::GetBasePos()</code>
| 
|-
| <code>CClientHudElement::GetBaseSize</code>
| <code><unknown> CClientHudElement::GetBaseSize()</code>
| 
|-
| <code>CClientHudElement::GetBaseWidth</code>
| <code>int CClientHudElement::GetBaseWidth()</code>
| 
|-
| <code>CClientHudElement::GetBaseX</code>
| <code>int CClientHudElement::GetBaseX()</code>
| 
|-
| <code>CClientHudElement::GetBaseY</code>
| <code>int CClientHudElement::GetBaseY()</code>
| 
|-
| <code>CClientHudElement::GetChild</code>
| <code>handle CClientHudElement::GetChild( string )</code>
| Gets a child HUD element (for use with CNestedPanel)
|-
| <code>CClientHudElement::GetColor</code>
| <code><unknown> CClientHudElement::GetColor()</code>
| Gets the color of an element as an array with four elements (red, green, blue, alpha).
|-
| <code>CClientHudElement::GetHeight</code>
| <code>int CClientHudElement::GetHeight()</code>
| 
|-
| <code>CClientHudElement::GetListItem</code>
| <code>handle CClientHudElement::GetListItem( int )</code>
| 
|-
| <code>CClientHudElement::GetListSelectedItem</code>
| <code>handle CClientHudElement::GetListSelectedItem()</code>
| 
|-
| <code>CClientHudElement::GetListSize</code>
| <code>int CClientHudElement::GetListSize()</code>
| 
|-
| <code>CClientHudElement::GetName</code>
| <code>string CClientHudElement::GetName()</code>
| 
|-
| <code>CClientHudElement::GetPanelAlpha</code>
| <code>int CClientHudElement::GetPanelAlpha()</code>
| 
|-
| <code>CClientHudElement::GetParent</code>
| <code>handle CClientHudElement::GetParent()</code>
| Gets the parent HUD element
|-
| <code>CClientHudElement::GetPos</code>
| <code><unknown> CClientHudElement::GetPos()</code>
| Get the position of the given hud element, as an array with two elements.
|-
| <code>CClientHudElement::GetRotation</code>
| <code>float CClientHudElement::GetRotation()</code>
| Get the rotation of the given hud element.
|-
| <code>CClientHudElement::GetScaleX</code>
| <code>float CClientHudElement::GetScaleX()</code>
| 
|-
| <code>CClientHudElement::GetScaleY</code>
| <code>float CClientHudElement::GetScaleY()</code>
| 
|-
| <code>CClientHudElement::GetScriptID</code>
| <code>string CClientHudElement::GetScriptID()</code>
| 
|-
| <code>CClientHudElement::GetSize</code>
| <code><unknown> CClientHudElement::GetSize()</code>
| Get the size of the given hud element, as an array with two elements.
|-
| <code>CClientHudElement::GetTextEntryUTF8Text</code>
| <code>string CClientHudElement::GetTextEntryUTF8Text()</code>
| 
|-
| <code>CClientHudElement::GetTextWidth</code>
| <code>int CClientHudElement::GetTextWidth()</code>
| Get the estimated drawn width of this label.
|-
| <code>CClientHudElement::GetVisGroupID</code>
| <code>int CClientHudElement::GetVisGroupID()</code>
| 
|-
| <code>CClientHudElement::GetWidth</code>
| <code>int CClientHudElement::GetWidth()</code>
| 
|-
| <code>CClientHudElement::GetX</code>
| <code>int CClientHudElement::GetX()</code>
| 
|-
| <code>CClientHudElement::GetY</code>
| <code>int CClientHudElement::GetY()</code>
| 
|-
| <code>CClientHudElement::HasChild</code>
| <code>bool CClientHudElement::HasChild( string )</code>
| Checks if a child HUD element for a given name exists
|-
| <code>CClientHudElement::Hide</code>
| <code>void CClientHudElement::Hide()</code>
| Hide a hud element.
|-
| <code>CClientHudElement::HideOverTime</code>
| <code> CClientHudElement::HideOverTime( duration, [interpolator] )    ParameterMask:[.n]</code>
| 
|-
| <code>CClientHudElement::HudElement</code>
| <code>handle CClientHudElement::HudElement( string )</code>
| Gets a child HUD element (for use with CNestedPanel)
|-
| <code>CClientHudElement::IsAutoText</code>
| <code>bool CClientHudElement::IsAutoText()</code>
| Returns true if an auto text has been set for it and it is enabled
|-
| <code>CClientHudElement::IsEnabled</code>
| <code>bool CClientHudElement::IsEnabled()</code>
| Returns whether the element is enabled (can be interacted with)
|-
| <code>CClientHudElement::IsFocused</code>
| <code>bool CClientHudElement::IsFocused()</code>
| Returns whether the element has focus
|-
| <code>CClientHudElement::IsLabel</code>
| <code>bool CClientHudElement::IsLabel()</code>
| 
|-
| <code>CClientHudElement::IsLocked</code>
| <code>bool CClientHudElement::IsLocked()</code>
| 
|-
| <code>CClientHudElement::IsNew</code>
| <code>bool CClientHudElement::IsNew()</code>
| 
|-
| <code>CClientHudElement::IsOnScreen</code>
| <code>bool CClientHudElement::IsOnScreen()</code>
| 
|-
| <code>CClientHudElement::IsSelected</code>
| <code>bool CClientHudElement::IsSelected()</code>
| 
|-
| <code>CClientHudElement::IsVisible</code>
| <code>bool CClientHudElement::IsVisible()</code>
| Returns whether the given hud element is currently visible.
|-
| <code>CClientHudElement::MoveOverTime</code>
| <code> CClientHudElement::MoveOverTime( x, y, duration, [interpolator] )    ParameterMask:[.nnn]</code>
| 
|-
| <code>CClientHudElement::OffsetOverTime</code>
| <code> CClientHudElement::OffsetOverTime( x, y, duration, [interpolator] )    ParameterMask:[.nnn]</code>
| 
|-
| <code>CClientHudElement::OffsetX</code>
| <code>void CClientHudElement::OffsetX( int )</code>
| 
|-
| <code>CClientHudElement::OffsetXOverTime</code>
| <code> CClientHudElement::OffsetXOverTime( x, duration, [interpolator] )    ParameterMask:[.nn]</code>
| 
|-
| <code>CClientHudElement::OffsetY</code>
| <code>void CClientHudElement::OffsetY( int )</code>
| 
|-
| <code>CClientHudElement::OffsetYOverTime</code>
| <code> CClientHudElement::OffsetYOverTime( y, duration, [interpolator] )    ParameterMask:[.nn]</code>
| 
|-
| <code>CClientHudElement::RemoveEventHandler</code>
| <code>void CClientHudElement::RemoveEventHandler( int, handle )</code>
| Removes a closure that was set to handle an event
|-
| <code>CClientHudElement::ReturnToBaseColor</code>
| <code>void CClientHudElement::ReturnToBaseColor()</code>
| 
|-
| <code>CClientHudElement::ReturnToBasePos</code>
| <code>void CClientHudElement::ReturnToBasePos()</code>
| 
|-
| <code>CClientHudElement::ReturnToBasePosOverTime</code>
| <code>void CClientHudElement::ReturnToBasePosOverTime( float, int )</code>
| 
|-
| <code>CClientHudElement::ReturnToBaseScaleOverTime</code>
| <code>void CClientHudElement::ReturnToBaseScaleOverTime( float, int )</code>
| 
|-
| <code>CClientHudElement::ReturnToBaseSize</code>
| <code>void CClientHudElement::ReturnToBaseSize()</code>
| 
|-
| <code>CClientHudElement::RunAnimationCommand</code>
| <code>void CClientHudElement::RunAnimationCommand( string, float, float, float, int, float )</code>
| 
|-
| <code>CClientHudElement::RunAnimationScript</code>
| <code>void CClientHudElement::RunAnimationScript( string )</code>
| 
|-
| <code>CClientHudElement::ScaleOverTime</code>
| <code> CClientHudElement::ScaleOverTime( wScale, hScale, duration, [interpolator] )    ParameterMask:[.nnn]</code>
| 
|-
| <code>CClientHudElement::SelectAll</code>
| <code>void CClientHudElement::SelectAll()</code>
| 
|-
| <code>CClientHudElement::SetADSFade</code>
| <code>void CClientHudElement::SetADSFade( float, float, float, float )</code>
| 
|-
| <code>CClientHudElement::SetAlpha</code>
| <code>void CClientHudElement::SetAlpha( int )</code>
| 
|-
| <code>CClientHudElement::SetAutoText</code>
| <code>void CClientHudElement::SetAutoText( string, int, float )</code>
| Set the auto text settings for this HUD element
|-
| <code>CClientHudElement::SetAutoTextCountTo</code>
| <code>void CClientHudElement::SetAutoTextCountTo( string, float, float, float )</code>
| Set the auto text settings for this HUD element. ( localization token, HATT type, start value, end value, transition time )
|-
| <code>CClientHudElement::SetAutoTextVector</code>
| <code>void CClientHudElement::SetAutoTextVector( string, int, Vector )</code>
| Set the auto text settings for this HUD element
|-
| <code>CClientHudElement::SetAutoTextWithAlternates</code>
| <code>void CClientHudElement::SetAutoTextWithAlternates( string, string, string, int, float )</code>
| Set the auto text settings for this HUD element
|-
| <code>CClientHudElement::SetBarChangeDir</code>
| <code>void CClientHudElement::SetBarChangeDir( int )</code>
| 
|-
| <code>CClientHudElement::SetBarChangeDuration</code>
| <code>void CClientHudElement::SetBarChangeDuration( float )</code>
| 
|-
| <code>CClientHudElement::SetBarChangeStyle</code>
| <code>void CClientHudElement::SetBarChangeStyle( int )</code>
| 
|-
| <code>CClientHudElement::SetBarInset</code>
| <code>void CClientHudElement::SetBarInset( int )</code>
| 
|-
| <code>CClientHudElement::SetBarMargin</code>
| <code>void CClientHudElement::SetBarMargin( int )</code>
| 
|-
| <code>CClientHudElement::SetBarProgress</code>
| <code>void CClientHudElement::SetBarProgress( float )</code>
| 
|-
| <code>CClientHudElement::SetBarProgressAndRate</code>
| <code>void CClientHudElement::SetBarProgressAndRate( float, float )</code>
| 
|-
| <code>CClientHudElement::SetBarProgressDirection</code>
| <code>void CClientHudElement::SetBarProgressDirection( int )</code>
| 
|-
| <code>CClientHudElement::SetBarProgressOverTime</code>
| <code>void CClientHudElement::SetBarProgressOverTime( float, float, float )</code>
| 
|-
| <code>CClientHudElement::SetBarProgressRemap</code>
| <code>void CClientHudElement::SetBarProgressRemap( float, float, float, float )</code>
| 
|-
| <code>CClientHudElement::SetBarProgressSource</code>
| <code>void CClientHudElement::SetBarProgressSource( int )</code>
| 
|-
| <code>CClientHudElement::SetBarProgressSourceEntity</code>
| <code>void CClientHudElement::SetBarProgressSourceEntity( handle )</code>
| 
|-
| <code>CClientHudElement::SetBarSegmentFill</code>
| <code>void CClientHudElement::SetBarSegmentFill( int )</code>
| 
|-
| <code>CClientHudElement::SetBarSegmentInfo</code>
| <code>void CClientHudElement::SetBarSegmentInfo( int, int )</code>
| 
|-
| <code>CClientHudElement::SetBaseAlpha</code>
| <code>void CClientHudElement::SetBaseAlpha( int )</code>
| 
|-
| <code>CClientHudElement::SetBaseColor</code>
| <code>void CClientHudElement::SetBaseColor( int, int, int, int )</code>
| 
|-
| <code>CClientHudElement::SetBasePos</code>
| <code>void CClientHudElement::SetBasePos( int, int )</code>
| 
|-
| <code>CClientHudElement::SetBaseSize</code>
| <code>void CClientHudElement::SetBaseSize( int, int )</code>
| 
|-
| <code>CClientHudElement::SetClampBounds</code>
| <code>void CClientHudElement::SetClampBounds( float, float )</code>
| 
|-
| <code>CClientHudElement::SetClampToScreen</code>
| <code>void CClientHudElement::SetClampToScreen( int )</code>
| 
|-
| <code>CClientHudElement::SetColor</code>
| <code> CClientHudElement::SetColor()    ParameterMask:[..]</code>
| Sets the color of an element with components (red, green, blue, alpha) given as 0-255 values.
|-
| <code>CClientHudElement::SetColorBG</code>
| <code> CClientHudElement::SetColorBG()    ParameterMask:[..]</code>
| Sets the background color of an element with components (red, green, blue, alpha) given as 0-255 values.
|-
| <code>CClientHudElement::SetDistanceFade</code>
| <code>void CClientHudElement::SetDistanceFade( float, float, float, float )</code>
| 
|-
| <code>CClientHudElement::SetEnabled</code>
| <code>void CClientHudElement::SetEnabled( bool )</code>
| Sets whether the element is enabled (can be interacted with)
|-
| <code>CClientHudElement::SetEntity</code>
| <code>void CClientHudElement::SetEntity( handle, Vector, float, float )</code>
| 
|-
| <code>CClientHudElement::SetEntityOverhead</code>
| <code>void CClientHudElement::SetEntityOverhead( handle, Vector, float, float )</code>
| 
|-
| <code>CClientHudElement::SetFOVFade</code>
| <code>void CClientHudElement::SetFOVFade( float, float, float, float )</code>
| 
|-
| <code>CClientHudElement::SetFocused</code>
| <code>bool CClientHudElement::SetFocused()</code>
| Gives the element focus
|-
| <code>CClientHudElement::SetHeight</code>
| <code>void CClientHudElement::SetHeight( int )</code>
| Set the height of the given hud element.
|-
| <code>CClientHudElement::SetHideOnEntityOverheadCloak</code>
| <code>void CClientHudElement::SetHideOnEntityOverheadCloak( bool )</code>
| 
|-
| <code>CClientHudElement::SetImage</code>
| <code>void CClientHudElement::SetImage( string )</code>
| Set the image of an imagePanel element.
|-
| <code>CClientHudElement::SetKeyBindingIconScale</code>
| <code>void CClientHudElement::SetKeyBindingIconScale( float )</code>
| Scale key binding icon sizes by this amount
|-
| <code>CClientHudElement::SetLabelImage</code>
| <code>void CClientHudElement::SetLabelImage( string, bool )</code>
| Sets an image in the label on the left side, or right side if the second parameter is true.
|-
| <code>CClientHudElement::SetLocked</code>
| <code>void CClientHudElement::SetLocked( bool )</code>
| 
|-
| <code>CClientHudElement::SetNew</code>
| <code>void CClientHudElement::SetNew( bool )</code>
| 
|-
| <code>CClientHudElement::SetOffscreenArrow</code>
| <code>void CClientHudElement::SetOffscreenArrow( bool )</code>
| 
|-
| <code>CClientHudElement::SetOrigin</code>
| <code>void CClientHudElement::SetOrigin( Vector )</code>
| 
|-
| <code>CClientHudElement::SetPanelAlpha</code>
| <code>void CClientHudElement::SetPanelAlpha( int )</code>
| 
|-
| <code>CClientHudElement::SetPinSibling</code>
| <code>void CClientHudElement::SetPinSibling( string )</code>
| Sets the pin sibling by name
|-
| <code>CClientHudElement::SetPos</code>
| <code>void CClientHudElement::SetPos( int, int )</code>
| Set the position of the given hud element.
|-
| <code>CClientHudElement::SetPulsate</code>
| <code>void CClientHudElement::SetPulsate( float, float, float )</code>
| 
|-
| <code>CClientHudElement::SetRotation</code>
| <code>void CClientHudElement::SetRotation( float )</code>
| Set the rotation of the given hud element.
|-
| <code>CClientHudElement::SetScale</code>
| <code>void CClientHudElement::SetScale( float, float )</code>
| 
|-
| <code>CClientHudElement::SetScaleX</code>
| <code>void CClientHudElement::SetScaleX( float )</code>
| 
|-
| <code>CClientHudElement::SetScaleY</code>
| <code>void CClientHudElement::SetScaleY( float )</code>
| 
|-
| <code>CClientHudElement::SetSelected</code>
| <code>void CClientHudElement::SetSelected( bool )</code>
| 
|-
| <code>CClientHudElement::SetSize</code>
| <code>void CClientHudElement::SetSize( int, int )</code>
| Set the size of the given hud element.
|-
| <code>CClientHudElement::SetText</code>
| <code> CClientHudElement::SetText( index, string, [param1, param2, param3...] )    ParameterMask:[.s]</code>
| Set the text of a label element. Optional parameters for localized-string '%s1'-type format vars.
|-
| <code>CClientHudElement::SetTextTypeWriter</code>
| <code>void CClientHudElement::SetTextTypeWriter( string, float )</code>
| 
|-
| <code>CClientHudElement::SetUTF8Text</code>
| <code>void CClientHudElement::SetUTF8Text( string )</code>
| 
|-
| <code>CClientHudElement::SetVisGroupID</code>
| <code>void CClientHudElement::SetVisGroupID( int )</code>
| 
|-
| <code>CClientHudElement::SetVisible</code>
| <code>void CClientHudElement::SetVisible( bool )</code>
| Set visibility of a hud element.
|-
| <code>CClientHudElement::SetWidth</code>
| <code>void CClientHudElement::SetWidth( int )</code>
| Set the width of the given hud element.
|-
| <code>CClientHudElement::SetWorldSpaceScale</code>
| <code>void CClientHudElement::SetWorldSpaceScale( float, float, float, float )</code>
| 
|-
| <code>CClientHudElement::SetX</code>
| <code>void CClientHudElement::SetX( int )</code>
| 
|-
| <code>CClientHudElement::SetXOverTime</code>
| <code> CClientHudElement::SetXOverTime( x, duration, [interpolator] )    ParameterMask:[.nn]</code>
| 
|-
| <code>CClientHudElement::SetY</code>
| <code>void CClientHudElement::SetY( int )</code>
| 
|-
| <code>CClientHudElement::SetYOverTime</code>
| <code> CClientHudElement::SetYOverTime( y, duration, [interpolator] )    ParameterMask:[.nn]</code>
| 
|-
| <code>CClientHudElement::SetZ</code>
| <code>void CClientHudElement::SetZ( int )</code>
| Set the Z position of the given hud element.
|-
| <code>CClientHudElement::Show</code>
| <code>void CClientHudElement::Show()</code>
| Reveal a hud element.
|-
| <code>CClientHudElement::UpdateVisibility</code>
| <code>void CClientHudElement::UpdateVisibility()</code>
| Refresh the visibility a hud element.
|-
| <code>CClientHudElement::UseFriendlyVisibilityAlpha</code>
| <code>void CClientHudElement::UseFriendlyVisibilityAlpha( float )</code>
| 
|-
| <code>CClientHudElement::WarpDisable</code>
| <code>void CClientHudElement::WarpDisable()</code>
| Disable spherical warp distortion.
|-
| <code>CClientHudElement::WarpEnable</code>
| <code>void CClientHudElement::WarpEnable()</code>
| Enable spherical warp distortion.
|}

== See also ==
* [[VScript]]
* [[VScript Fundamentals]]
* {{sq}} [[Squirrel]]
* {{p2}} [[List of Portal 2 Script Functions]]
* {{titanfall}} [[Titanfall/Scripting/Server Script Functions|List of Server Script Functions]]
* {{titanfall}} [[Titanfall/Scripting/Client Script Functions|List of Client Script Functions]]