Titanfall/Scripting/UI Script Functions

From Valve Developer Community
Jump to navigation Jump to search

Automatically generated Squirrel functions list for Titanfall Titanfall (R1Delta). These functions are only present in the UI Squirrel VM

Classes

:: (Global functions)

Methods

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

CClientHudElement

Methods

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

See also