Difference between revisions of "User:Tet"

From Valve Developer Community
Jump to: navigation, search
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{|
+
|-
 
| RandomInt
 
| RandomInt
 
| <code>int RandomInt( int, int )</code>
 
| <code>int RandomInt( int, int )</code>
Line 15: Line 15:
 
| <code>bool RollPercentage( int )</code>
 
| <code>bool RollPercentage( int )</code>
 
| Rolls a number from 1 to 100 and returns true if the roll is less than or equal to the number specified
 
| Rolls a number from 1 to 100 and returns true if the roll is less than or equal to the number specified
|}
+
 
 
=== CScriptParticleManager ===
 
=== CScriptParticleManager ===
 
''!Used to create and manage particle effects''
 
''!Used to create and manage particle effects''
Line 39: Line 39:
 
| <code>void ReleaseParticleIndex( int )</code>
 
| <code>void ReleaseParticleIndex( int )</code>
 
| Frees the specified particle index
 
| Frees the specified particle index
 +
|}
 +
 
|-
 
|-
 
| DoIncludeScript
 
| DoIncludeScript
 
| <code>bool DoIncludeScript( cstring, hscript )</code>
 
| <code>bool DoIncludeScript( cstring, hscript )</code>
 
| Execute a script (internal)
 
| Execute a script (internal)
|}
 
  
 
=== CEntityScriptFramework ===
 
=== CEntityScriptFramework ===
 
''C-side of entity framework''
 
''C-side of entity framework''
 +
 +
 +
=== CEntities ===
 +
''!The global list of entities''
  
 
{| class="standard-table" style="width: 100;"
 
{| class="standard-table" style="width: 100;"
Line 53: Line 58:
 
! Description
 
! Description
 
|-
 
|-
| ShowMessage
+
| First
| <code>void ShowMessage( cstring )</code>
+
| <code>hscript First()</code>
| Print a hud message on all clients
+
| Begin an iteration over the list of entities
 
|-
 
|-
| GetMapName
+
| Next
| <code>cstring GetMapName()</code>
+
| <code>hscript Next( hscript )</code>
| Get the name of the map.
+
| Continue an iteration over the list of entities, providing reference to a previously found entity
 
|-
 
|-
| SendToConsole
+
| CreateByClassname
| <code>void SendToConsole( cstring )</code>
+
| <code>hscript CreateByClassname( cstring )</code>
| Send a string to the console as a client command
+
| Creates an entity by classname
 
|-
 
|-
| SendToServerConsole
+
| FindByClassname
| <code>void SendToServerConsole( cstring )</code>
+
| <code>hscript FindByClassname( hscript, cstring )</code>
| Send a string to the console as a server command
+
| Find entities by class name. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search
 
|-
 
|-
| PrintLinkedConsoleMessage
+
| FindAllByClassname
| <code>void PrintLinkedConsoleMessage( cstring, cstring )</code>
+
| <code>variant FindAllByClassname( cstring )</code>
| Print a console message with a linked console command
+
| Find entities by class name.
 
|-
 
|-
| InitLogFile
+
| FindByName
| <code>void InitLogFile( cstring, cstring )</code>
+
| <code>hscript FindByName( hscript, cstring )</code>
| If the given file doesn't exist, creates it with the given contents; does nothing if it exists
+
| Find entities by name. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search
 
|-
 
|-
| AppendToLogFile
+
| FindAllByName
| <code>void AppendToLogFile( cstring, cstring )</code>
+
| <code>variant FindAllByName( cstring )</code>
| Appends a string to a log file on the server
+
| Find entities by name; returns an array of everything found.
 
|-
 
|-
| GetWorldMinX
+
| FindInSphere
| <code>float GetWorldMinX()</code>
+
| <code>hscript FindInSphere( hscript, vector, float )</code>
| Gets the world's minimum X position.
+
| Find entities within a radius. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search
 
|-
 
|-
| GetWorldMinY
+
| FindAllInSphere
| <code>float GetWorldMinY()</code>
+
| <code>variant FindAllInSphere( vector, float )</code>
| Gets the world's maximum Y position.
+
| Find entities within a radius.
 
|-
 
|-
| GetWorldMaxX
+
| FindByTarget
| <code>float GetWorldMaxX()</code>
+
| <code>hscript FindByTarget( hscript, cstring )</code>
| Gets the world's minimum X position.
+
| Find entities by targetname. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search
 
|-
 
|-
| GetWorldMaxY
+
| FindAllByTarget
| <code>float GetWorldMaxY()</code>
+
| <code>variant FindAllByTarget( cstring )</code>
| Gets the world's maximum Y position.
+
| Find entities by targetname.
 
|-
 
|-
| Time
+
| FindByModel
| <code>float Time()</code>
+
| <code>hscript FindByModel( hscript, cstring )</code>
| Get the current server time
+
| Find entities by model name. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search
 
|-
 
|-
| GetSystemTime
+
| FindAllByModel
| <code>cstring GetSystemTime()</code>
+
| <code>variant FindAllByModel( cstring )</code>
| Get the current real world time
+
| Find entities by model name.
 
|-
 
|-
| GetSystemDate
+
| FindByNameNearest
| <code>cstring GetSystemDate()</code>
+
| <code>hscript FindByNameNearest( cstring, vector, float )</code>
| Get the current real world date
+
| Find entities by name nearest to a point.
 
|-
 
|-
| UTIL_RemoveImmediate
+
| FindByNameWithin
| <code>void UTIL_RemoveImmediate( hscript )</code>
+
| <code>hscript FindByNameWithin( hscript, cstring, vector, float )</code>
| Immediately removes the specified entity
+
| Find entities by name within a radius. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search
 
|-
 
|-
| DoEntFire
+
| FindAllByNameWithin
| <code>void DoEntFire( cstring, cstring, cstring, float, hscript, hscript )</code>
+
| <code>variant FindAllByNameWithin( cstring, vector, float )</code>
| #EntFire:Generate and entity i/o event
+
| Find entities by name within a radius.
 
|-
 
|-
| EntFireByHandle
+
| FindByClassnameNearest
| <code>void EntFireByHandle( hscript, cstring, cstring, float, hscript, hscript )</code>
+
| <code>hscript FindByClassnameNearest( cstring, vector, float )</code>
| Generate and entity i/o event
+
| Find entities by class name nearest to a point.
 
|-
 
|-
| IsValidEntity
+
| FindByClassnameWithin
| <code>bool IsValidEntity( hscript )</code>
+
| <code>hscript FindByClassnameWithin( hscript, cstring, vector, float )</code>
| Checks to see if the given hScript is a valid entity
+
| Find entities by class name within a radius. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search
 
|-
 
|-
| IsMarkedForDeletion
+
| FindAllByClassnameWithin
| <code>bool IsMarkedForDeletion( hscript )</code>
+
| <code>variant FindAllByClassnameWithin( cstring, vector, float )</code>
| Returns true if the entity is valid and marked for deletion.
+
| Find entities by class name within a radius.
|-
+
|}
| DoUniqueString
+
 
| <code>cstring DoUniqueString( cstring )</code>
+
 
| #UniqueString:Generate a string guaranteed to be unique across the life of the script VM, with an optional root string. Useful for adding data to tables when not sure what keys are already in use in that table.
+
=== Convars ===
 +
''!Access to convar functions''
 +
 
 +
{| class="standard-table" style="width: 100;"
 +
! Function
 +
! Signature
 +
! Description
 
|-
 
|-
| ListenToGameEvent
+
| GetFloat
| <code>int ListenToGameEvent( cstring, hscript, hscript )</code>
+
| <code>variant GetFloat( cstring )</code>
| Register as a listener for a game event from script.
+
| GetFloat(name) : returns the convar as a float. May return null if no such convar.
 
|-
 
|-
| StopListeningToGameEvent
+
| GetStr
| <code>bool StopListeningToGameEvent( int )</code>
+
| <code>variant GetStr( cstring )</code>
| Stop listening to a particular game event.
+
| GetFloat(name) : returns the convar as a string. May return null if no such convar.
 
|-
 
|-
| FireGameEvent
+
| GetBool
| <code>void FireGameEvent( cstring, hscript )</code>
+
| <code>variant GetBool( cstring )</code>
| Fire a game event.
+
| GetBool(name) : returns the convar as a boolean flag.
 
|-
 
|-
| FireGameEventLocal
+
| RegisterCommand
| <code>void FireGameEventLocal( cstring, hscript )</code>
+
| <code>void RegisterCommand( cstring, hscript, cstring, int )</code>
| Fire a game event without broadcasting to the client.
+
| RegisterCommand(name, fn, helpString, flags) : register a console command.
 
|-
 
|-
| PauseGame
+
| RegisterConvar
| <code>void PauseGame( bool )</code>
+
| <code>void RegisterConvar( cstring, cstring, cstring, int )</code>
| Pause or unpause the game.
+
| RegisterConvar(name, defaultValue, helpString, flags): register a new console variable.
 
|-
 
|-
| EntIndexToHScript
+
| GetCommandClient
| <code>hscript EntIndexToHScript( int )</code>
+
| <code>hscript GetCommandClient()</code>
| Turn an entity index integer to an HScript representing that entity's script instance.
+
| GetCommandClient() : returns the player who issued this console command.
 
|-
 
|-
| PlayerInstanceFromIndex
+
| GetDOTACommandClient
| <code>hscript PlayerInstanceFromIndex( int )</code>
+
| <code>hscript GetDOTACommandClient()</code>
| Get a script instance of a player by index.
+
| GetDOTACommandClient() : returns the DOTA player who issued this console command.
 +
|}
 +
 
 +
 
 +
=== CScriptHeroList ===
 +
''!The global list of heroes''
 +
 
 +
{| class="standard-table" style="width: 100;"
 +
! Function
 +
! Signature
 +
! Description
 
|-
 
|-
| GetListenServerHost
+
| GetHero
| <code>hscript GetListenServerHost()</code>
+
| <code>hscript GetHero( int )</code>
| Get the local player on a listen server.
+
| Get the Nth hero in the Hero List
 
|-
 
|-
| ScreenShake
+
| GetHeroCount
| <code>void ScreenShake( vector, float, float, float, float, int, bool )</code>
+
| <code>int GetHeroCount()</code>
| Start a screenshake with the following parameters. vecCenter, flAmplitude, flFrequency, flDuration, flRadius, eCommand( SHAKE_START = 0, SHAKE_STOP = 1 ), bAirShake
+
| Returns the number of heroes in the world
 
|-
 
|-
| SpawnEntityFromTable
+
| GetAllHeroes
| <code>bool SpawnEntityFromTable( cstring, hscript, hscript, hscript, hscript )</code>
+
| <code>variant GetAllHeroes()</code>
| Spawns a single entity from a table
+
| Returns all the heroes in the world
 +
|}
 +
 
 +
 
 +
=== CDOTAGamerules ===
 +
''!DOTA GameRules''
 +
 
 +
{| class="standard-table" style="width: 100;"
 +
! Function
 +
! Signature
 +
! Description
 
|-
 
|-
| SpawnEntityFromTableSync
+
| State_Get
| <code>hscript SpawnEntityFromTableSync( cstring, hscript )</code>
+
| <code>unknown_variant_type State_Get()</code>
| Spawns a single entity from a table
+
| Get the current Gamerules state
 
|-
 
|-
| SpawnEntityGroupFromTable
+
| GetGameTime
| <code>bool SpawnEntityGroupFromTable( hscript, bool, hscript )</code>
+
| <code>float GetGameTime()</code>
| Hierarchically spawn an entity group from a set of spawn tables.
+
| Returns the number of seconds elapsed since map start. This time doesn't count up when the game is paused
 
|-
 
|-
| PrecacheEntityFromTable
+
| GetDifficulty
| <code>bool PrecacheEntityFromTable( hscript )</code>
+
| <code>int GetDifficulty()</code>
| Precache an entity from KeyValues in table
+
| Returns difficulty level of the custom game mode
 
|-
 
|-
| PrecacheResource
+
| GetCustomGameDifficulty
| <code>void PrecacheResource( cstring, cstring )</code>
+
| <code>int GetCustomGameDifficulty()</code>
| Manually precache a single resource
+
| Returns the difficulty level of the custom game mode
 
|-
 
|-
| VectorToAngles
+
| Defeated
| <code>qangle VectorToAngles( vector )</code>
+
| <code>void Defeated()</code>
| Get Qangles (with no roll) for a Vector.
+
| Kills the ancient, etc.
 
|-
 
|-
| RotatePosition
+
| ResetDefeated
| <code>vector RotatePosition( vector, qangle, vector )</code>
+
| <code>void ResetDefeated()</code>
| Rotate a Vector around a point.
+
| Restart after killing the ancient, etc.
 
|-
 
|-
| RotateOrientation
+
| SetGameWinner
| <code>qangle RotateOrientation( qangle, qangle )</code>
+
| <code>void SetGameWinner( int )</code>
| Rotate a QAngle by another QAngle.
+
| Makes ths specified team win
 
|-
 
|-
| RotationDelta
+
| MakeTeamLose
| <code>qangle RotationDelta( qangle, qangle )</code>
+
| <code>void MakeTeamLose( int )</code>
| Find the delta between two angles.
+
| Makes ths specified team lose
 
|-
 
|-
| EmitSoundOn
+
| ResetMap
| <code>void EmitSoundOn( cstring, hscript )</code>
+
| <code>void ResetMap( int )</code>
| Play named sound on Entity
+
| Resets the map in one of several ways
 
|-
 
|-
| EmitSoundOnClient
+
| GetDroppedItem
| <code>void EmitSoundOnClient( cstring, hscript )</code>
+
| <code>hscript GetDroppedItem( int )</code>
| Play named sound only on the client for the passed in player
+
| Gets the Xth dropped item
 
|-
 
|-
| EmitGlobalSound
+
| NumDroppedItems
| <code>void EmitGlobalSound( cstring )</code>
+
| <code>int NumDroppedItems()</code>
| Play named sound for all players
+
| Returns the number of items currently dropped on the ground
 
|-
 
|-
| StopSoundOn
+
| SendCustomMessage
| <code>void StopSoundOn( cstring, hscript )</code>
+
| <code>void SendCustomMessage( cstring, int, int )</code>
| Stop named sound on Entity
+
| Sends a string to the defined team.
 
|-
 
|-
| GetPhysVelocity
+
| SetHeroRespawnEnabled
| <code>vector GetPhysVelocity( hscript )</code>
+
| <code>void SetHeroRespawnEnabled( bool )</code>
| Get Velocity for VPHYS or normal object
+
| Control if the normal DOTA hero respawn rules apply.
 
|-
 
|-
| GetPhysAngularVelocity
+
| Playtesting_UpdateCustomKeyValues
| <code>vector GetPhysAngularVelocity( hscript )</code>
+
| <code>void Playtesting_UpdateCustomKeyValues()</code>
| Get Angular Velocity for VPHYS or normal object
+
| Updates custom hero, unit and ability KeyValues in memory with the latest values from disk
 
|-
 
|-
| Say
+
| ResetToHeroSelection
| <code>void Say( hscript, cstring, bool )</code>
+
| <code>void ResetToHeroSelection()</code>
| Have Entity say string, and teamOnly or not
+
| Restart the game at hero selection
 
|-
 
|-
| AddThinkToEnt
+
| SetTreeRegrowTime
| <code>void AddThinkToEnt( hscript, cstring )</code>
+
| <code>void SetTreeRegrowTime( float )</code>
| Adds a late bound think function to the C++ think tables for the obj
+
| Sets the tree regrow time in seconds.
 
|-
 
|-
| LoadKeyValues
+
| SetHeroSelectionTime
| <code>variant LoadKeyValues( cstring )</code>
+
| <code>void SetHeroSelectionTime( float )</code>
| Creates a table from the specified keyvalues text file
+
| Sets the amount of time players have to pick their hero.
 
|-
 
|-
| LoadKeyValuesFromString
+
| SetPreGameTime
| <code>variant LoadKeyValuesFromString( cstring )</code>
+
| <code>void SetPreGameTime( float )</code>
| Creates a table from the specified keyvalues string
+
| Sets the amount of time players have between picking their hero and game start.
 
|-
 
|-
| DebugDrawScreenTextLine
+
| SetPostGameTime
| <code>void DebugDrawScreenTextLine( float, float, int, cstring, int, int, int, int, float )</code>
+
| <code>void SetPostGameTime( float )</code>
| Draw text with a line offset (x, y, lineOffset, text, r, g, b, a, duration)
+
| Sets the amount of time players have between the game ending and the server disconnecting them.
 
|-
 
|-
| DebugDrawText
+
| SetRuneSpawnTime
| <code>void DebugDrawText( vector, cstring, bool, float )</code>
+
| <code>void SetRuneSpawnTime( float )</code>
| Draw text in 3d (origin, text, bViewCheck, duration)
+
| Sets the amount of time between rune spawns.
 
|-
 
|-
| DebugDrawBox
+
| SetSameHeroSelectionEnabled
| <code>void DebugDrawBox( vector, vector, vector, int, int, int, int, float )</code>
+
| <code>void SetSameHeroSelectionEnabled( bool )</code>
| Draw a debug overlay box (origin, mins, maxs, forward, r, g, b, a, duration )
+
| When true, players can repeatedly pick the same hero.
 
|-
 
|-
| DebugDrawLine
+
| SetUseUniversalShopMode
| <code>void DebugDrawLine( vector, vector, int, int, int, bool, float )</code>
+
| <code>void SetUseUniversalShopMode( bool )</code>
| Draw a debug overlay line (origin, target, r, g, b, ztest, duration)
+
| When true, all items are available at as long as any shop is in range.
 
|-
 
|-
| DebugDrawCircle
+
| SetTimeOfDay
| <code>void DebugDrawCircle( vector, vector, float, float, bool, float )</code>
+
| <code>void SetTimeOfDay( float )</code>
| Draw a debug circle (center, vRgb, a, rad, a, ztest, duration)
+
| Set the time of day.
 
|-
 
|-
| DebugDrawLine_vCol
+
| SetOverlayHealthBarUnit
| <code>void DebugDrawLine_vCol( vector, vector, vector, bool, float )</code>
+
| <code>void SetOverlayHealthBarUnit( hscript, int )</code>
| Draw a debug line using color vec (start, end, vRgb, a, ztest, duration)
+
| Show this unit's health on the overlay health bar
 
|-
 
|-
| DebugDrawBoxDirection
+
| SetHeroMinimapIconSize
| <code>void DebugDrawBoxDirection( vector, vector, vector, vector, vector, float, float )</code>
+
| <code>void SetHeroMinimapIconSize( int )</code>
| Draw a debug forward box (cent, min, max, forward, vRgb, a, duration)
+
| (nMinimapHeroIconSize) - Set the hero minimap icon size.
 
|-
 
|-
| DebugDrawClear
+
| SetCreepMinimapIconScale
| <code>void DebugDrawClear()</code>
+
| <code>void SetCreepMinimapIconScale( float )</code>
| Try to clear all the debug overlay info
+
| (flMinimapCreepIconScale) - Scale the creep icons on the minimap.
 
|-
 
|-
| GetFrameCount
+
| SetRuneMinimapIconScale
| <code>int GetFrameCount()</code>
+
| <code>void SetRuneMinimapIconScale( float )</code>
| Returns the engines current frame count
+
| (flMinimapRuneIconScale) - Scale the rune icons on the minimap.
 
|-
 
|-
| IsDedicatedServer
+
| SetSafeToLeave
| <code>bool IsDedicatedServer()</code>
+
| <code>void SetSafeToLeave( bool )</code>
| Returns true if this server is a dedicated server.
+
| (bSafeToLeave) - Mark this game as safe to leave.
 
|-
 
|-
| CreateUnitByName
+
| SetUseCustomHeroXPValues
| <code>hscript CreateUnitByName( cstring, vector, bool, hscript, hscript, int )</code>
+
| <code>void SetUseCustomHeroXPValues( bool )</code>
| Creates a DOTA unit by its dota_npc_units.txt name
+
| Allows heroes in the map to give a specific amount of XP (this value must be set).
 
|-
 
|-
| PrecacheUnitByName
+
| SetCustomGameDifficulty
| <code>bool PrecacheUnitByName( cstring )</code>
+
| <code>void SetCustomGameDifficulty( int )</code>
| Precaches a DOTA unit by its dota_npc_units.txt name
+
| Set the difficulty level of the custom game mode
 +
|}
 +
 
 +
 
 +
=== CDOTAVoteSystem ===
 +
''!DOTA Vote System''
 +
 
 +
{| class="standard-table" style="width: 100;"
 +
! Function
 +
! Signature
 +
! Description
 
|-
 
|-
| CreateHeroForPlayer
+
| StartVote
| <code>hscript CreateHeroForPlayer( cstring, hscript )</code>
+
| <code>void StartVote( hscript )</code>
| Creates a DOTA hero by its dota_npc_units.txt name and sets it as the given player's controlled hero
+
| Starts a vote, based upon a table of parameters
 +
|}
 +
 
 +
 
 +
=== CBaseEntity ===
 +
''Root class of all server-side entities''
 +
 
 +
{| class="standard-table" style="width: 100;"
 +
! Function
 +
! Signature
 +
! Description
 
|-
 
|-
| CreateItem
+
| ConnectOutput
| <code>hscript CreateItem( cstring, hscript, hscript )</code>
+
| <code>void ConnectOutput( cstring, cstring )</code>
| Create a DOTA item
+
| Adds an I/O connection that will call the named function when the specified output fires
 
|-
 
|-
| CreateItemOnPosition
+
| DisconnectOutput
| <code>hscript CreateItemOnPosition( vector )</code>
+
| <code>void DisconnectOutput( cstring, cstring )</code>
| Create a physical item at a given location
+
| Removes a connected script function from an I/O event.
 
|-
 
|-
| FindClearSpaceForUnit
+
| GetHealth
| <code>void FindClearSpaceForUnit( hscript, vector, bool )</code>
+
| <code>int GetHealth()</code>
| Place a unit somewhere not already occupied.
+
|  
 
|-
 
|-
| FindUnitsInRadius
+
| SetHealth
| <code>variant FindUnitsInRadius( int, vector, hscript, float, int, int, int, int, bool )</code>
+
| <code>void SetHealth( int )</code>
| Finds the units in a given radius with the given flags.
+
|  
 
|-
 
|-
| PrecacheUnit
+
| GetMaxHealth
| <code>void PrecacheUnit( cstring )</code>
+
| <code>int GetMaxHealth()</code>
| Precaches all the resources for a given unit.
+
|  
 
|-
 
|-
| GetFrostyPointsForRound
+
| SetMaxHealth
| <code>int GetFrostyPointsForRound( int, int, int )</code>
+
| <code>void SetMaxHealth( int )</code>
 
|  
 
|  
 
|-
 
|-
| GetGoldFrostyPointsForRound
+
| IsAlive
| <code>int GetGoldFrostyPointsForRound( int, int, int )</code>
+
| <code>bool IsAlive()</code>
 
|  
 
|  
 
|-
 
|-
| GetFrostyBoostAmount
+
| Remove
| <code>float GetFrostyBoostAmount( int, int )</code>
+
| <code>void Remove()</code>
 
|  
 
|  
 
|-
 
|-
| GetGoldFrostyBoostAmount
+
| SetModel
| <code>float GetGoldFrostyBoostAmount( int, int )</code>
+
| <code>void SetModel( cstring )</code>
 
|  
 
|  
 
|-
 
|-
| SendFrostyPointsMessageToGC
+
| GetModelName
| <code>void SendFrostyPointsMessageToGC( hscript )</code>
+
| <code>cstring GetModelName()</code>
|  
+
| Returns the name of the model
 
|-
 
|-
| SendFrostivusTimeElapsedToGC
+
| EmitSound
| <code>void SendFrostivusTimeElapsedToGC()</code>
+
| <code>void EmitSound( cstring )</code>
|  
+
| Plays a sound from this entity.
 
|-
 
|-
| ExecuteOrderFromTable
+
| EmitSoundParams
| <code>void ExecuteOrderFromTable( hscript )</code>
+
| <code>void EmitSoundParams( cstring, int, float )</code>
| Issue an order from a script table
+
| Plays/modifies a sound from this entity. changes sound if nPitch and/or flVol is > 0.
 
|-
 
|-
| ShowGenericPopup
+
| StopSound
| <code>void ShowGenericPopup( cstring, cstring, cstring, cstring, int )</code>
+
| <code>void StopSound( cstring )</code>
| Show a generic popup dialog for all players.
+
| Stops a named sound playing from this entity.
 
|-
 
|-
| ShowGenericPopupToPlayer
+
| PrecacheSoundScript
| <code>void ShowGenericPopupToPlayer( hscript, cstring, cstring, cstring, cstring, int )</code>
+
| <code>void PrecacheSoundScript( cstring )</code>
| Show a generic popup dialog to a specific player.
+
| Precache a sound for later playing.
|}
 
 
 
=== CEntities ===
 
''!The global list of entities''
 
 
 
{| class="standard-table" style="width: 100;"
 
! Function
 
! Signature
 
! Description
 
 
|-
 
|-
| First
+
| GetSoundDuration
| <code>hscript First()</code>
+
| <code>float GetSoundDuration( cstring, cstring )</code>
| Begin an iteration over the list of entities
+
| Returns float duration of the sound. Takes soundname and optional actormodelname.
 
|-
 
|-
| Next
+
| GetClassname
| <code>hscript Next( hscript )</code>
+
| <code>cstring GetClassname()</code>
| Continue an iteration over the list of entities, providing reference to a previously found entity
+
|  
 
|-
 
|-
| CreateByClassname
+
| GetName
| <code>hscript CreateByClassname( cstring )</code>
+
| <code>cstring GetName()</code>
| Creates an entity by classname
+
|  
 
|-
 
|-
| FindByClassname
+
| GetPreTemplateName
| <code>hscript FindByClassname( hscript, cstring )</code>
+
| <code>cstring GetPreTemplateName()</code>
| Find entities by class name. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search
+
| Get the entity name stripped of template unique decoration
 
|-
 
|-
| FindAllByClassname
+
| GetAbsOrigin
| <code>variant FindAllByClassname( cstring )</code>
+
| <code>vector GetAbsOrigin()</code>
| Find entities by class name.
+
|  
 
|-
 
|-
| FindByName
+
| SetAbsOrigin
| <code>hscript FindByName( hscript, cstring )</code>
+
| <code>void SetAbsOrigin( vector )</code>
| Find entities by name. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search
+
|  
 
|-
 
|-
| FindAllByName
+
| GetOrigin
| <code>variant FindAllByName( cstring )</code>
+
| <code>vector GetOrigin()</code>
| Find entities by name; returns an array of everything found.
+
|  
 
|-
 
|-
| FindInSphere
+
| SetAbsOrigin
| <code>hscript FindInSphere( hscript, vector, float )</code>
+
| <code>void SetAbsOrigin( vector )</code>
| Find entities within a radius. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search
+
| SetOrigin
 
|-
 
|-
| FindAllInSphere
+
| SetOrigin
| <code>variant FindAllInSphere( vector, float )</code>
+
| <code>void SetOrigin( vector )</code>
| Find entities within a radius.
+
|  
 
|-
 
|-
| FindByTarget
+
| GetForwardVector
| <code>hscript FindByTarget( hscript, cstring )</code>
+
| <code>vector GetForwardVector()</code>
| Find entities by targetname. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search
+
| Get the forward vector of the entity
 
|-
 
|-
| FindAllByTarget
+
| GetRightVector
| <code>variant FindAllByTarget( cstring )</code>
+
| <code>vector GetRightVector()</code>
| Find entities by targetname.
+
| Get the right vector of the entity
 
|-
 
|-
| FindByModel
+
| GetUpVector
| <code>hscript FindByModel( hscript, cstring )</code>
+
| <code>vector GetUpVector()</code>
| Find entities by model name. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search
+
| Get the up vector of the entity
 
|-
 
|-
| FindAllByModel
+
| SetForwardVector
| <code>variant FindAllByModel( cstring )</code>
+
| <code>void SetForwardVector( vector )</code>
| Find entities by model name.
+
| Set the orientation of the entity to have this forward vector
 
|-
 
|-
| FindByNameNearest
+
| GetVelocity
| <code>hscript FindByNameNearest( cstring, vector, float )</code>
+
| <code>vector GetVelocity()</code>
| Find entities by name nearest to a point.
+
|  
 
|-
 
|-
| FindByNameWithin
+
| SetVelocity
| <code>hscript FindByNameWithin( hscript, cstring, vector, float )</code>
+
| <code>void SetVelocity( vector )</code>
| Find entities by name within a radius. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search
+
|  
 
|-
 
|-
| FindAllByNameWithin
+
| SetAngularVelocity
| <code>variant FindAllByNameWithin( cstring, vector, float )</code>
+
| <code>void SetAngularVelocity( float, float, float )</code>
| Find entities by name within a radius.
+
| Set the local angular velocity - takes float pitch,yaw,roll velocities
 
|-
 
|-
| FindByClassnameNearest
+
| GetAngularVelocity
| <code>hscript FindByClassnameNearest( cstring, vector, float )</code>
+
| <code>vector GetAngularVelocity()</code>
| Find entities by class name nearest to a point.
+
| Get the local angular velocity - returns a vector of pitch,yaw,roll
 
|-
 
|-
| FindByClassnameWithin
+
| GetCenter
| <code>hscript FindByClassnameWithin( hscript, cstring, vector, float )</code>
+
| <code>vector GetCenter()</code>
| Find entities by class name within a radius. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search
+
| Get vector to center of object - absolute coords
 
|-
 
|-
| FindAllByClassnameWithin
+
| EyePosition
| <code>variant FindAllByClassnameWithin( cstring, vector, float )</code>
+
| <code>vector EyePosition()</code>
| Find entities by class name within a radius.
+
| Get vector to eye position - absolute coords
|}
 
 
 
 
 
=== Convars ===
 
''!Access to convar functions''
 
 
 
{| class="standard-table" style="width: 100;"
 
! Function
 
! Signature
 
! Description
 
 
|-
 
|-
| GetFloat
+
| SetAngles
| <code>variant GetFloat( cstring )</code>
+
| <code>void SetAngles( float, float, float )</code>
| GetFloat(name) : returns the convar as a float. May return null if no such convar.
+
| Set entity pitch, yaw, roll
 
|-
 
|-
| GetStr
+
| GetAngles
| <code>variant GetStr( cstring )</code>
+
| <code>vector GetAngles()</code>
| GetFloat(name) : returns the convar as a string. May return null if no such convar.
+
| Get entity pitch, yaw, roll as a vector
 
|-
 
|-
| GetBool
+
| SetSize
| <code>variant GetBool( cstring )</code>
+
| <code>void SetSize( vector, vector )</code>
| GetBool(name) : returns the convar as a boolean flag.
+
|  
 
|-
 
|-
| RegisterCommand
+
| GetBoundingMins
| <code>void RegisterCommand( cstring, hscript, cstring, int )</code>
+
| <code>vector GetBoundingMins()</code>
| RegisterCommand(name, fn, helpString, flags) : register a console command.
+
| Get a vector containing min bounds, centered on object
 
|-
 
|-
| RegisterConvar
+
| GetBoundingMaxs
| <code>void RegisterConvar( cstring, cstring, cstring, int )</code>
+
| <code>vector GetBoundingMaxs()</code>
| RegisterConvar(name, defaultValue, helpString, flags): register a new console variable.
+
| Get a vector containing max bounds, centered on object
 
|-
 
|-
| GetCommandClient
+
| Destroy
| <code>hscript GetCommandClient()</code>
+
| <code>void Destroy()</code>
| GetCommandClient() : returns the player who issued this console command.
+
|  
 
|-
 
|-
| GetDOTACommandClient
+
| SetOwner
| <code>hscript GetDOTACommandClient()</code>
+
| <code>void SetOwner( hscript )</code>
| GetDOTACommandClient() : returns the DOTA player who issued this console command.
+
|  
|}
 
 
 
 
 
=== CScriptHeroList ===
 
''!The global list of heroes''
 
 
 
{| class="standard-table" style="width: 100;"
 
! Function
 
! Signature
 
! Description
 
 
|-
 
|-
| GetHero
+
| GetTeam
| <code>hscript GetHero( int )</code>
+
| <code>int GetTeam()</code>
| Get the Nth hero in the Hero List
+
|  
 
|-
 
|-
| GetHeroCount
+
| SetTeam
| <code>int GetHeroCount()</code>
+
| <code>void SetTeam( int )</code>
| Returns the number of heroes in the world
+
|  
 
|-
 
|-
| GetAllHeroes
+
| GetMoveParent
| <code>variant GetAllHeroes()</code>
+
| <code>hscript GetMoveParent()</code>
| Returns all the heroes in the world
+
| If in hierarchy, retrieves the entity's parent
|}
 
 
 
 
 
=== CDOTAGamerules ===
 
''!DOTA GameRules''
 
 
 
{| class="standard-table" style="width: 100;"
 
! Function
 
! Signature
 
! Description
 
 
|-
 
|-
| State_Get
+
| GetRootMoveParent
| <code>unknown_variant_type State_Get()</code>
+
| <code>hscript GetRootMoveParent()</code>
| Get the current Gamerules state
+
| If in hierarchy, walks up the hierarchy to find the root parent
 
|-
 
|-
| GetGameTime
+
| FirstMoveChild
| <code>float GetGameTime()</code>
+
| <code>hscript FirstMoveChild()</code>
| Returns the number of seconds elapsed since map start. This time doesn't count up when the game is paused
+
|  
 
|-
 
|-
| GetDifficulty
+
| NextMovePeer
| <code>int GetDifficulty()</code>
+
| <code>hscript NextMovePeer()</code>
| Returns difficulty level of the custom game mode
+
|  
 
|-
 
|-
| GetCustomGameDifficulty
+
| __KeyValueFromString
| <code>int GetCustomGameDifficulty()</code>
+
| <code>bool __KeyValueFromString( cstring, cstring )</code>
| Returns the difficulty level of the custom game mode
+
| @
 
|-
 
|-
| Defeated
+
| __KeyValueFromFloat
| <code>void Defeated()</code>
+
| <code>bool __KeyValueFromFloat( cstring, float )</code>
| Kills the ancient, etc.
+
| @
 
|-
 
|-
| ResetDefeated
+
| __KeyValueFromInt
| <code>void ResetDefeated()</code>
+
| <code>bool __KeyValueFromInt( cstring, int )</code>
| Restart after killing the ancient, etc.
+
| @
 
|-
 
|-
| SetGameWinner
+
| __KeyValueFromVector
| <code>void SetGameWinner( int )</code>
+
| <code>bool __KeyValueFromVector( cstring, vector )</code>
| Makes ths specified team win
+
| @
 
|-
 
|-
| MakeTeamLose
+
| Trigger
| <code>void MakeTeamLose( int )</code>
+
| <code>void Trigger()</code>
| Makes ths specified team lose
+
| Fires off this entity's OnTrigger responses
 
|-
 
|-
| ResetMap
+
| ValidateScriptScope
| <code>void ResetMap( int )</code>
+
| <code>bool ValidateScriptScope()</code>
| Resets the map in one of several ways
+
| Ensure that an entity's script scope has been created
 
|-
 
|-
| GetDroppedItem
+
| GetScriptScope
| <code>hscript GetDroppedItem( int )</code>
+
| <code>hscript GetScriptScope()</code>
| Gets the Xth dropped item
+
| Retrieve the script-side data associated with an entity
 
|-
 
|-
| NumDroppedItems
+
| GetScriptId
| <code>int NumDroppedItems()</code>
+
| <code>cstring GetScriptId()</code>
| Returns the number of items currently dropped on the ground
+
| Retrieve the unique identifier used to refer to the entity within the scripting system
 
|-
 
|-
| SendCustomMessage
+
| GetOwner
| <code>void SendCustomMessage( cstring, int, int )</code>
+
| <code>hscript GetOwner()</code>
| Sends a string to the defined team.
+
| Gets this entity's owner
 
|-
 
|-
| SetHeroRespawnEnabled
+
| SetOwner
| <code>void SetHeroRespawnEnabled( bool )</code>
+
| <code>void SetOwner( hscript )</code>
| Control if the normal DOTA hero respawn rules apply.
+
| Sets this entity's owner
 
|-
 
|-
| Playtesting_UpdateCustomKeyValues
+
| entindex
| <code>void Playtesting_UpdateCustomKeyValues()</code>
+
| <code>unknown_variant_type entindex()</code>
| Updates custom hero, unit and ability KeyValues in memory with the latest values from disk
+
|  
|-
+
|}
| ResetToHeroSelection
+
 
| <code>void ResetToHeroSelection()</code>
+
 
| Restart the game at hero selection
+
=== CDOTA_PlayerResource extends CBaseEntity ===
 +
''Interface to player data''
 +
 
 +
{| class="standard-table" style="width: 100;"
 +
! Function
 +
! Signature
 +
! Description
 
|-
 
|-
| SetTreeRegrowTime
+
| SetHasRepicked
| <code>void SetTreeRegrowTime( float )</code>
+
| <code>void SetHasRepicked( int )</code>
| Sets the tree regrow time in seconds.
+
|  
 
|-
 
|-
| SetHeroSelectionTime
+
| HasRepicked
| <code>void SetHeroSelectionTime( float )</code>
+
| <code>bool HasRepicked( int )</code>
| Sets the amount of time players have to pick their hero.
+
|  
 
|-
 
|-
| SetPreGameTime
+
| SetHasRandomed
| <code>void SetPreGameTime( float )</code>
+
| <code>void SetHasRandomed( int )</code>
| Sets the amount of time players have between picking their hero and game start.
+
|  
 
|-
 
|-
| SetPostGameTime
+
| HasRandomed
| <code>void SetPostGameTime( float )</code>
+
| <code>bool HasRandomed( int )</code>
| Sets the amount of time players have between the game ending and the server disconnecting them.
+
|  
 
|-
 
|-
| SetRuneSpawnTime
+
| IsValidTeamPlayerID
| <code>void SetRuneSpawnTime( float )</code>
+
| <code>bool IsValidTeamPlayerID( int )</code>
| Sets the amount of time between rune spawns.
+
|  
 
|-
 
|-
| SetSameHeroSelectionEnabled
+
| IsValidTeamPlayer
| <code>void SetSameHeroSelectionEnabled( bool )</code>
+
| <code>bool IsValidTeamPlayer( int )</code>
| When true, players can repeatedly pick the same hero.
+
|  
 
|-
 
|-
| SetUseUniversalShopMode
+
| IsValidPlayerID
| <code>void SetUseUniversalShopMode( bool )</code>
+
| <code>bool IsValidPlayerID( int )</code>
| When true, all items are available at as long as any shop is in range.
+
|  
 
|-
 
|-
| SetTimeOfDay
+
| IsValidPlayer
| <code>void SetTimeOfDay( float )</code>
+
| <code>bool IsValidPlayer( int )</code>
| Set the time of day.
+
|  
 
|-
 
|-
| SetOverlayHealthBarUnit
+
| GetLevel
| <code>void SetOverlayHealthBarUnit( hscript, int )</code>
+
| <code>int GetLevel( int )</code>
| Show this unit's health on the overlay health bar
+
|  
 
|-
 
|-
| SetHeroMinimapIconSize
+
| IncrementKills
| <code>void SetHeroMinimapIconSize( int )</code>
+
| <code>void IncrementKills( int, int )</code>
| (nMinimapHeroIconSize) - Set the hero minimap icon size.
+
|  
 
|-
 
|-
| SetCreepMinimapIconScale
+
| IncrementAssists
| <code>void SetCreepMinimapIconScale( float )</code>
+
| <code>void IncrementAssists( int )</code>
| (flMinimapCreepIconScale) - Scale the creep icons on the minimap.
+
|  
 
|-
 
|-
| SetRuneMinimapIconScale
+
| IncrementDeaths
| <code>void SetRuneMinimapIconScale( float )</code>
+
| <code>void IncrementDeaths( int )</code>
| (flMinimapRuneIconScale) - Scale the rune icons on the minimap.
+
|  
 
|-
 
|-
| SetSafeToLeave
+
| GetKills
| <code>void SetSafeToLeave( bool )</code>
+
| <code>int GetKills( int )</code>
| (bSafeToLeave) - Mark this game as safe to leave.
+
|  
 +
|-
 +
| GetAssists
 +
| <code>int GetAssists( int )</code>
 +
|
 
|-
 
|-
| SetUseCustomHeroXPValues
+
| GetDeaths
| <code>void SetUseCustomHeroXPValues( bool )</code>
+
| <code>int GetDeaths( int )</code>
| Allows heroes in the map to give a specific amount of XP (this value must be set).
+
|  
 
|-
 
|-
| SetCustomGameDifficulty
+
| GetStuns
| <code>void SetCustomGameDifficulty( int )</code>
+
| <code>float GetStuns( int )</code>
| Set the difficulty level of the custom game mode
+
|  
|}
 
 
 
 
 
=== CDOTAVoteSystem ===
 
''!DOTA Vote System''
 
 
 
{| class="standard-table" style="width: 100;"
 
! Function
 
! Signature
 
! Description
 
 
|-
 
|-
| StartVote
+
| GetHealing
| <code>void StartVote( hscript )</code>
+
| <code>float GetHealing( int )</code>
| Starts a vote, based upon a table of parameters
+
|  
|}
 
 
 
 
 
=== CBaseEntity ===
 
''Root class of all server-side entities''
 
 
 
{| class="standard-table" style="width: 100;"
 
! Function
 
! Signature
 
! Description
 
 
|-
 
|-
| ConnectOutput
+
| GetTowerKills
| <code>void ConnectOutput( cstring, cstring )</code>
+
| <code>int GetTowerKills( int )</code>
| Adds an I/O connection that will call the named function when the specified output fires
+
|  
 
|-
 
|-
| DisconnectOutput
+
| GetRoshanKills
| <code>void DisconnectOutput( cstring, cstring )</code>
+
| <code>int GetRoshanKills( int )</code>
| Removes a connected script function from an I/O event.
 
|-
 
| GetHealth
 
| <code>int GetHealth()</code>
 
 
|  
 
|  
 
|-
 
|-
| SetHealth
+
| GetTeamKills
| <code>void SetHealth( int )</code>
+
| <code>int GetTeamKills( int )</code>
 
|  
 
|  
 
|-
 
|-
| GetMaxHealth
+
| IncrementStreak
| <code>int GetMaxHealth()</code>
+
| <code>void IncrementStreak( int )</code>
 
|  
 
|  
 
|-
 
|-
| SetMaxHealth
+
| ClearStreak
| <code>void SetMaxHealth( int )</code>
+
| <code>void ClearStreak( int )</code>
 
|  
 
|  
 
|-
 
|-
| IsAlive
+
| GetStreak
| <code>bool IsAlive()</code>
+
| <code>int GetStreak( int )</code>
 
|  
 
|  
 
|-
 
|-
| Remove
+
| ModifyGold
| <code>void Remove()</code>
+
| <code>int ModifyGold( int, int, bool, int )</code>
 
|  
 
|  
 
|-
 
|-
| SetModel
+
| SetGold
| <code>void SetModel( cstring )</code>
+
| <code>void SetGold( int, int, bool )</code>
 
|  
 
|  
 
|-
 
|-
| GetModelName
+
| SpendGold
| <code>cstring GetModelName()</code>
+
| <code>void SpendGold( int, int, int )</code>
| Returns the name of the model
+
|  
 
|-
 
|-
| EmitSound
+
| GetGold
| <code>void EmitSound( cstring )</code>
+
| <code>int GetGold( int )</code>
| Plays a sound from this entity.
+
|  
 
|-
 
|-
| EmitSoundParams
+
| GetReliableGold
| <code>void EmitSoundParams( cstring, int, float )</code>
+
| <code>int GetReliableGold( int )</code>
| Plays/modifies a sound from this entity. changes sound if nPitch and/or flVol is > 0.
+
|  
 
|-
 
|-
| StopSound
+
| GetUnreliableGold
| <code>void StopSound( cstring )</code>
+
| <code>int GetUnreliableGold( int )</code>
| Stops a named sound playing from this entity.
+
|  
 
|-
 
|-
| PrecacheSoundScript
+
| ResetTotalEarnedGold
| <code>void PrecacheSoundScript( cstring )</code>
+
| <code>void ResetTotalEarnedGold( int )</code>
| Precache a sound for later playing.
+
|  
 
|-
 
|-
| GetSoundDuration
+
| GetTotalEarnedGold
| <code>float GetSoundDuration( cstring, cstring )</code>
+
| <code>int GetTotalEarnedGold( int )</code>
| Returns float duration of the sound. Takes soundname and optional actormodelname.
+
|  
 
|-
 
|-
| GetClassname
+
| GetTotalGoldSpent
| <code>cstring GetClassname()</code>
+
| <code>int GetTotalGoldSpent( int )</code>
 
|  
 
|  
 
|-
 
|-
| GetName
+
| AddGoldSpentOnSupport
| <code>cstring GetName()</code>
+
| <code>void AddGoldSpentOnSupport( int, int )</code>
 
|  
 
|  
 
|-
 
|-
| GetPreTemplateName
+
| GetGoldSpentOnSupport
| <code>cstring GetPreTemplateName()</code>
+
| <code>int GetGoldSpentOnSupport( int )</code>
| Get the entity name stripped of template unique decoration
+
|  
 
|-
 
|-
| GetAbsOrigin
+
| GetGoldSpentOnConsumables
| <code>vector GetAbsOrigin()</code>
+
| <code>int GetGoldSpentOnConsumables( int )</code>
 
|  
 
|  
 
|-
 
|-
| SetAbsOrigin
+
| GetGoldSpentOnItems
| <code>void SetAbsOrigin( vector )</code>
+
| <code>int GetGoldSpentOnItems( int )</code>
 
|  
 
|  
 
|-
 
|-
| GetOrigin
+
| GetGoldLostToDeath
| <code>vector GetOrigin()</code>
+
| <code>int GetGoldLostToDeath( int )</code>
 
|  
 
|  
 
|-
 
|-
| SetAbsOrigin
+
| GetGoldSpentOnBuybacks
| <code>void SetAbsOrigin( vector )</code>
+
| <code>int GetGoldSpentOnBuybacks( int )</code>
| SetOrigin
 
|-
 
| SetOrigin
 
| <code>void SetOrigin( vector )</code>
 
 
|  
 
|  
 
|-
 
|-
| GetForwardVector
+
| GetGoldPerMin
| <code>vector GetForwardVector()</code>
+
| <code>float GetGoldPerMin( int )</code>
| Get the forward vector of the entity
+
|  
 
|-
 
|-
| GetRightVector
+
| GetXPPerMin
| <code>vector GetRightVector()</code>
+
| <code>float GetXPPerMin( int )</code>
| Get the right vector of the entity
+
|  
 
|-
 
|-
| GetUpVector
+
| GetAegisPickups
| <code>vector GetUpVector()</code>
+
| <code>int GetAegisPickups( int )</code>
| Get the up vector of the entity
+
|  
 
|-
 
|-
| SetForwardVector
+
| AddAegisPickup
| <code>void SetForwardVector( vector )</code>
+
| <code>void AddAegisPickup( int )</code>
| Set the orientation of the entity to have this forward vector
 
|-
 
| GetVelocity
 
| <code>vector GetVelocity()</code>
 
 
|  
 
|  
 
|-
 
|-
| SetVelocity
+
| GetRunePickups
| <code>void SetVelocity( vector )</code>
+
| <code>int GetRunePickups( int )</code>
 
|  
 
|  
 
|-
 
|-
| SetAngularVelocity
+
| AddRunePickup
| <code>void SetAngularVelocity( float, float, float )</code>
+
| <code>void AddRunePickup( int )</code>
| Set the local angular velocity - takes float pitch,yaw,roll velocities
+
|  
 
|-
 
|-
| GetAngularVelocity
+
| GetNumConsumablesPurchased
| <code>vector GetAngularVelocity()</code>
+
| <code>int GetNumConsumablesPurchased( int )</code>
| Get the local angular velocity - returns a vector of pitch,yaw,roll
+
|  
 
|-
 
|-
| GetCenter
+
| GetNumItemsPurchased
| <code>vector GetCenter()</code>
+
| <code>int GetNumItemsPurchased( int )</code>
| Get vector to center of object - absolute coords
+
|  
 
|-
 
|-
| EyePosition
+
| GetTimeOfLastItemPurchase
| <code>vector EyePosition()</code>
+
| <code>float GetTimeOfLastItemPurchase( int )</code>
| Get vector to eye position - absolute coords
+
|  
 
|-
 
|-
| SetAngles
+
| GetTimeOfLastConsumablePurchase
| <code>void SetAngles( float, float, float )</code>
+
| <code>float GetTimeOfLastConsumablePurchase( int )</code>
| Set entity pitch, yaw, roll
+
|  
 
|-
 
|-
| GetAngles
+
| GetTimeOfLastDeath
| <code>vector GetAngles()</code>
+
| <code>float GetTimeOfLastDeath( int )</code>
| Get entity pitch, yaw, roll as a vector
+
|  
 
|-
 
|-
| SetSize
+
| GetRespawnSeconds
| <code>void SetSize( vector, vector )</code>
+
| <code>int GetRespawnSeconds( int )</code>
 
|  
 
|  
 
|-
 
|-
| GetBoundingMins
+
| IncrementTotalEarnedXP
| <code>vector GetBoundingMins()</code>
+
| <code>void IncrementTotalEarnedXP( int, int )</code>
| Get a vector containing min bounds, centered on object
+
|  
 
|-
 
|-
| GetBoundingMaxs
+
| GetTotalEarnedXP
| <code>vector GetBoundingMaxs()</code>
+
| <code>int GetTotalEarnedXP( int )</code>
| Get a vector containing max bounds, centered on object
+
|  
 
|-
 
|-
| Destroy
+
| AddClaimedFarm
| <code>void Destroy()</code>
+
| <code>void AddClaimedFarm( int, float )</code>
 
|  
 
|  
 
|-
 
|-
| SetOwner
+
| GetClaimedFarm
| <code>void SetOwner( hscript )</code>
+
| <code>float GetClaimedFarm( int )</code>
 
|  
 
|  
 
|-
 
|-
| GetTeam
+
| GetRawPlayerDamage
| <code>int GetTeam()</code>
+
| <code>int GetRawPlayerDamage( int )</code>
 
|  
 
|  
 
|-
 
|-
| SetTeam
+
| ClearRawPlayerDamageMatrix
| <code>void SetTeam( int )</code>
+
| <code>void ClearRawPlayerDamageMatrix( int )</code>
 
|  
 
|  
 
|-
 
|-
| GetMoveParent
+
| ClearKillsMatrix
| <code>hscript GetMoveParent()</code>
+
| <code>void ClearKillsMatrix( int )</code>
| If in hierarchy, retrieves the entity's parent
+
|  
 
|-
 
|-
| GetRootMoveParent
+
| GetTowerDamageTaken
| <code>hscript GetRootMoveParent()</code>
+
| <code>int GetTowerDamageTaken( int )</code>
| If in hierarchy, walks up the hierarchy to find the root parent
+
|  
 
|-
 
|-
| FirstMoveChild
+
| GetCreepDamageTaken
| <code>hscript FirstMoveChild()</code>
+
| <code>int GetCreepDamageTaken( int )</code>
 
|  
 
|  
 
|-
 
|-
| NextMovePeer
+
| GetHeroDamageTaken
| <code>hscript NextMovePeer()</code>
+
| <code>int GetHeroDamageTaken( int )</code>
 
|  
 
|  
 
|-
 
|-
| __KeyValueFromString
+
| GetDamageDoneToHero
| <code>bool __KeyValueFromString( cstring, cstring )</code>
+
| <code>int GetDamageDoneToHero( int, int )</code>
| @
+
|  
 
|-
 
|-
| __KeyValueFromFloat
+
| GetKillsDoneToHero
| <code>bool __KeyValueFromFloat( cstring, float )</code>
+
| <code>int GetKillsDoneToHero( int, int )</code>
| @
+
|  
 
|-
 
|-
| __KeyValueFromInt
+
| GetSelectedHeroName
| <code>bool __KeyValueFromInt( cstring, int )</code>
+
| <code>cstring GetSelectedHeroName( int )</code>
| @
+
|  
 
|-
 
|-
| __KeyValueFromVector
+
| GetSelectedHeroID
| <code>bool __KeyValueFromVector( cstring, vector )</code>
+
| <code>int GetSelectedHeroID( int )</code>
| @
+
|  
 
|-
 
|-
| Trigger
+
| IsHeroSelected
| <code>void Trigger()</code>
+
| <code>bool IsHeroSelected( cstring )</code>
| Fires off this entity's OnTrigger responses
+
|  
 
|-
 
|-
| ValidateScriptScope
+
| WhoSelectedHero
| <code>bool ValidateScriptScope()</code>
+
| <code>int WhoSelectedHero( cstring )</code>
| Ensure that an entity's script scope has been created
+
|  
 
|-
 
|-
| GetScriptScope
+
| GetSelectedHeroEntity
| <code>hscript GetScriptScope()</code>
+
| <code>hscript GetSelectedHeroEntity( int )</code>
| Retrieve the script-side data associated with an entity
+
|  
 
|-
 
|-
| GetScriptId
+
| HasSelectedHero
| <code>cstring GetScriptId()</code>
+
| <code>bool HasSelectedHero( int )</code>
| Retrieve the unique identifier used to refer to the entity within the scripting system
+
|  
 
|-
 
|-
| GetOwner
+
| GetPlayer
| <code>hscript GetOwner()</code>
+
| <code>hscript GetPlayer( int )</code>
| Gets this entity's owner
+
|  
 
|-
 
|-
| SetOwner
+
| GetNthPlayerIDOnTeam
| <code>void SetOwner( hscript )</code>
+
| <code>int GetNthPlayerIDOnTeam( int, int )</code>
| Sets this entity's owner
+
|  
 
|-
 
|-
| entindex
+
| IncrementLastHits
| <code>unknown_variant_type entindex()</code>
+
| <code>void IncrementLastHits( int )</code>
 
|  
 
|  
|}
 
 
 
=== CDOTA_PlayerResource extends CBaseEntity ===
 
''Interface to player data''
 
 
{| class="standard-table" style="width: 100;"
 
! Function
 
! Signature
 
! Description
 
 
|-
 
|-
| SetHasRepicked
+
| GetLastHits
| <code>void SetHasRepicked( int )</code>
+
| <code>int GetLastHits( int )</code>
 
|  
 
|  
 
|-
 
|-
| HasRepicked
+
| IncrementGoldBagsCollected
| <code>bool HasRepicked( int )</code>
+
| <code>void IncrementGoldBagsCollected( int )</code>
 
|  
 
|  
 
|-
 
|-
| SetHasRandomed
+
| GetGoldBagsCollected
| <code>void SetHasRandomed( int )</code>
+
| <code>int GetGoldBagsCollected( int )</code>
 
|  
 
|  
 
|-
 
|-
| HasRandomed
+
| IncrementLastHitStreak
| <code>bool HasRandomed( int )</code>
+
| <code>void IncrementLastHitStreak( int )</code>
 
|  
 
|  
 
|-
 
|-
| IsValidTeamPlayerID
+
| ClearLastHitStreak
| <code>bool IsValidTeamPlayerID( int )</code>
+
| <code>void ClearLastHitStreak( int )</code>
 
|  
 
|  
 
|-
 
|-
| IsValidTeamPlayer
+
| GetLastHitStreak
| <code>bool IsValidTeamPlayer( int )</code>
+
| <code>int GetLastHitStreak( int )</code>
 
|  
 
|  
 
|-
 
|-
| IsValidPlayerID
+
| IncrementLastHitMultikill
| <code>bool IsValidPlayerID( int )</code>
+
| <code>void IncrementLastHitMultikill( int )</code>
 
|  
 
|  
 
|-
 
|-
| IsValidPlayer
+
| ClearLastHitMultikill
| <code>bool IsValidPlayer( int )</code>
+
| <code>void ClearLastHitMultikill( int )</code>
 
|  
 
|  
 
|-
 
|-
| GetLevel
+
| GetLastHitMultikill
| <code>int GetLevel( int )</code>
+
| <code>int GetLastHitMultikill( int )</code>
 
|  
 
|  
 
|-
 
|-
| IncrementKills
+
| IncrementNearbyCreepDeaths
| <code>void IncrementKills( int, int )</code>
+
| <code>void IncrementNearbyCreepDeaths( int )</code>
 
|  
 
|  
 
|-
 
|-
| IncrementAssists
+
| GetNearbyCreepDeaths
| <code>void IncrementAssists( int )</code>
+
| <code>int GetNearbyCreepDeaths( int )</code>
 
|  
 
|  
 
|-
 
|-
| IncrementDeaths
+
| IncrementDenies
| <code>void IncrementDeaths( int )</code>
+
| <code>void IncrementDenies( int )</code>
 
|  
 
|  
 
|-
 
|-
| GetKills
+
| GetDenies
| <code>int GetKills( int )</code>
+
| <code>int GetDenies( int )</code>
 
|  
 
|  
 
|-
 
|-
| GetAssists
+
| IncrementClaimedMisses
| <code>int GetAssists( int )</code>
+
| <code>void IncrementClaimedMisses( int )</code>
 
|  
 
|  
 
|-
 
|-
| GetDeaths
+
| GetClaimedMisses
| <code>int GetDeaths( int )</code>
+
| <code>int GetClaimedMisses( int )</code>
 
|  
 
|  
 
|-
 
|-
| GetStuns
+
| IncrementClaimedDenies
| <code>float GetStuns( int )</code>
+
| <code>void IncrementClaimedDenies( int )</code>
 
|  
 
|  
 
|-
 
|-
| GetHealing
+
| GetClaimedDenies
| <code>float GetHealing( int )</code>
+
| <code>int GetClaimedDenies( int )</code>
 
|  
 
|  
 
|-
 
|-
| GetTowerKills
+
| IncrementMisses
| <code>int GetTowerKills( int )</code>
+
| <code>void IncrementMisses( int )</code>
 
|  
 
|  
 
|-
 
|-
| GetRoshanKills
+
| GetMisses
| <code>int GetRoshanKills( int )</code>
+
| <code>int GetMisses( int )</code>
 
|  
 
|  
 
|-
 
|-
| GetTeamKills
+
| UpdateTeamSlot
| <code>int GetTeamKills( int )</code>
+
| <code>void UpdateTeamSlot( int, int )</code>
 
|  
 
|  
 
|-
 
|-
| IncrementStreak
+
| GetTeam
| <code>void IncrementStreak( int )</code>
+
| <code>int GetTeam( int )</code>
 
|  
 
|  
 
|-
 
|-
| ClearStreak
+
| IsBroadcaster
| <code>void ClearStreak( int )</code>
+
| <code>bool IsBroadcaster( int )</code>
 
|  
 
|  
 
|-
 
|-
| GetStreak
+
| GetBroadcasterChannel
| <code>int GetStreak( int )</code>
+
| <code>uint GetBroadcasterChannel( int )</code>
 
|  
 
|  
 
|-
 
|-
| ModifyGold
+
| GetBroadcasterChannelSlot
| <code>int ModifyGold( int, int, bool, int )</code>
+
| <code>uint GetBroadcasterChannelSlot( int )</code>
 
|  
 
|  
 
|-
 
|-
| SetGold
+
| GetSteamAccountID
| <code>void SetGold( int, int, bool )</code>
+
| <code>uint GetSteamAccountID( int )</code>
 
|  
 
|  
 
|-
 
|-
| SpendGold
+
| IsFakeClient
| <code>void SpendGold( int, int, int )</code>
+
| <code>bool IsFakeClient( int )</code>
 
|  
 
|  
 
|-
 
|-
| GetGold
+
| HaveAllPlayersJoined
| <code>int GetGold( int )</code>
+
| <code>bool HaveAllPlayersJoined()</code>
 
|  
 
|  
 
|-
 
|-
| GetReliableGold
+
| GetPlayerLoadedCompletely
| <code>int GetReliableGold( int )</code>
+
| <code>bool GetPlayerLoadedCompletely( int )</code>
 
|  
 
|  
 
|-
 
|-
| GetUnreliableGold
+
| SetPlayerReservedState
| <code>int GetUnreliableGold( int )</code>
+
| <code>void SetPlayerReservedState( int, bool )</code>
 
|  
 
|  
 
|-
 
|-
| ResetTotalEarnedGold
+
| GetPlayerReservedState
| <code>void ResetTotalEarnedGold( int )</code>
+
| <code>bool GetPlayerReservedState( int )</code>
 
|  
 
|  
 
|-
 
|-
| GetTotalEarnedGold
+
| GetConnectionState
| <code>int GetTotalEarnedGold( int )</code>
+
| <code>unknown_variant_type GetConnectionState( int )</code>
 
|  
 
|  
 
|-
 
|-
| GetTotalGoldSpent
+
| HeroLevelUp
| <code>int GetTotalGoldSpent( int )</code>
+
| <code>void HeroLevelUp( int )</code>
 
|  
 
|  
 
|-
 
|-
| AddGoldSpentOnSupport
+
| SetLastBuybackTime
| <code>void AddGoldSpentOnSupport( int, int )</code>
+
| <code>void SetLastBuybackTime( int, int )</code>
 
|  
 
|  
 
|-
 
|-
| GetGoldSpentOnSupport
+
| GetPlayerName
| <code>int GetGoldSpentOnSupport( int )</code>
+
| <code>cstring GetPlayerName( int )</code>
 
|  
 
|  
 
|-
 
|-
| GetGoldSpentOnConsumables
+
| GetUnitShareMaskForPlayer
| <code>int GetGoldSpentOnConsumables( int )</code>
+
| <code>int GetUnitShareMaskForPlayer( int, int )</code>
 
|  
 
|  
 
|-
 
|-
| GetGoldSpentOnItems
+
| IsHeroSharedWithPlayerID
| <code>int GetGoldSpentOnItems( int )</code>
+
| <code>bool IsHeroSharedWithPlayerID( int, int )</code>
 
|  
 
|  
 
|-
 
|-
| GetGoldLostToDeath
+
| AreUnitsSharedWithPlayerID
| <code>int GetGoldLostToDeath( int )</code>
+
| <code>bool AreUnitsSharedWithPlayerID( int, int )</code>
 
|  
 
|  
 
|-
 
|-
| GetGoldSpentOnBuybacks
+
| IsDisableHelpSetForPlayerID
| <code>int GetGoldSpentOnBuybacks( int )</code>
+
| <code>bool IsDisableHelpSetForPlayerID( int, int )</code>
 
|  
 
|  
 
|-
 
|-
| GetGoldPerMin
+
| SetUnitShareMaskForPlayer
| <code>float GetGoldPerMin( int )</code>
+
| <code>void SetUnitShareMaskForPlayer( int, int, int, bool )</code>
 
|  
 
|  
 
|-
 
|-
| GetXPPerMin
+
| GetNumCouriersForTeam
| <code>float GetXPPerMin( int )</code>
+
| <code>int GetNumCouriersForTeam( int )</code>
 
|  
 
|  
 
|-
 
|-
| GetAegisPickups
+
| GetNthCourierForTeam
| <code>int GetAegisPickups( int )</code>
+
| <code>hscript GetNthCourierForTeam( int, int )</code>
 
|  
 
|  
 
|-
 
|-
| AddAegisPickup
+
| SetBuybackCooldownTime
| <code>void AddAegisPickup( int )</code>
+
| <code>void SetBuybackCooldownTime( int, float )</code>
 
|  
 
|  
 
|-
 
|-
| GetRunePickups
+
| SetBuybackGoldLimitTime
| <code>int GetRunePickups( int )</code>
+
| <code>void SetBuybackGoldLimitTime( int, float )</code>
 
|  
 
|  
 
|-
 
|-
| AddRunePickup
+
| ResetBuybackCostTime
| <code>void AddRunePickup( int )</code>
+
| <code>void ResetBuybackCostTime( int )</code>
 
|  
 
|  
 
|-
 
|-
| GetNumConsumablesPurchased
+
| ReplaceHeroWith
| <code>int GetNumConsumablesPurchased( int )</code>
+
| <code>hscript ReplaceHeroWith( int, cstring, int, int )</code>
|  
+
| (playerID, heroClassName, gold, XP) - replaces the player's hero with a new one of the specified class, gold and XP
 
|-
 
|-
| GetNumItemsPurchased
+
| SetCustomBuybackCost
| <code>int GetNumItemsPurchased( int )</code>
+
| <code>void SetCustomBuybackCost( int, int )</code>
|  
+
| Set the buyback cost for this player.
 
|-
 
|-
| GetTimeOfLastItemPurchase
+
| SetCustomBuybackCooldown
| <code>float GetTimeOfLastItemPurchase( int )</code>
+
| <code>void SetCustomBuybackCooldown( int, float )</code>
|  
+
| Set the buyback cooldown for this player.
 
|-
 
|-
| GetTimeOfLastConsumablePurchase
+
| GetCustomBuybackCost
| <code>float GetTimeOfLastConsumablePurchase( int )</code>
+
| <code>int GetCustomBuybackCost( int )</code>
 
|  
 
|  
 
|-
 
|-
| GetTimeOfLastDeath
+
| GetCustomBuybackCooldown
| <code>float GetTimeOfLastDeath( int )</code>
+
| <code>float GetCustomBuybackCooldown( int )</code>
 
|  
 
|  
 +
|}
 +
 +
 +
=== CDOTABaseGameMode extends CBaseEntity ===
 +
''Base game mode class''
 +
 +
{| class="standard-table" style="width: 100;"
 +
! Function
 +
! Signature
 +
! Description
 +
|-
 +
| BeginThink
 +
| <code>bool BeginThink( cstring, hscript, float )</code>
 +
| Start a think callback. Takes a function and an interval
 
|-
 
|-
| GetRespawnSeconds
+
| EndThink
| <code>int GetRespawnSeconds( int )</code>
+
| <code>void EndThink( cstring )</code>
|  
+
| Stop a think callback.
 
|-
 
|-
| IncrementTotalEarnedXP
+
| SetAlwaysShowPlayerInventory
| <code>void IncrementTotalEarnedXP( int, int )</code>
+
| <code>void SetAlwaysShowPlayerInventory( bool )</code>
|  
+
| Show the player hero's inventory in the HUD, regardless of what unit is selected.
 
|-
 
|-
| GetTotalEarnedXP
+
| SetGoldSoundDisabled
| <code>int GetTotalEarnedXP( int )</code>
+
| <code>void SetGoldSoundDisabled( bool )</code>
|  
+
| Turn the sound when gold is acquired off/on. Takes a bool.
 
|-
 
|-
| AddClaimedFarm
+
| SetRecommendedItemsDisabled
| <code>void AddClaimedFarm( int, float )</code>
+
| <code>void SetRecommendedItemsDisabled( bool )</code>
|  
+
| Turn the panel for showing recommended items at the shop off/on. Takes a bool.
 
|-
 
|-
| GetClaimedFarm
+
| SetCameraDistanceOverride
| <code>float GetClaimedFarm( int )</code>
+
| <code>void SetCameraDistanceOverride( float )</code>
|  
+
| Set a different camera distance; dota default is 1134.
 
|-
 
|-
| GetRawPlayerDamage
+
| SetOverrideSelectionEntity
| <code>int GetRawPlayerDamage( int )</code>
+
| <code>void SetOverrideSelectionEntity( hscript )</code>
|  
+
| Set an override for the default selection entity, instead of each player's hero.
 
|-
 
|-
| ClearRawPlayerDamageMatrix
+
| SetRemoveIllusionsOnDeath
| <code>void ClearRawPlayerDamageMatrix( int )</code>
+
| <code>void SetRemoveIllusionsOnDeath( bool )</code>
|
+
| Make it so illusions are immediately removed upon death, rather than sticking around for a few seconds.
|-
 
| ClearKillsMatrix
 
| <code>void ClearKillsMatrix( int )</code>
 
|  
 
 
|-
 
|-
| GetTowerDamageTaken
+
| ClientLoadGridNav
| <code>int GetTowerDamageTaken( int )</code>
+
| <code>void ClientLoadGridNav()</code>
|  
+
| Tell clients that they need to load gridnav information. Used for things like allowing clients to identify valid locations to place buildings.
 
|-
 
|-
| GetCreepDamageTaken
+
| SetFogOfWarDisabled
| <code>int GetCreepDamageTaken( int )</code>
+
| <code>void SetFogOfWarDisabled( bool )</code>
|  
+
| Turn the fog of war on or off.
 
|-
 
|-
| GetHeroDamageTaken
+
| SetCustomBuybackCostEnabled
| <code>int GetHeroDamageTaken( int )</code>
+
| <code>void SetCustomBuybackCostEnabled( bool )</code>
|  
+
| Turns on capability to define custom buyback costs.
 
|-
 
|-
| GetDamageDoneToHero
+
| SetCustomBuybackCooldownEnabled
| <code>int GetDamageDoneToHero( int, int )</code>
+
| <code>void SetCustomBuybackCooldownEnabled( bool )</code>
|  
+
| Turns on capability to define custom buyback cooldowns.
 +
|}
 +
 
 +
 
 +
=== CBaseAnimating extends CBaseEntity ===
 +
''Animating models''
 +
 
 +
{| class="standard-table" style="width: 100;"
 +
! Function
 +
! Signature
 +
! Description
 
|-
 
|-
| GetKillsDoneToHero
+
| LookupAttachment
| <code>int GetKillsDoneToHero( int, int )</code>
+
| <code>int LookupAttachment( cstring )</code>
|  
+
| Get the named attachement id
 
|-
 
|-
| GetSelectedHeroName
+
| GetAttachmentOrigin
| <code>cstring GetSelectedHeroName( int )</code>
+
| <code>vector GetAttachmentOrigin( int )</code>
|  
+
| Get the attachement id's origin vector
 
|-
 
|-
| GetSelectedHeroID
+
| GetAttachmentAngles
| <code>int GetSelectedHeroID( int )</code>
+
| <code>vector GetAttachmentAngles( int )</code>
|  
+
| Get the attachement id's angles as a p,y,r vector
 
|-
 
|-
| IsHeroSelected
+
| IsSequenceFinished
| <code>bool IsHeroSelected( cstring )</code>
+
| <code>bool IsSequenceFinished()</code>
|  
+
| Ask whether the main sequence is done playing
 
|-
 
|-
| WhoSelectedHero
+
| SetBodygroup
| <code>int WhoSelectedHero( cstring )</code>
+
| <code>void SetBodygroup( int, int )</code>
|  
+
| Sets a bodygroup
 
|-
 
|-
| GetSelectedHeroEntity
+
| SetModelScale
| <code>hscript GetSelectedHeroEntity( int )</code>
+
| <code>void SetModelScale( float, float )</code>
|  
+
| Set the model scale
 +
|}
 +
 
 +
 
 +
=== CBaseFlex extends CBaseAnimating ===
 +
''Animated characters who have vertex flex capability.''
 +
 
 +
{| class="standard-table" style="width: 100;"
 +
! Function
 +
! Signature
 +
! Description
 
|-
 
|-
| HasSelectedHero
+
| GetCurrentScene
| <code>bool HasSelectedHero( int )</code>
+
| <code>hscript GetCurrentScene()</code>
|  
+
| Returns the instance of the oldest active scene entity (if any).
 
|-
 
|-
| GetPlayer
+
| GetSceneByIndex
| <code>hscript GetPlayer( int )</code>
+
| <code>hscript GetSceneByIndex( int )</code>
|  
+
| Returns the instance of the scene entity at the specified index.
 +
|}
 +
 
 +
 
 +
=== CDOTA_BaseNPC extends CBaseFlex ===
 +
''A Dota NPC Unit''
 +
 
 +
{| class="standard-table" style="width: 100;"
 +
! Function
 +
! Signature
 +
! Description
 
|-
 
|-
| GetNthPlayerIDOnTeam
+
| IsAncient
| <code>int GetNthPlayerIDOnTeam( int, int )</code>
+
| <code>bool IsAncient()</code>
|  
+
| Is this creature an Ancient?
 
|-
 
|-
| IncrementLastHits
+
| IsNeutralUnitType
| <code>void IncrementLastHits( int )</code>
+
| <code>bool IsNeutralUnitType()</code>
|  
+
| Is this a neutral?
 
|-
 
|-
| GetLastHits
+
| IsSummoned
| <code>int GetLastHits( int )</code>
+
| <code>bool IsSummoned()</code>
|  
+
| Is this unit summoned?
 
|-
 
|-
| IncrementGoldBagsCollected
+
| IsCreature
| <code>void IncrementGoldBagsCollected( int )</code>
+
| <code>bool IsCreature()</code>
|  
+
| Is this a Creature type NPC
 
|-
 
|-
| GetGoldBagsCollected
+
| IsHero
| <code>int GetGoldBagsCollected( int )</code>
+
| <code>bool IsHero()</code>
|  
+
| Is this a hero or hero illusion?
 
|-
 
|-
| IncrementLastHitStreak
+
| IsRealHero
| <code>void IncrementLastHitStreak( int )</code>
+
| <code>bool IsRealHero()</code>
|  
+
| Is this a real hero?
 
|-
 
|-
| ClearLastHitStreak
+
| IsTower
| <code>void ClearLastHitStreak( int )</code>
+
| <code>bool IsTower()</code>
|  
+
| Is this a tower?
 
|-
 
|-
| GetLastHitStreak
+
| IsAlive
| <code>int GetLastHitStreak( int )</code>
+
| <code>bool IsAlive()</code>
|  
+
| Is this unit alive?
 
|-
 
|-
| IncrementLastHitMultikill
+
| IsMechanical
| <code>void IncrementLastHitMultikill( int )</code>
+
| <code>bool IsMechanical()</code>
|  
+
| Is the unit mechanical?
 
|-
 
|-
| ClearLastHitMultikill
+
| IsPhantom
| <code>void ClearLastHitMultikill( int )</code>
+
| <code>bool IsPhantom()</code>
|  
+
| Is this a phantom unit?
 
|-
 
|-
| GetLastHitMultikill
+
| SetInitialGoalEntity
| <code>int GetLastHitMultikill( int )</code>
+
| <code>void SetInitialGoalEntity( hscript )</code>
|  
+
| Sets the initial waypoint goal for this NPC
 +
|-
 +
| GetInitialGoalEntity
 +
| <code>hscript GetInitialGoalEntity()</code>
 +
| Returns the initial waypoint goal for this NPC
 
|-
 
|-
| IncrementNearbyCreepDeaths
+
| SetMustReachEachGoalEntity
| <code>void IncrementNearbyCreepDeaths( int )</code>
+
| <code>void SetMustReachEachGoalEntity( bool )</code>
|  
+
| Set whether this NPC is required to reach each goal entity, rather than being allowed to 'unkink' their path
 
|-
 
|-
| GetNearbyCreepDeaths
+
| GetMustReachEachGoalEntity
| <code>int GetNearbyCreepDeaths( int )</code>
+
| <code>bool GetMustReachEachGoalEntity()</code>
|  
+
| Get whether this NPC is required to reach each goal entity, rather than being allowed to 'unkink' their path
 
|-
 
|-
| IncrementDenies
+
| AddNewModifier
| <code>void IncrementDenies( int )</code>
+
| <code>void AddNewModifier( hscript, hscript, cstring, hscript )</code>
|  
+
| Add a modifier to this unit
 
|-
 
|-
| GetDenies
+
| HasModifier
| <code>int GetDenies( int )</code>
+
| <code>bool HasModifier( cstring )</code>
|  
+
| Sees if this unit has a given modifier
 
|-
 
|-
| IncrementClaimedMisses
+
| RemoveModifierByName
| <code>void IncrementClaimedMisses( int )</code>
+
| <code>void RemoveModifierByName( cstring )</code>
|  
+
| Removes a modifier
 
|-
 
|-
| GetClaimedMisses
+
| RemoveModifierByNameAndCaster
| <code>int GetClaimedMisses( int )</code>
+
| <code>void RemoveModifierByNameAndCaster( cstring, hscript )</code>
|  
+
| Removes a modifier that was cast by the given caster
 
|-
 
|-
| IncrementClaimedDenies
+
| AddItem
| <code>void IncrementClaimedDenies( int )</code>
+
| <code>void AddItem( hscript )</code>
|  
+
| Add an item to this unit's inventory.
 
|-
 
|-
| GetClaimedDenies
+
| AddAbility
| <code>int GetClaimedDenies( int )</code>
+
| <code>void AddAbility( cstring )</code>
|  
+
| Add an ability to this unit by name.
 
|-
 
|-
| IncrementMisses
+
| RemoveAbility
| <code>void IncrementMisses( int )</code>
+
| <code>void RemoveAbility( cstring )</code>
|  
+
| Remove an ability from this unit by name.
 
|-
 
|-
| GetMisses
+
| HasAbility
| <code>int GetMisses( int )</code>
+
| <code>bool HasAbility( cstring )</code>
|  
+
| See whether this unit has an ability by name.
 
|-
 
|-
| UpdateTeamSlot
+
| FindAbilityByName
| <code>void UpdateTeamSlot( int, int )</code>
+
| <code>hscript FindAbilityByName( cstring )</code>
|  
+
| Retrieve an ability by name from the unit.
 
|-
 
|-
| GetTeam
+
| GetGoldBounty
| <code>int GetTeam( int )</code>
+
| <code>int GetGoldBounty()</code>
|  
+
| Get the gold bounty on this unit
 
|-
 
|-
| IsBroadcaster
+
| SetDeathXP
| <code>bool IsBroadcaster( int )</code>
+
| <code>void SetDeathXP( int )</code>
|  
+
| Set the XP bounty on this unit
 
|-
 
|-
| GetBroadcasterChannel
+
| GetDeathXP
| <code>uint GetBroadcasterChannel( int )</code>
+
| <code>int GetDeathXP()</code>
|  
+
| Get the XP bounty on this unit
 
|-
 
|-
| GetBroadcasterChannelSlot
+
| GetUnitName
| <code>uint GetBroadcasterChannelSlot( int )</code>
+
| <code>cstring GetUnitName()</code>
|  
+
| Get the name of this unit.
 
|-
 
|-
| GetSteamAccountID
+
| GetTeamNumber
| <code>uint GetSteamAccountID( int )</code>
+
| <code>int GetTeamNumber()</code>
|  
+
| Get the team number of this unit.
 
|-
 
|-
| IsFakeClient
+
| GetPlayerOwner
| <code>bool IsFakeClient( int )</code>
+
| <code>hscript GetPlayerOwner()</code>
|  
+
| Returns the player that owns this unit
 
|-
 
|-
| HaveAllPlayersJoined
+
| SetMaximumGoldBounty
| <code>bool HaveAllPlayersJoined()</code>
+
| <code>void SetMaximumGoldBounty( int )</code>
|  
+
| Set the maximum gold bounty for this unit.
 
|-
 
|-
| GetPlayerLoadedCompletely
+
| SetMinimumGoldBounty
| <code>bool GetPlayerLoadedCompletely( int )</code>
+
| <code>void SetMinimumGoldBounty( int )</code>
|  
+
| Set the minimum gold bounty for this unit.
 
|-
 
|-
| SetPlayerReservedState
+
| GetTotalPurchasedUpgradeGoldCost
| <code>void SetPlayerReservedState( int, bool )</code>
+
| <code>int GetTotalPurchasedUpgradeGoldCost()</code>
|  
+
| Get how much gold has been spent on ability upgrades.
 
|-
 
|-
| GetPlayerReservedState
+
| ForceKill
| <code>bool GetPlayerReservedState( int )</code>
+
| <code>void ForceKill( bool )</code>
|  
+
| Kill this unit immediately.
 
|-
 
|-
| GetConnectionState
+
| GetBaseDamageMin
| <code>unknown_variant_type GetConnectionState( int )</code>
+
| <code>int GetBaseDamageMin()</code>
|  
+
| Get the minimum attack damage of this unit.
 
|-
 
|-
| HeroLevelUp
+
| GetBaseDamageMax
| <code>void HeroLevelUp( int )</code>
+
| <code>int GetBaseDamageMax()</code>
|  
+
| Get the maximum attack damage of this unit.
 
|-
 
|-
| SetLastBuybackTime
+
| Heal
| <code>void SetLastBuybackTime( int, int )</code>
+
| <code>void Heal( float, hscript )</code>
|  
+
| Heal this unit.
 
|-
 
|-
| GetPlayerName
+
| GetMaxHealth
| <code>cstring GetPlayerName( int )</code>
+
| <code>int GetMaxHealth()</code>
|  
+
| Get the maximum health of this unit.
 +
|-
 +
| GetHealthPercent
 +
| <code>int GetHealthPercent()</code>
 +
| Get the current health percent of the unit.
 
|-
 
|-
| GetUnitShareMaskForPlayer
+
| SetMana
| <code>int GetUnitShareMaskForPlayer( int, int )</code>
+
| <code>void SetMana( float )</code>
|  
+
| Set the mana on this unit.
 
|-
 
|-
| IsHeroSharedWithPlayerID
+
| GetMaxMana
| <code>bool IsHeroSharedWithPlayerID( int, int )</code>
+
| <code>float GetMaxMana()</code>
|  
+
| Get the maximum mana of this unit.
 
|-
 
|-
| AreUnitsSharedWithPlayerID
+
| RespawnUnit
| <code>bool AreUnitsSharedWithPlayerID( int, int )</code>
+
| <code>void RespawnUnit()</code>
|  
+
| Respawns the target unit if it can be respawned.
 
|-
 
|-
| IsDisableHelpSetForPlayerID
+
| GetLevel
| <code>bool IsDisableHelpSetForPlayerID( int, int )</code>
+
| <code>int GetLevel()</code>
|  
+
| Returns the level of this unit.
 
|-
 
|-
| SetUnitShareMaskForPlayer
+
| GetItemInSlot
| <code>void SetUnitShareMaskForPlayer( int, int, int, bool )</code>
+
| <code>hscript GetItemInSlot( int )</code>
|  
+
| Returns nth item in inventory slot (index is zero based)
 
|-
 
|-
| GetNumCouriersForTeam
+
| SetOriginalModel
| <code>int GetNumCouriersForTeam( int )</code>
+
| <code>void SetOriginalModel( cstring )</code>
|  
+
| Sets the original model of this entity, which it will tend to fall back to anytime its state changes
 
|-
 
|-
| GetNthCourierForTeam
+
| AddNoDraw
| <code>hscript GetNthCourierForTeam( int, int )</code>
+
| <code>void AddNoDraw()</code>
|  
+
| Adds the no draw flag.
 
|-
 
|-
| SetBuybackCooldownTime
+
| RemoveNoDraw
| <code>void SetBuybackCooldownTime( int, float )</code>
+
| <code>void RemoveNoDraw()</code>
|  
+
| Remove the no draw flag.
 +
|-
 +
| GetPlayerOwnerID
 +
| <code>int GetPlayerOwnerID()</code>
 +
| Get the owner player ID for this unit.
 +
|-
 +
| IsRangedAttacker
 +
| <code>bool IsRangedAttacker()</code>
 +
| Is this unit a ranged attacker?
 +
|-
 +
| GetCurrentActiveAbility
 +
| <code>hscript GetCurrentActiveAbility()</code>
 +
| Get the ability this unit is currently casting.
 +
|-
 +
| MoveToPosition
 +
| <code>void MoveToPosition( vector )</code>
 +
| Issue a Move-To command
 
|-
 
|-
| SetBuybackGoldLimitTime
+
| MoveToPositionAggressive
| <code>void SetBuybackGoldLimitTime( int, float )</code>
+
| <code>void MoveToPositionAggressive( vector )</code>
|  
+
| Issue an Attack-Move-To command
 
|-
 
|-
| ResetBuybackCostTime
+
| MoveToNPC
| <code>void ResetBuybackCostTime( int )</code>
+
| <code>void MoveToNPC( hscript )</code>
|  
+
| Move to follow a unit.
 
|-
 
|-
| ReplaceHeroWith
+
| MoveToTargetToAttack
| <code>hscript ReplaceHeroWith( int, cstring, int, int )</code>
+
| <code>void MoveToTargetToAttack( hscript )</code>
| (playerID, heroClassName, gold, XP) - replaces the player's hero with a new one of the specified class, gold and XP
+
| Move to a target to attack.
 
|-
 
|-
| SetCustomBuybackCost
+
| Hold
| <code>void SetCustomBuybackCost( int, int )</code>
+
| <code>void Hold()</code>
| Set the buyback cost for this player.
+
| Hold position.
 
|-
 
|-
| SetCustomBuybackCooldown
+
| Stop
| <code>void SetCustomBuybackCooldown( int, float )</code>
+
| <code>void Stop()</code>
| Set the buyback cooldown for this player.
+
| Stop the current order.
 
|-
 
|-
| GetCustomBuybackCost
+
| CastAbilityToggle
| <code>int GetCustomBuybackCost( int )</code>
+
| <code>void CastAbilityToggle( hscript, int )</code>
|  
+
| Toggle an ability.
 
|-
 
|-
| GetCustomBuybackCooldown
+
| CastAbilityImmediately
| <code>float GetCustomBuybackCooldown( int )</code>
+
| <code>void CastAbilityImmediately( hscript, int )</code>
 +
| Cast an ability immediately.
 +
|-
 +
| CastAbilityOnPosition
 +
| <code>void CastAbilityOnPosition( vector, hscript, int )</code>
 +
| Cast an ability on a position.
 +
|-
 +
| CastAbilityOnTarget
 +
| <code>void CastAbilityOnTarget( hscript, hscript, int )</code>
 +
| Cast an ability on a target entity.
 +
|-
 +
| CastAbilityNoTarget
 +
| <code>void CastAbilityNoTarget( hscript, int )</code>
 +
| Cast an ability with no target.
 +
|-
 +
| DropItemAtPosition
 +
| <code>void DropItemAtPosition( vector, hscript )</code>
 +
| Drop an item at a given point.
 +
|-
 +
| MoveToNPCToGiveItem
 +
| <code>void MoveToNPCToGiveItem( hscript, hscript )</code>
 +
| Give an item to another unit.
 +
|-
 +
| PickupDroppedItem
 +
| <code>void PickupDroppedItem( hscript )</code>
 +
| Pick up a dropped item.
 +
|-
 +
| PickupRune
 +
| <code>void PickupRune( hscript )</code>
 +
| Pick up a rune.
 +
|-
 +
| DropItemAtPositionImmediate
 +
| <code>void DropItemAtPositionImmediate( hscript, vector )</code>
 +
| Immediately drop a carried item at a given position.
 +
|}
 +
 
 +
 
 +
=== CDOTA_BaseNPC_Building extends CDOTA_BaseNPC ===
 +
''A building.''
 +
 
 +
{| class="standard-table" style="width: 100;"
 +
! Function
 +
! Signature
 +
! Description
 +
|-
 +
| GetInvulnCount
 +
| <code>int GetInvulnCount()</code>
 +
| Get the invulnerability count for a building.
 +
|-
 +
| SetInvulnCount
 +
| <code>void SetInvulnCount( int )</code>
 +
| Set the invulnerability counter of this building.
 +
|}
 +
 
 +
 
 +
=== CDOTABaseAbility extends CBaseEntity ===
 +
''An ability''
 +
 
 +
{| class="standard-table" style="width: 100;"
 +
! Function
 +
! Signature
 +
! Description
 +
|-
 +
| GetAbilityName
 +
| <code>cstring GetAbilityName()</code>
 +
| Returns the name of this ability.
 +
|-
 +
| GetSpecialValueFor
 +
| <code>variant GetSpecialValueFor( cstring )</code>
 +
| Gets a value from this ability's special value block for its current level.
 +
|-
 +
| GetCastRange
 +
| <code>int GetCastRange()</code>
 +
| Gets the cast range of the ability.
 +
|-
 +
| IsFullyCastable
 +
| <code>bool IsFullyCastable()</code>
 +
| Returns whether the ability can be cast.
 +
|-
 +
| IsChanneling
 +
| <code>bool IsChanneling()</code>
 +
| Returns whether the ability is currently channeling.
 +
|-
 +
| IsInAbilityPhase
 +
| <code>bool IsInAbilityPhase()</code>
 +
| Returns whether the ability is currently casting.
 +
|-
 +
| GetCooldown
 +
| <code>float GetCooldown( int )</code>
 +
| Get the cooldown duration for this ability at a given level, not the amount of cooldown actually left.
 +
|-
 +
| EndCooldown
 +
| <code>void EndCooldown()</code>
 +
| Clear the cooldown remaining on this ability.
 +
|-
 +
| MarkAbilityButtonDirty
 +
| <code>void MarkAbilityButtonDirty()</code>
 +
| Mark the ability button for this ability as needing a refresh
 +
|-
 +
| SetLevel
 +
| <code>void SetLevel( int )</code>
 +
| Sets the level of this ability.
 +
|}
 +
 
 +
 
 +
=== CDOTA_BaseNPC_Creature extends CDOTA_BaseNPC ===
 +
''A Dota NPC Unit''
 +
 
 +
{| class="standard-table" style="width: 100;"
 +
! Function
 +
! Signature
 +
! Description
 +
|-
 +
| CreatureLevelUp
 +
| <code>void CreatureLevelUp( int )</code>
 +
| Level the creature up by the specified number of levels
 +
|-
 +
| AddItemDrop
 +
| <code>void AddItemDrop( hscript )</code>
 +
| Add the specified item drop to this creature
 +
|-
 +
| SetChampion
 +
| <code>void SetChampion( bool )</code>
 +
| Flag this unit as a champion creature.
 +
|-
 +
| IsChampion
 +
| <code>bool IsChampion()</code>
 +
| Is this unit a champion?
 +
|-
 +
| SetHPGain
 +
| <code>void SetHPGain( int )</code>
 +
| Set the hit points gained per level on this creature.
 +
|-
 +
| SetManaGain
 +
| <code>void SetManaGain( int )</code>
 +
| Set the mana points gained per level on this creature.
 +
|-
 +
| SetHPRegenGain
 +
| <code>void SetHPRegenGain( float )</code>
 +
| Set the hit points regen gained per level on this creature.
 +
|-
 +
| SetManaRegenGain
 +
| <code>void SetManaRegenGain( float )</code>
 +
| Set the mana points regen gained per level on this creature.
 +
|-
 +
| SetDamageGain
 +
| <code>void SetDamageGain( int )</code>
 +
| Set the damage gained per level on this creature.
 +
|-
 +
| SetArmorGain
 +
| <code>void SetArmorGain( float )</code>
 +
| Set the armor gained per level on this creature.
 +
|-
 +
| SetMagicResistanceGain
 +
| <code>void SetMagicResistanceGain( float )</code>
 +
| Set the magic resistance gained per level on this creature.
 +
|-
 +
| SetDisableResistanceGain
 +
| <code>void SetDisableResistanceGain( float )</code>
 +
| Set the disable resistance gained per level on this creature.
 +
|-
 +
| SetAttackTimeGain
 +
| <code>void SetAttackTimeGain( float )</code>
 +
| Set the attack time gained per level on this creature.
 +
|-
 +
| SetMoveSpeedGain
 +
| <code>void SetMoveSpeedGain( int )</code>
 +
| Set the move speed gained per level on this creature.
 +
|-
 +
| SetBountyGain
 +
| <code>void SetBountyGain( int )</code>
 +
| Set the bounty gold gained per level on this creature.
 +
|-
 +
| SetXPGain
 +
| <code>void SetXPGain( int )</code>
 +
| Set the xp reward gained per level on this creature.
 +
|}
 +
 
 +
 
 +
=== CDOTA_BaseNPC_Hero extends CDOTA_BaseNPC ===
 +
''A Dota Hero NPC''
 +
 
 +
{| class="standard-table" style="width: 100;"
 +
! Function
 +
! Signature
 +
! Description
 +
|-
 +
| ModifyGold
 +
| <code>int ModifyGold( int, bool, int )</code>
 +
| Gives this hero some gold
 +
|-
 +
| GetGold
 +
| <code>int GetGold()</code>
 +
| Returns gold amount for the player owning this hero
 +
|-
 +
| SetGold
 +
| <code>void SetGold( int, bool )</code>
 +
| Sets the gold amount for the player owning this hero
 +
|-
 +
| GetCurrentXP
 +
| <code>int GetCurrentXP()</code>
 +
| Returns the amount of XP
 +
|-
 +
| GetPlayerID
 +
| <code>int GetPlayerID()</code>
 +
| Returns player ID of the player owning this hero
 +
|-
 +
| RespawnHero
 +
| <code>void RespawnHero( bool, bool, bool )</code>
 +
| Respawn this hero.
 +
|-
 +
| HeroLevelUp
 +
| <code>void HeroLevelUp( bool )</code>
 +
| Levels up the hero, true or false to play effects.
 +
|-
 +
| GetAbilityPoints
 +
| <code>int GetAbilityPoints()</code>
 +
| Gets the current unspent ability points.
 +
|-
 +
| SetAbilityPoints
 +
| <code>void SetAbilityPoints( int )</code>
 +
| Sets the current unspent ability points.
 +
|-
 +
| SetCustomDeathXP
 +
| <code>void SetCustomDeathXP( int )</code>
 +
| Sets a custom experience value for this hero.  Note, GameRules boolean must be set for this to work!
 +
|}
 +
 
 +
 
 +
=== CDotaQuest extends CBaseEntity ===
 +
''A quest''
 +
 
 +
{| class="standard-table" style="width: 100;"
 +
! Function
 +
! Signature
 +
! Description
 +
|-
 +
| SetTextReplaceValue
 +
| <code>void SetTextReplaceValue( int, int )</code>
 +
| Set a quest value
 +
|-
 +
| CompleteQuest
 +
| <code>void CompleteQuest()</code>
 +
| Mark this quest complete
 +
|-
 +
| SetTextReplaceString
 +
| <code>void SetTextReplaceString( cstring )</code>
 +
| Set the text replace string for this quest
 +
|-
 +
| AddSubquest
 +
| <code>void AddSubquest( hscript )</code>
 +
| Add a subquest to this quest
 +
|-
 +
| RemoveSubquest
 +
| <code>void RemoveSubquest( hscript )</code>
 +
| Remove a subquest from this quest
 +
|-
 +
| GetSubquestByName
 +
| <code>hscript GetSubquestByName( cstring )</code>
 +
| Finds a subquest from this quest by name
 +
|-
 +
| GetSubquest
 +
| <code>hscript GetSubquest( int )</code>
 +
| Finds a subquest from this quest by index
 +
|}
 +
 
 +
 
 +
=== CDOTA_Item extends CDOTABaseAbility ===
 +
''A usable item.''
 +
 
 +
{| class="standard-table" style="width: 100;"
 +
! Function
 +
! Signature
 +
! Description
 +
|-
 +
| SetPurchaseTime
 +
| <code>void SetPurchaseTime( float )</code>
 +
| Set the purchase time of this item
 +
|-
 +
| GetPurchaseTime
 +
| <code>float GetPurchaseTime()</code>
 +
| Get the purchase time of this item
 +
|-
 +
| SetPurchaser
 +
| <code>void SetPurchaser( hscript )</code>
 +
| Set the purchaser of record for this item.
 +
|-
 +
| GetInitialCharges
 +
| <code>int GetInitialCharges()</code>
 +
| Get the initial number of charges this item has.
 +
|-
 +
| GetCurrentCharges
 +
| <code>int GetCurrentCharges()</code>
 +
| Get the number of charges this item currently has.
 +
|-
 +
| SetCurrentCharges
 +
| <code>void SetCurrentCharges( int )</code>
 +
| Set the number of charges on this item
 +
|-
 +
| GetPurchaser
 +
| <code>hscript GetPurchaser()</code>
 +
| Get the purchaser for this item.
 +
|-
 +
| Think
 +
| <code>void Think()</code>
 +
| Think this item
 +
|-
 +
| IsPermanent
 +
| <code>bool IsPermanent()</code>
 +
| Is this a permanent item?
 +
|-
 +
| StacksWithOtherOwners
 +
| <code>bool StacksWithOtherOwners()</code>
 +
|
 +
|-
 +
| SetStacksWithOtherOwners
 +
| <code>void SetStacksWithOtherOwners( bool )</code>
 +
|
 +
|-
 +
| GetShareability
 +
| <code>int GetShareability()</code>
 
|  
 
|  
 +
|-
 +
| GetCost
 +
| <code>int GetCost()</code>
 +
|
 +
|-
 +
| LaunchLoot
 +
| <code>void LaunchLoot( bool, float, float, vector )</code>
 +
|
 +
|-
 +
| GetContainer
 +
| <code>hscript GetContainer()</code>
 +
| Get the container for this item.
 +
|}
 +
 +
 +
=== CDOTA_Item_DataDriven extends CDOTA_Item ===
 +
''A data driven usable item.''
 +
 +
{| class="standard-table" style="width: 100;"
 +
! Function
 +
! Signature
 +
! Description
 +
|-
 +
| ApplyDataDrivenModifier
 +
| <code>void ApplyDataDrivenModifier( hscript, hscript, cstring, hscript )</code>
 +
| Applies a data driven modifier to the target
 +
|}
 +
 +
 +
=== CDotaSubquestBase extends CBaseEntity ===
 +
''A subquest''
 +
 +
{| class="standard-table" style="width: 100;"
 +
! Function
 +
! Signature
 +
! Description
 +
|-
 +
| SetTextReplaceValue
 +
| <code>void SetTextReplaceValue( int, int )</code>
 +
| Set a subquest value
 +
|-
 +
| CompleteSubquest
 +
| <code>void CompleteSubquest()</code>
 +
| Mark this subquest complete
 +
|-
 +
| SetTextReplaceString
 +
| <code>void SetTextReplaceString( cstring )</code>
 +
| Set the text replace string for this subquest
 +
|}
 +
 +
 +
=== CDOTAPlayer extends CBaseAnimating ===
 +
''dota_player''
 +
 +
{| class="standard-table" style="width: 100;"
 +
! Function
 +
! Signature
 +
! Description
 +
|-
 +
| GetPlayerID
 +
| <code>int GetPlayerID()</code>
 +
| Get the player's official PlayerID; notably is -1 when the player isn't yet on a team.
 +
|-
 +
| GetAssignedHero
 +
| <code>hscript GetAssignedHero()</code>
 +
| Get the player's hero.
 +
|-
 +
| SetKillCamUnit
 +
| <code>void SetKillCamUnit( hscript )</code>
 +
| Set the kill cam unit for this hero.
 +
|-
 +
| MakeRandomHeroSelection
 +
| <code>void MakeRandomHeroSelection()</code>
 +
| Randoms this player's hero.
 +
|-
 +
| SetMusicStatus
 +
| <code>void SetMusicStatus( int, float )</code>
 +
| (nMusicStatus, flIntensity) - Set the music status for this player, note this will only really apply if dota_music_battle_enable is off.
 +
|}
 +
 +
 +
=== CDOTA_Item_Physical extends CBaseAnimating ===
 +
''A physical item dropped in the world''
 +
 +
{| class="standard-table" style="width: 100;"
 +
! Function
 +
! Signature
 +
! Description
 +
|-
 +
| GetCreationTime
 +
| <code>float GetCreationTime()</code>
 +
| Returns the game time when this item was created in the world
 +
|-
 +
| GetContainedItem
 +
| <code>hscript GetContainedItem()</code>
 +
| Returned the contained item.
 +
|-
 +
| SetContainedItem
 +
| <code>void SetContainedItem( hscript )</code>
 +
| Set the contained item.
 +
|}
 +
 +
{|
 +
|-
 +
| ShowMessage
 +
| <code>void ShowMessage( cstring )</code>
 +
| Print a hud message on all clients
 +
|-
 +
| GetMapName
 +
| <code>cstring GetMapName()</code>
 +
| Get the name of the map.
 +
|-
 +
| SendToConsole
 +
| <code>void SendToConsole( cstring )</code>
 +
| Send a string to the console as a client command
 +
|-
 +
| SendToServerConsole
 +
| <code>void SendToServerConsole( cstring )</code>
 +
| Send a string to the console as a server command
 +
|-
 +
| PrintLinkedConsoleMessage
 +
| <code>void PrintLinkedConsoleMessage( cstring, cstring )</code>
 +
| Print a console message with a linked console command
 +
|-
 +
| InitLogFile
 +
| <code>void InitLogFile( cstring, cstring )</code>
 +
| If the given file doesn't exist, creates it with the given contents; does nothing if it exists
 +
|-
 +
| AppendToLogFile
 +
| <code>void AppendToLogFile( cstring, cstring )</code>
 +
| Appends a string to a log file on the server
 +
|-
 +
| GetWorldMinX
 +
| <code>float GetWorldMinX()</code>
 +
| Gets the world's minimum X position.
 +
|-
 +
| GetWorldMinY
 +
| <code>float GetWorldMinY()</code>
 +
| Gets the world's maximum Y position.
 +
|-
 +
| GetWorldMaxX
 +
| <code>float GetWorldMaxX()</code>
 +
| Gets the world's minimum X position.
 +
|-
 +
| GetWorldMaxY
 +
| <code>float GetWorldMaxY()</code>
 +
| Gets the world's maximum Y position.
 +
|-
 +
| Time
 +
| <code>float Time()</code>
 +
| Get the current server time
 +
|-
 +
| GetSystemTime
 +
| <code>cstring GetSystemTime()</code>
 +
| Get the current real world time
 +
|-
 +
| GetSystemDate
 +
| <code>cstring GetSystemDate()</code>
 +
| Get the current real world date
 +
|-
 +
| UTIL_RemoveImmediate
 +
| <code>void UTIL_RemoveImmediate( hscript )</code>
 +
| Immediately removes the specified entity
 +
|-
 +
| DoEntFire
 +
| <code>void DoEntFire( cstring, cstring, cstring, float, hscript, hscript )</code>
 +
| #EntFire:Generate and entity i/o event
 +
|-
 +
| EntFireByHandle
 +
| <code>void EntFireByHandle( hscript, cstring, cstring, float, hscript, hscript )</code>
 +
| Generate and entity i/o event
 +
|-
 +
| IsValidEntity
 +
| <code>bool IsValidEntity( hscript )</code>
 +
| Checks to see if the given hScript is a valid entity
 +
|-
 +
| IsMarkedForDeletion
 +
| <code>bool IsMarkedForDeletion( hscript )</code>
 +
| Returns true if the entity is valid and marked for deletion.
 +
|-
 +
| DoUniqueString
 +
| <code>cstring DoUniqueString( cstring )</code>
 +
| #UniqueString:Generate a string guaranteed to be unique across the life of the script VM, with an optional root string. Useful for adding data to tables when not sure what keys are already in use in that table.
 +
|-
 +
| ListenToGameEvent
 +
| <code>int ListenToGameEvent( cstring, hscript, hscript )</code>
 +
| Register as a listener for a game event from script.
 +
|-
 +
| StopListeningToGameEvent
 +
| <code>bool StopListeningToGameEvent( int )</code>
 +
| Stop listening to a particular game event.
 +
|-
 +
| FireGameEvent
 +
| <code>void FireGameEvent( cstring, hscript )</code>
 +
| Fire a game event.
 +
|-
 +
| FireGameEventLocal
 +
| <code>void FireGameEventLocal( cstring, hscript )</code>
 +
| Fire a game event without broadcasting to the client.
 +
|-
 +
| PauseGame
 +
| <code>void PauseGame( bool )</code>
 +
| Pause or unpause the game.
 +
|-
 +
| EntIndexToHScript
 +
| <code>hscript EntIndexToHScript( int )</code>
 +
| Turn an entity index integer to an HScript representing that entity's script instance.
 +
|-
 +
| PlayerInstanceFromIndex
 +
| <code>hscript PlayerInstanceFromIndex( int )</code>
 +
| Get a script instance of a player by index.
 +
|-
 +
| GetListenServerHost
 +
| <code>hscript GetListenServerHost()</code>
 +
| Get the local player on a listen server.
 +
|-
 +
| ScreenShake
 +
| <code>void ScreenShake( vector, float, float, float, float, int, bool )</code>
 +
| Start a screenshake with the following parameters. vecCenter, flAmplitude, flFrequency, flDuration, flRadius, eCommand( SHAKE_START = 0, SHAKE_STOP = 1 ), bAirShake
 +
|-
 +
| SpawnEntityFromTable
 +
| <code>bool SpawnEntityFromTable( cstring, hscript, hscript, hscript, hscript )</code>
 +
| Spawns a single entity from a table
 +
|-
 +
| SpawnEntityFromTableSync
 +
| <code>hscript SpawnEntityFromTableSync( cstring, hscript )</code>
 +
| Spawns a single entity from a table
 +
|-
 +
| SpawnEntityGroupFromTable
 +
| <code>bool SpawnEntityGroupFromTable( hscript, bool, hscript )</code>
 +
| Hierarchically spawn an entity group from a set of spawn tables.
 +
|-
 +
| PrecacheEntityFromTable
 +
| <code>bool PrecacheEntityFromTable( hscript )</code>
 +
| Precache an entity from KeyValues in table
 +
|-
 +
| PrecacheResource
 +
| <code>void PrecacheResource( cstring, cstring )</code>
 +
| Manually precache a single resource
 +
|-
 +
| VectorToAngles
 +
| <code>qangle VectorToAngles( vector )</code>
 +
| Get Qangles (with no roll) for a Vector.
 +
|-
 +
| RotatePosition
 +
| <code>vector RotatePosition( vector, qangle, vector )</code>
 +
| Rotate a Vector around a point.
 +
|-
 +
| RotateOrientation
 +
| <code>qangle RotateOrientation( qangle, qangle )</code>
 +
| Rotate a QAngle by another QAngle.
 +
|-
 +
| RotationDelta
 +
| <code>qangle RotationDelta( qangle, qangle )</code>
 +
| Find the delta between two angles.
 +
|-
 +
| EmitSoundOn
 +
| <code>void EmitSoundOn( cstring, hscript )</code>
 +
| Play named sound on Entity
 +
|-
 +
| EmitSoundOnClient
 +
| <code>void EmitSoundOnClient( cstring, hscript )</code>
 +
| Play named sound only on the client for the passed in player
 +
|-
 +
| EmitGlobalSound
 +
| <code>void EmitGlobalSound( cstring )</code>
 +
| Play named sound for all players
 +
|-
 +
| StopSoundOn
 +
| <code>void StopSoundOn( cstring, hscript )</code>
 +
| Stop named sound on Entity
 +
|-
 +
| GetPhysVelocity
 +
| <code>vector GetPhysVelocity( hscript )</code>
 +
| Get Velocity for VPHYS or normal object
 +
|-
 +
| GetPhysAngularVelocity
 +
| <code>vector GetPhysAngularVelocity( hscript )</code>
 +
| Get Angular Velocity for VPHYS or normal object
 +
|-
 +
| Say
 +
| <code>void Say( hscript, cstring, bool )</code>
 +
| Have Entity say string, and teamOnly or not
 +
|-
 +
| AddThinkToEnt
 +
| <code>void AddThinkToEnt( hscript, cstring )</code>
 +
| Adds a late bound think function to the C++ think tables for the obj
 +
|-
 +
| LoadKeyValues
 +
| <code>variant LoadKeyValues( cstring )</code>
 +
| Creates a table from the specified keyvalues text file
 +
|-
 +
| LoadKeyValuesFromString
 +
| <code>variant LoadKeyValuesFromString( cstring )</code>
 +
| Creates a table from the specified keyvalues string
 +
|-
 +
| DebugDrawScreenTextLine
 +
| <code>void DebugDrawScreenTextLine( float, float, int, cstring, int, int, int, int, float )</code>
 +
| Draw text with a line offset (x, y, lineOffset, text, r, g, b, a, duration)
 +
|-
 +
| DebugDrawText
 +
| <code>void DebugDrawText( vector, cstring, bool, float )</code>
 +
| Draw text in 3d (origin, text, bViewCheck, duration)
 +
|-
 +
| DebugDrawBox
 +
| <code>void DebugDrawBox( vector, vector, vector, int, int, int, int, float )</code>
 +
| Draw a debug overlay box (origin, mins, maxs, forward, r, g, b, a, duration )
 +
|-
 +
| DebugDrawLine
 +
| <code>void DebugDrawLine( vector, vector, int, int, int, bool, float )</code>
 +
| Draw a debug overlay line (origin, target, r, g, b, ztest, duration)
 +
|-
 +
| DebugDrawCircle
 +
| <code>void DebugDrawCircle( vector, vector, float, float, bool, float )</code>
 +
| Draw a debug circle (center, vRgb, a, rad, a, ztest, duration)
 +
|-
 +
| DebugDrawLine_vCol
 +
| <code>void DebugDrawLine_vCol( vector, vector, vector, bool, float )</code>
 +
| Draw a debug line using color vec (start, end, vRgb, a, ztest, duration)
 +
|-
 +
| DebugDrawBoxDirection
 +
| <code>void DebugDrawBoxDirection( vector, vector, vector, vector, vector, float, float )</code>
 +
| Draw a debug forward box (cent, min, max, forward, vRgb, a, duration)
 +
|-
 +
| DebugDrawClear
 +
| <code>void DebugDrawClear()</code>
 +
| Try to clear all the debug overlay info
 +
|-
 +
| GetFrameCount
 +
| <code>int GetFrameCount()</code>
 +
| Returns the engines current frame count
 +
|-
 +
| IsDedicatedServer
 +
| <code>bool IsDedicatedServer()</code>
 +
| Returns true if this server is a dedicated server.
 +
|-
 +
| CreateUnitByName
 +
| <code>hscript CreateUnitByName( cstring, vector, bool, hscript, hscript, int )</code>
 +
| Creates a DOTA unit by its dota_npc_units.txt name
 +
|-
 +
| PrecacheUnitByName
 +
| <code>bool PrecacheUnitByName( cstring )</code>
 +
| Precaches a DOTA unit by its dota_npc_units.txt name
 +
|-
 +
| CreateHeroForPlayer
 +
| <code>hscript CreateHeroForPlayer( cstring, hscript )</code>
 +
| Creates a DOTA hero by its dota_npc_units.txt name and sets it as the given player's controlled hero
 +
|-
 +
| CreateItem
 +
| <code>hscript CreateItem( cstring, hscript, hscript )</code>
 +
| Create a DOTA item
 +
|-
 +
| CreateItemOnPosition
 +
| <code>hscript CreateItemOnPosition( vector )</code>
 +
| Create a physical item at a given location
 +
|-
 +
| FindClearSpaceForUnit
 +
| <code>void FindClearSpaceForUnit( hscript, vector, bool )</code>
 +
| Place a unit somewhere not already occupied.
 +
|-
 +
| FindUnitsInRadius
 +
| <code>variant FindUnitsInRadius( int, vector, hscript, float, int, int, int, int, bool )</code>
 +
| Finds the units in a given radius with the given flags.
 +
|-
 +
| PrecacheUnit
 +
| <code>void PrecacheUnit( cstring )</code>
 +
| Precaches all the resources for a given unit.
 +
|-
 +
| GetFrostyPointsForRound
 +
| <code>int GetFrostyPointsForRound( int, int, int )</code>
 +
|
 +
|-
 +
| GetGoldFrostyPointsForRound
 +
| <code>int GetGoldFrostyPointsForRound( int, int, int )</code>
 +
|
 +
|-
 +
| GetFrostyBoostAmount
 +
| <code>float GetFrostyBoostAmount( int, int )</code>
 +
|
 +
|-
 +
| GetGoldFrostyBoostAmount
 +
| <code>float GetGoldFrostyBoostAmount( int, int )</code>
 +
|
 +
|-
 +
| SendFrostyPointsMessageToGC
 +
| <code>void SendFrostyPointsMessageToGC( hscript )</code>
 +
|
 +
|-
 +
| SendFrostivusTimeElapsedToGC
 +
| <code>void SendFrostivusTimeElapsedToGC()</code>
 +
|
 +
|-
 +
| ExecuteOrderFromTable
 +
| <code>void ExecuteOrderFromTable( hscript )</code>
 +
| Issue an order from a script table
 +
|-
 +
| ShowGenericPopup
 +
| <code>void ShowGenericPopup( cstring, cstring, cstring, cstring, int )</code>
 +
| Show a generic popup dialog for all players.
 +
|-
 +
| ShowGenericPopupToPlayer
 +
| <code>void ShowGenericPopupToPlayer( hscript, cstring, cstring, cstring, cstring, int )</code>
 +
| Show a generic popup dialog to a specific player.
 
|}
 
|}

Latest revision as of 20:15, 28 January 2014

|- | RandomInt | int RandomInt( int, int ) | Get a random int within a range |- | RandomFloat | float RandomFloat( float, float ) | Get a random float within a range |- | RandomVector | vector RandomVector( float ) | Get a random vector within a range |- | RollPercentage | bool RollPercentage( int ) | Rolls a number from 1 to 100 and returns true if the roll is less than or equal to the number specified

CScriptParticleManager

!Used to create and manage particle effects

Function Signature Description
CreateParticle int CreateParticle( cstring, int, hscript ) Creates a new particle effect
CreateParticleForPlayer int CreateParticleForPlayer( cstring, int, hscript, hscript ) Creates a new particle effect that only plays for the specified player
SetParticleControl void SetParticleControl( int, int, vector ) Set the control point data for a control on a particle effect
ReleaseParticleIndex void ReleaseParticleIndex( int ) Frees the specified particle index

|- | DoIncludeScript | bool DoIncludeScript( cstring, hscript ) | Execute a script (internal)

CEntityScriptFramework

C-side of entity framework


CEntities

!The global list of entities

Function Signature Description
First hscript First() Begin an iteration over the list of entities
Next hscript Next( hscript ) Continue an iteration over the list of entities, providing reference to a previously found entity
CreateByClassname hscript CreateByClassname( cstring ) Creates an entity by classname
FindByClassname hscript FindByClassname( hscript, cstring ) Find entities by class name. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search
FindAllByClassname variant FindAllByClassname( cstring ) Find entities by class name.
FindByName hscript FindByName( hscript, cstring ) Find entities by name. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search
FindAllByName variant FindAllByName( cstring ) Find entities by name; returns an array of everything found.
FindInSphere hscript FindInSphere( hscript, vector, float ) Find entities within a radius. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search
FindAllInSphere variant FindAllInSphere( vector, float ) Find entities within a radius.
FindByTarget hscript FindByTarget( hscript, cstring ) Find entities by targetname. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search
FindAllByTarget variant FindAllByTarget( cstring ) Find entities by targetname.
FindByModel hscript FindByModel( hscript, cstring ) Find entities by model name. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search
FindAllByModel variant FindAllByModel( cstring ) Find entities by model name.
FindByNameNearest hscript FindByNameNearest( cstring, vector, float ) Find entities by name nearest to a point.
FindByNameWithin hscript FindByNameWithin( hscript, cstring, vector, float ) Find entities by name within a radius. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search
FindAllByNameWithin variant FindAllByNameWithin( cstring, vector, float ) Find entities by name within a radius.
FindByClassnameNearest hscript FindByClassnameNearest( cstring, vector, float ) Find entities by class name nearest to a point.
FindByClassnameWithin hscript FindByClassnameWithin( hscript, cstring, vector, float ) Find entities by class name within a radius. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search
FindAllByClassnameWithin variant FindAllByClassnameWithin( cstring, vector, float ) Find entities by class name within a radius.


Convars

!Access to convar functions

Function Signature Description
GetFloat variant GetFloat( cstring ) GetFloat(name) : returns the convar as a float. May return null if no such convar.
GetStr variant GetStr( cstring ) GetFloat(name) : returns the convar as a string. May return null if no such convar.
GetBool variant GetBool( cstring ) GetBool(name) : returns the convar as a boolean flag.
RegisterCommand void RegisterCommand( cstring, hscript, cstring, int ) RegisterCommand(name, fn, helpString, flags) : register a console command.
RegisterConvar void RegisterConvar( cstring, cstring, cstring, int ) RegisterConvar(name, defaultValue, helpString, flags): register a new console variable.
GetCommandClient hscript GetCommandClient() GetCommandClient() : returns the player who issued this console command.
GetDOTACommandClient hscript GetDOTACommandClient() GetDOTACommandClient() : returns the DOTA player who issued this console command.


CScriptHeroList

!The global list of heroes

Function Signature Description
GetHero hscript GetHero( int ) Get the Nth hero in the Hero List
GetHeroCount int GetHeroCount() Returns the number of heroes in the world
GetAllHeroes variant GetAllHeroes() Returns all the heroes in the world


CDOTAGamerules

!DOTA GameRules

Function Signature Description
State_Get unknown_variant_type State_Get() Get the current Gamerules state
GetGameTime float GetGameTime() Returns the number of seconds elapsed since map start. This time doesn't count up when the game is paused
GetDifficulty int GetDifficulty() Returns difficulty level of the custom game mode
GetCustomGameDifficulty int GetCustomGameDifficulty() Returns the difficulty level of the custom game mode
Defeated void Defeated() Kills the ancient, etc.
ResetDefeated void ResetDefeated() Restart after killing the ancient, etc.
SetGameWinner void SetGameWinner( int ) Makes ths specified team win
MakeTeamLose void MakeTeamLose( int ) Makes ths specified team lose
ResetMap void ResetMap( int ) Resets the map in one of several ways
GetDroppedItem hscript GetDroppedItem( int ) Gets the Xth dropped item
NumDroppedItems int NumDroppedItems() Returns the number of items currently dropped on the ground
SendCustomMessage void SendCustomMessage( cstring, int, int ) Sends a string to the defined team.
SetHeroRespawnEnabled void SetHeroRespawnEnabled( bool ) Control if the normal DOTA hero respawn rules apply.
Playtesting_UpdateCustomKeyValues void Playtesting_UpdateCustomKeyValues() Updates custom hero, unit and ability KeyValues in memory with the latest values from disk
ResetToHeroSelection void ResetToHeroSelection() Restart the game at hero selection
SetTreeRegrowTime void SetTreeRegrowTime( float ) Sets the tree regrow time in seconds.
SetHeroSelectionTime void SetHeroSelectionTime( float ) Sets the amount of time players have to pick their hero.
SetPreGameTime void SetPreGameTime( float ) Sets the amount of time players have between picking their hero and game start.
SetPostGameTime void SetPostGameTime( float ) Sets the amount of time players have between the game ending and the server disconnecting them.
SetRuneSpawnTime void SetRuneSpawnTime( float ) Sets the amount of time between rune spawns.
SetSameHeroSelectionEnabled void SetSameHeroSelectionEnabled( bool ) When true, players can repeatedly pick the same hero.
SetUseUniversalShopMode void SetUseUniversalShopMode( bool ) When true, all items are available at as long as any shop is in range.
SetTimeOfDay void SetTimeOfDay( float ) Set the time of day.
SetOverlayHealthBarUnit void SetOverlayHealthBarUnit( hscript, int ) Show this unit's health on the overlay health bar
SetHeroMinimapIconSize void SetHeroMinimapIconSize( int ) (nMinimapHeroIconSize) - Set the hero minimap icon size.
SetCreepMinimapIconScale void SetCreepMinimapIconScale( float ) (flMinimapCreepIconScale) - Scale the creep icons on the minimap.
SetRuneMinimapIconScale void SetRuneMinimapIconScale( float ) (flMinimapRuneIconScale) - Scale the rune icons on the minimap.
SetSafeToLeave void SetSafeToLeave( bool ) (bSafeToLeave) - Mark this game as safe to leave.
SetUseCustomHeroXPValues void SetUseCustomHeroXPValues( bool ) Allows heroes in the map to give a specific amount of XP (this value must be set).
SetCustomGameDifficulty void SetCustomGameDifficulty( int ) Set the difficulty level of the custom game mode


CDOTAVoteSystem

!DOTA Vote System

Function Signature Description
StartVote void StartVote( hscript ) Starts a vote, based upon a table of parameters


CBaseEntity

Root class of all server-side entities

Function Signature Description
ConnectOutput void ConnectOutput( cstring, cstring ) Adds an I/O connection that will call the named function when the specified output fires
DisconnectOutput void DisconnectOutput( cstring, cstring ) Removes a connected script function from an I/O event.
GetHealth int GetHealth()
SetHealth void SetHealth( int )
GetMaxHealth int GetMaxHealth()
SetMaxHealth void SetMaxHealth( int )
IsAlive bool IsAlive()
Remove void Remove()
SetModel void SetModel( cstring )
GetModelName cstring GetModelName() Returns the name of the model
EmitSound void EmitSound( cstring ) Plays a sound from this entity.
EmitSoundParams void EmitSoundParams( cstring, int, float ) Plays/modifies a sound from this entity. changes sound if nPitch and/or flVol is > 0.
StopSound void StopSound( cstring ) Stops a named sound playing from this entity.
PrecacheSoundScript void PrecacheSoundScript( cstring ) Precache a sound for later playing.
GetSoundDuration float GetSoundDuration( cstring, cstring ) Returns float duration of the sound. Takes soundname and optional actormodelname.
GetClassname cstring GetClassname()
GetName cstring GetName()
GetPreTemplateName cstring GetPreTemplateName() Get the entity name stripped of template unique decoration
GetAbsOrigin vector GetAbsOrigin()
SetAbsOrigin void SetAbsOrigin( vector )
GetOrigin vector GetOrigin()
SetAbsOrigin void SetAbsOrigin( vector ) SetOrigin
SetOrigin void SetOrigin( vector )
GetForwardVector vector GetForwardVector() Get the forward vector of the entity
GetRightVector vector GetRightVector() Get the right vector of the entity
GetUpVector vector GetUpVector() Get the up vector of the entity
SetForwardVector void SetForwardVector( vector ) Set the orientation of the entity to have this forward vector
GetVelocity vector GetVelocity()
SetVelocity void SetVelocity( vector )
SetAngularVelocity void SetAngularVelocity( float, float, float ) Set the local angular velocity - takes float pitch,yaw,roll velocities
GetAngularVelocity vector GetAngularVelocity() Get the local angular velocity - returns a vector of pitch,yaw,roll
GetCenter vector GetCenter() Get vector to center of object - absolute coords
EyePosition vector EyePosition() Get vector to eye position - absolute coords
SetAngles void SetAngles( float, float, float ) Set entity pitch, yaw, roll
GetAngles vector GetAngles() Get entity pitch, yaw, roll as a vector
SetSize void SetSize( vector, vector )
GetBoundingMins vector GetBoundingMins() Get a vector containing min bounds, centered on object
GetBoundingMaxs vector GetBoundingMaxs() Get a vector containing max bounds, centered on object
Destroy void Destroy()
SetOwner void SetOwner( hscript )
GetTeam int GetTeam()
SetTeam void SetTeam( int )
GetMoveParent hscript GetMoveParent() If in hierarchy, retrieves the entity's parent
GetRootMoveParent hscript GetRootMoveParent() If in hierarchy, walks up the hierarchy to find the root parent
FirstMoveChild hscript FirstMoveChild()
NextMovePeer hscript NextMovePeer()
__KeyValueFromString bool __KeyValueFromString( cstring, cstring ) @
__KeyValueFromFloat bool __KeyValueFromFloat( cstring, float ) @
__KeyValueFromInt bool __KeyValueFromInt( cstring, int ) @
__KeyValueFromVector bool __KeyValueFromVector( cstring, vector ) @
Trigger void Trigger() Fires off this entity's OnTrigger responses
ValidateScriptScope bool ValidateScriptScope() Ensure that an entity's script scope has been created
GetScriptScope hscript GetScriptScope() Retrieve the script-side data associated with an entity
GetScriptId cstring GetScriptId() Retrieve the unique identifier used to refer to the entity within the scripting system
GetOwner hscript GetOwner() Gets this entity's owner
SetOwner void SetOwner( hscript ) Sets this entity's owner
entindex unknown_variant_type entindex()


CDOTA_PlayerResource extends CBaseEntity

Interface to player data

Function Signature Description
SetHasRepicked void SetHasRepicked( int )
HasRepicked bool HasRepicked( int )
SetHasRandomed void SetHasRandomed( int )
HasRandomed bool HasRandomed( int )
IsValidTeamPlayerID bool IsValidTeamPlayerID( int )
IsValidTeamPlayer bool IsValidTeamPlayer( int )
IsValidPlayerID bool IsValidPlayerID( int )
IsValidPlayer bool IsValidPlayer( int )
GetLevel int GetLevel( int )
IncrementKills void IncrementKills( int, int )
IncrementAssists void IncrementAssists( int )
IncrementDeaths void IncrementDeaths( int )
GetKills int GetKills( int )
GetAssists int GetAssists( int )
GetDeaths int GetDeaths( int )
GetStuns float GetStuns( int )
GetHealing float GetHealing( int )
GetTowerKills int GetTowerKills( int )
GetRoshanKills int GetRoshanKills( int )
GetTeamKills int GetTeamKills( int )
IncrementStreak void IncrementStreak( int )
ClearStreak void ClearStreak( int )
GetStreak int GetStreak( int )
ModifyGold int ModifyGold( int, int, bool, int )
SetGold void SetGold( int, int, bool )
SpendGold void SpendGold( int, int, int )
GetGold int GetGold( int )
GetReliableGold int GetReliableGold( int )
GetUnreliableGold int GetUnreliableGold( int )
ResetTotalEarnedGold void ResetTotalEarnedGold( int )
GetTotalEarnedGold int GetTotalEarnedGold( int )
GetTotalGoldSpent int GetTotalGoldSpent( int )
AddGoldSpentOnSupport void AddGoldSpentOnSupport( int, int )
GetGoldSpentOnSupport int GetGoldSpentOnSupport( int )
GetGoldSpentOnConsumables int GetGoldSpentOnConsumables( int )
GetGoldSpentOnItems int GetGoldSpentOnItems( int )
GetGoldLostToDeath int GetGoldLostToDeath( int )
GetGoldSpentOnBuybacks int GetGoldSpentOnBuybacks( int )
GetGoldPerMin float GetGoldPerMin( int )
GetXPPerMin float GetXPPerMin( int )
GetAegisPickups int GetAegisPickups( int )
AddAegisPickup void AddAegisPickup( int )
GetRunePickups int GetRunePickups( int )
AddRunePickup void AddRunePickup( int )
GetNumConsumablesPurchased int GetNumConsumablesPurchased( int )
GetNumItemsPurchased int GetNumItemsPurchased( int )
GetTimeOfLastItemPurchase float GetTimeOfLastItemPurchase( int )
GetTimeOfLastConsumablePurchase float GetTimeOfLastConsumablePurchase( int )
GetTimeOfLastDeath float GetTimeOfLastDeath( int )
GetRespawnSeconds int GetRespawnSeconds( int )
IncrementTotalEarnedXP void IncrementTotalEarnedXP( int, int )
GetTotalEarnedXP int GetTotalEarnedXP( int )
AddClaimedFarm void AddClaimedFarm( int, float )
GetClaimedFarm float GetClaimedFarm( int )
GetRawPlayerDamage int GetRawPlayerDamage( int )
ClearRawPlayerDamageMatrix void ClearRawPlayerDamageMatrix( int )
ClearKillsMatrix void ClearKillsMatrix( int )
GetTowerDamageTaken int GetTowerDamageTaken( int )
GetCreepDamageTaken int GetCreepDamageTaken( int )
GetHeroDamageTaken int GetHeroDamageTaken( int )
GetDamageDoneToHero int GetDamageDoneToHero( int, int )
GetKillsDoneToHero int GetKillsDoneToHero( int, int )
GetSelectedHeroName cstring GetSelectedHeroName( int )
GetSelectedHeroID int GetSelectedHeroID( int )
IsHeroSelected bool IsHeroSelected( cstring )
WhoSelectedHero int WhoSelectedHero( cstring )
GetSelectedHeroEntity hscript GetSelectedHeroEntity( int )
HasSelectedHero bool HasSelectedHero( int )
GetPlayer hscript GetPlayer( int )
GetNthPlayerIDOnTeam int GetNthPlayerIDOnTeam( int, int )
IncrementLastHits void IncrementLastHits( int )
GetLastHits int GetLastHits( int )
IncrementGoldBagsCollected void IncrementGoldBagsCollected( int )
GetGoldBagsCollected int GetGoldBagsCollected( int )
IncrementLastHitStreak void IncrementLastHitStreak( int )
ClearLastHitStreak void ClearLastHitStreak( int )
GetLastHitStreak int GetLastHitStreak( int )
IncrementLastHitMultikill void IncrementLastHitMultikill( int )
ClearLastHitMultikill void ClearLastHitMultikill( int )
GetLastHitMultikill int GetLastHitMultikill( int )
IncrementNearbyCreepDeaths void IncrementNearbyCreepDeaths( int )
GetNearbyCreepDeaths int GetNearbyCreepDeaths( int )
IncrementDenies void IncrementDenies( int )
GetDenies int GetDenies( int )
IncrementClaimedMisses void IncrementClaimedMisses( int )
GetClaimedMisses int GetClaimedMisses( int )
IncrementClaimedDenies void IncrementClaimedDenies( int )
GetClaimedDenies int GetClaimedDenies( int )
IncrementMisses void IncrementMisses( int )
GetMisses int GetMisses( int )
UpdateTeamSlot void UpdateTeamSlot( int, int )
GetTeam int GetTeam( int )
IsBroadcaster bool IsBroadcaster( int )
GetBroadcasterChannel uint GetBroadcasterChannel( int )
GetBroadcasterChannelSlot uint GetBroadcasterChannelSlot( int )
GetSteamAccountID uint GetSteamAccountID( int )
IsFakeClient bool IsFakeClient( int )
HaveAllPlayersJoined bool HaveAllPlayersJoined()
GetPlayerLoadedCompletely bool GetPlayerLoadedCompletely( int )
SetPlayerReservedState void SetPlayerReservedState( int, bool )
GetPlayerReservedState bool GetPlayerReservedState( int )
GetConnectionState unknown_variant_type GetConnectionState( int )
HeroLevelUp void HeroLevelUp( int )
SetLastBuybackTime void SetLastBuybackTime( int, int )
GetPlayerName cstring GetPlayerName( int )
GetUnitShareMaskForPlayer int GetUnitShareMaskForPlayer( int, int )
IsHeroSharedWithPlayerID bool IsHeroSharedWithPlayerID( int, int )
AreUnitsSharedWithPlayerID bool AreUnitsSharedWithPlayerID( int, int )
IsDisableHelpSetForPlayerID bool IsDisableHelpSetForPlayerID( int, int )
SetUnitShareMaskForPlayer void SetUnitShareMaskForPlayer( int, int, int, bool )
GetNumCouriersForTeam int GetNumCouriersForTeam( int )
GetNthCourierForTeam hscript GetNthCourierForTeam( int, int )
SetBuybackCooldownTime void SetBuybackCooldownTime( int, float )
SetBuybackGoldLimitTime void SetBuybackGoldLimitTime( int, float )
ResetBuybackCostTime void ResetBuybackCostTime( int )
ReplaceHeroWith hscript ReplaceHeroWith( int, cstring, int, int ) (playerID, heroClassName, gold, XP) - replaces the player's hero with a new one of the specified class, gold and XP
SetCustomBuybackCost void SetCustomBuybackCost( int, int ) Set the buyback cost for this player.
SetCustomBuybackCooldown void SetCustomBuybackCooldown( int, float ) Set the buyback cooldown for this player.
GetCustomBuybackCost int GetCustomBuybackCost( int )
GetCustomBuybackCooldown float GetCustomBuybackCooldown( int )


CDOTABaseGameMode extends CBaseEntity

Base game mode class

Function Signature Description
BeginThink bool BeginThink( cstring, hscript, float ) Start a think callback. Takes a function and an interval
EndThink void EndThink( cstring ) Stop a think callback.
SetAlwaysShowPlayerInventory void SetAlwaysShowPlayerInventory( bool ) Show the player hero's inventory in the HUD, regardless of what unit is selected.
SetGoldSoundDisabled void SetGoldSoundDisabled( bool ) Turn the sound when gold is acquired off/on. Takes a bool.
SetRecommendedItemsDisabled void SetRecommendedItemsDisabled( bool ) Turn the panel for showing recommended items at the shop off/on. Takes a bool.
SetCameraDistanceOverride void SetCameraDistanceOverride( float ) Set a different camera distance; dota default is 1134.
SetOverrideSelectionEntity void SetOverrideSelectionEntity( hscript ) Set an override for the default selection entity, instead of each player's hero.
SetRemoveIllusionsOnDeath void SetRemoveIllusionsOnDeath( bool ) Make it so illusions are immediately removed upon death, rather than sticking around for a few seconds.
ClientLoadGridNav void ClientLoadGridNav() Tell clients that they need to load gridnav information. Used for things like allowing clients to identify valid locations to place buildings.
SetFogOfWarDisabled void SetFogOfWarDisabled( bool ) Turn the fog of war on or off.
SetCustomBuybackCostEnabled void SetCustomBuybackCostEnabled( bool ) Turns on capability to define custom buyback costs.
SetCustomBuybackCooldownEnabled void SetCustomBuybackCooldownEnabled( bool ) Turns on capability to define custom buyback cooldowns.


CBaseAnimating extends CBaseEntity

Animating models

Function Signature Description
LookupAttachment int LookupAttachment( cstring ) Get the named attachement id
GetAttachmentOrigin vector GetAttachmentOrigin( int ) Get the attachement id's origin vector
GetAttachmentAngles vector GetAttachmentAngles( int ) Get the attachement id's angles as a p,y,r vector
IsSequenceFinished bool IsSequenceFinished() Ask whether the main sequence is done playing
SetBodygroup void SetBodygroup( int, int ) Sets a bodygroup
SetModelScale void SetModelScale( float, float ) Set the model scale


CBaseFlex extends CBaseAnimating

Animated characters who have vertex flex capability.

Function Signature Description
GetCurrentScene hscript GetCurrentScene() Returns the instance of the oldest active scene entity (if any).
GetSceneByIndex hscript GetSceneByIndex( int ) Returns the instance of the scene entity at the specified index.


CDOTA_BaseNPC extends CBaseFlex

A Dota NPC Unit

Function Signature Description
IsAncient bool IsAncient() Is this creature an Ancient?
IsNeutralUnitType bool IsNeutralUnitType() Is this a neutral?
IsSummoned bool IsSummoned() Is this unit summoned?
IsCreature bool IsCreature() Is this a Creature type NPC
IsHero bool IsHero() Is this a hero or hero illusion?
IsRealHero bool IsRealHero() Is this a real hero?
IsTower bool IsTower() Is this a tower?
IsAlive bool IsAlive() Is this unit alive?
IsMechanical bool IsMechanical() Is the unit mechanical?
IsPhantom bool IsPhantom() Is this a phantom unit?
SetInitialGoalEntity void SetInitialGoalEntity( hscript ) Sets the initial waypoint goal for this NPC
GetInitialGoalEntity hscript GetInitialGoalEntity() Returns the initial waypoint goal for this NPC
SetMustReachEachGoalEntity void SetMustReachEachGoalEntity( bool ) Set whether this NPC is required to reach each goal entity, rather than being allowed to 'unkink' their path
GetMustReachEachGoalEntity bool GetMustReachEachGoalEntity() Get whether this NPC is required to reach each goal entity, rather than being allowed to 'unkink' their path
AddNewModifier void AddNewModifier( hscript, hscript, cstring, hscript ) Add a modifier to this unit
HasModifier bool HasModifier( cstring ) Sees if this unit has a given modifier
RemoveModifierByName void RemoveModifierByName( cstring ) Removes a modifier
RemoveModifierByNameAndCaster void RemoveModifierByNameAndCaster( cstring, hscript ) Removes a modifier that was cast by the given caster
AddItem void AddItem( hscript ) Add an item to this unit's inventory.
AddAbility void AddAbility( cstring ) Add an ability to this unit by name.
RemoveAbility void RemoveAbility( cstring ) Remove an ability from this unit by name.
HasAbility bool HasAbility( cstring ) See whether this unit has an ability by name.
FindAbilityByName hscript FindAbilityByName( cstring ) Retrieve an ability by name from the unit.
GetGoldBounty int GetGoldBounty() Get the gold bounty on this unit
SetDeathXP void SetDeathXP( int ) Set the XP bounty on this unit
GetDeathXP int GetDeathXP() Get the XP bounty on this unit
GetUnitName cstring GetUnitName() Get the name of this unit.
GetTeamNumber int GetTeamNumber() Get the team number of this unit.
GetPlayerOwner hscript GetPlayerOwner() Returns the player that owns this unit
SetMaximumGoldBounty void SetMaximumGoldBounty( int ) Set the maximum gold bounty for this unit.
SetMinimumGoldBounty void SetMinimumGoldBounty( int ) Set the minimum gold bounty for this unit.
GetTotalPurchasedUpgradeGoldCost int GetTotalPurchasedUpgradeGoldCost() Get how much gold has been spent on ability upgrades.
ForceKill void ForceKill( bool ) Kill this unit immediately.
GetBaseDamageMin int GetBaseDamageMin() Get the minimum attack damage of this unit.
GetBaseDamageMax int GetBaseDamageMax() Get the maximum attack damage of this unit.
Heal void Heal( float, hscript ) Heal this unit.
GetMaxHealth int GetMaxHealth() Get the maximum health of this unit.
GetHealthPercent int GetHealthPercent() Get the current health percent of the unit.
SetMana void SetMana( float ) Set the mana on this unit.
GetMaxMana float GetMaxMana() Get the maximum mana of this unit.
RespawnUnit void RespawnUnit() Respawns the target unit if it can be respawned.
GetLevel int GetLevel() Returns the level of this unit.
GetItemInSlot hscript GetItemInSlot( int ) Returns nth item in inventory slot (index is zero based)
SetOriginalModel void SetOriginalModel( cstring ) Sets the original model of this entity, which it will tend to fall back to anytime its state changes
AddNoDraw void AddNoDraw() Adds the no draw flag.
RemoveNoDraw void RemoveNoDraw() Remove the no draw flag.
GetPlayerOwnerID int GetPlayerOwnerID() Get the owner player ID for this unit.
IsRangedAttacker bool IsRangedAttacker() Is this unit a ranged attacker?
GetCurrentActiveAbility hscript GetCurrentActiveAbility() Get the ability this unit is currently casting.
MoveToPosition void MoveToPosition( vector ) Issue a Move-To command
MoveToPositionAggressive void MoveToPositionAggressive( vector ) Issue an Attack-Move-To command
MoveToNPC void MoveToNPC( hscript ) Move to follow a unit.
MoveToTargetToAttack void MoveToTargetToAttack( hscript ) Move to a target to attack.
Hold void Hold() Hold position.
Stop void Stop() Stop the current order.
CastAbilityToggle void CastAbilityToggle( hscript, int ) Toggle an ability.
CastAbilityImmediately void CastAbilityImmediately( hscript, int ) Cast an ability immediately.
CastAbilityOnPosition void CastAbilityOnPosition( vector, hscript, int ) Cast an ability on a position.
CastAbilityOnTarget void CastAbilityOnTarget( hscript, hscript, int ) Cast an ability on a target entity.
CastAbilityNoTarget void CastAbilityNoTarget( hscript, int ) Cast an ability with no target.
DropItemAtPosition void DropItemAtPosition( vector, hscript ) Drop an item at a given point.
MoveToNPCToGiveItem void MoveToNPCToGiveItem( hscript, hscript ) Give an item to another unit.
PickupDroppedItem void PickupDroppedItem( hscript ) Pick up a dropped item.
PickupRune void PickupRune( hscript ) Pick up a rune.
DropItemAtPositionImmediate void DropItemAtPositionImmediate( hscript, vector ) Immediately drop a carried item at a given position.


CDOTA_BaseNPC_Building extends CDOTA_BaseNPC

A building.

Function Signature Description
GetInvulnCount int GetInvulnCount() Get the invulnerability count for a building.
SetInvulnCount void SetInvulnCount( int ) Set the invulnerability counter of this building.


CDOTABaseAbility extends CBaseEntity

An ability

Function Signature Description
GetAbilityName cstring GetAbilityName() Returns the name of this ability.
GetSpecialValueFor variant GetSpecialValueFor( cstring ) Gets a value from this ability's special value block for its current level.
GetCastRange int GetCastRange() Gets the cast range of the ability.
IsFullyCastable bool IsFullyCastable() Returns whether the ability can be cast.
IsChanneling bool IsChanneling() Returns whether the ability is currently channeling.
IsInAbilityPhase bool IsInAbilityPhase() Returns whether the ability is currently casting.
GetCooldown float GetCooldown( int ) Get the cooldown duration for this ability at a given level, not the amount of cooldown actually left.
EndCooldown void EndCooldown() Clear the cooldown remaining on this ability.
MarkAbilityButtonDirty void MarkAbilityButtonDirty() Mark the ability button for this ability as needing a refresh
SetLevel void SetLevel( int ) Sets the level of this ability.


CDOTA_BaseNPC_Creature extends CDOTA_BaseNPC

A Dota NPC Unit

Function Signature Description
CreatureLevelUp void CreatureLevelUp( int ) Level the creature up by the specified number of levels
AddItemDrop void AddItemDrop( hscript ) Add the specified item drop to this creature
SetChampion void SetChampion( bool ) Flag this unit as a champion creature.
IsChampion bool IsChampion() Is this unit a champion?
SetHPGain void SetHPGain( int ) Set the hit points gained per level on this creature.
SetManaGain void SetManaGain( int ) Set the mana points gained per level on this creature.
SetHPRegenGain void SetHPRegenGain( float ) Set the hit points regen gained per level on this creature.
SetManaRegenGain void SetManaRegenGain( float ) Set the mana points regen gained per level on this creature.
SetDamageGain void SetDamageGain( int ) Set the damage gained per level on this creature.
SetArmorGain void SetArmorGain( float ) Set the armor gained per level on this creature.
SetMagicResistanceGain void SetMagicResistanceGain( float ) Set the magic resistance gained per level on this creature.
SetDisableResistanceGain void SetDisableResistanceGain( float ) Set the disable resistance gained per level on this creature.
SetAttackTimeGain void SetAttackTimeGain( float ) Set the attack time gained per level on this creature.
SetMoveSpeedGain void SetMoveSpeedGain( int ) Set the move speed gained per level on this creature.
SetBountyGain void SetBountyGain( int ) Set the bounty gold gained per level on this creature.
SetXPGain void SetXPGain( int ) Set the xp reward gained per level on this creature.


CDOTA_BaseNPC_Hero extends CDOTA_BaseNPC

A Dota Hero NPC

Function Signature Description
ModifyGold int ModifyGold( int, bool, int ) Gives this hero some gold
GetGold int GetGold() Returns gold amount for the player owning this hero
SetGold void SetGold( int, bool ) Sets the gold amount for the player owning this hero
GetCurrentXP int GetCurrentXP() Returns the amount of XP
GetPlayerID int GetPlayerID() Returns player ID of the player owning this hero
RespawnHero void RespawnHero( bool, bool, bool ) Respawn this hero.
HeroLevelUp void HeroLevelUp( bool ) Levels up the hero, true or false to play effects.
GetAbilityPoints int GetAbilityPoints() Gets the current unspent ability points.
SetAbilityPoints void SetAbilityPoints( int ) Sets the current unspent ability points.
SetCustomDeathXP void SetCustomDeathXP( int ) Sets a custom experience value for this hero. Note, GameRules boolean must be set for this to work!


CDotaQuest extends CBaseEntity

A quest

Function Signature Description
SetTextReplaceValue void SetTextReplaceValue( int, int ) Set a quest value
CompleteQuest void CompleteQuest() Mark this quest complete
SetTextReplaceString void SetTextReplaceString( cstring ) Set the text replace string for this quest
AddSubquest void AddSubquest( hscript ) Add a subquest to this quest
RemoveSubquest void RemoveSubquest( hscript ) Remove a subquest from this quest
GetSubquestByName hscript GetSubquestByName( cstring ) Finds a subquest from this quest by name
GetSubquest hscript GetSubquest( int ) Finds a subquest from this quest by index


CDOTA_Item extends CDOTABaseAbility

A usable item.

Function Signature Description
SetPurchaseTime void SetPurchaseTime( float ) Set the purchase time of this item
GetPurchaseTime float GetPurchaseTime() Get the purchase time of this item
SetPurchaser void SetPurchaser( hscript ) Set the purchaser of record for this item.
GetInitialCharges int GetInitialCharges() Get the initial number of charges this item has.
GetCurrentCharges int GetCurrentCharges() Get the number of charges this item currently has.
SetCurrentCharges void SetCurrentCharges( int ) Set the number of charges on this item
GetPurchaser hscript GetPurchaser() Get the purchaser for this item.
Think void Think() Think this item
IsPermanent bool IsPermanent() Is this a permanent item?
StacksWithOtherOwners bool StacksWithOtherOwners()
SetStacksWithOtherOwners void SetStacksWithOtherOwners( bool )
GetShareability int GetShareability()
GetCost int GetCost()
LaunchLoot void LaunchLoot( bool, float, float, vector )
GetContainer hscript GetContainer() Get the container for this item.


CDOTA_Item_DataDriven extends CDOTA_Item

A data driven usable item.

Function Signature Description
ApplyDataDrivenModifier void ApplyDataDrivenModifier( hscript, hscript, cstring, hscript ) Applies a data driven modifier to the target


CDotaSubquestBase extends CBaseEntity

A subquest

Function Signature Description
SetTextReplaceValue void SetTextReplaceValue( int, int ) Set a subquest value
CompleteSubquest void CompleteSubquest() Mark this subquest complete
SetTextReplaceString void SetTextReplaceString( cstring ) Set the text replace string for this subquest


CDOTAPlayer extends CBaseAnimating

dota_player

Function Signature Description
GetPlayerID int GetPlayerID() Get the player's official PlayerID; notably is -1 when the player isn't yet on a team.
GetAssignedHero hscript GetAssignedHero() Get the player's hero.
SetKillCamUnit void SetKillCamUnit( hscript ) Set the kill cam unit for this hero.
MakeRandomHeroSelection void MakeRandomHeroSelection() Randoms this player's hero.
SetMusicStatus void SetMusicStatus( int, float ) (nMusicStatus, flIntensity) - Set the music status for this player, note this will only really apply if dota_music_battle_enable is off.


CDOTA_Item_Physical extends CBaseAnimating

A physical item dropped in the world

Function Signature Description
GetCreationTime float GetCreationTime() Returns the game time when this item was created in the world
GetContainedItem hscript GetContainedItem() Returned the contained item.
SetContainedItem void SetContainedItem( hscript ) Set the contained item.
ShowMessage void ShowMessage( cstring ) Print a hud message on all clients
GetMapName cstring GetMapName() Get the name of the map.
SendToConsole void SendToConsole( cstring ) Send a string to the console as a client command
SendToServerConsole void SendToServerConsole( cstring ) Send a string to the console as a server command
PrintLinkedConsoleMessage void PrintLinkedConsoleMessage( cstring, cstring ) Print a console message with a linked console command
InitLogFile void InitLogFile( cstring, cstring ) If the given file doesn't exist, creates it with the given contents; does nothing if it exists
AppendToLogFile void AppendToLogFile( cstring, cstring ) Appends a string to a log file on the server
GetWorldMinX float GetWorldMinX() Gets the world's minimum X position.
GetWorldMinY float GetWorldMinY() Gets the world's maximum Y position.
GetWorldMaxX float GetWorldMaxX() Gets the world's minimum X position.
GetWorldMaxY float GetWorldMaxY() Gets the world's maximum Y position.
Time float Time() Get the current server time
GetSystemTime cstring GetSystemTime() Get the current real world time
GetSystemDate cstring GetSystemDate() Get the current real world date
UTIL_RemoveImmediate void UTIL_RemoveImmediate( hscript ) Immediately removes the specified entity
DoEntFire void DoEntFire( cstring, cstring, cstring, float, hscript, hscript ) #EntFire:Generate and entity i/o event
EntFireByHandle void EntFireByHandle( hscript, cstring, cstring, float, hscript, hscript ) Generate and entity i/o event
IsValidEntity bool IsValidEntity( hscript ) Checks to see if the given hScript is a valid entity
IsMarkedForDeletion bool IsMarkedForDeletion( hscript ) Returns true if the entity is valid and marked for deletion.
DoUniqueString cstring DoUniqueString( cstring ) #UniqueString:Generate a string guaranteed to be unique across the life of the script VM, with an optional root string. Useful for adding data to tables when not sure what keys are already in use in that table.
ListenToGameEvent int ListenToGameEvent( cstring, hscript, hscript ) Register as a listener for a game event from script.
StopListeningToGameEvent bool StopListeningToGameEvent( int ) Stop listening to a particular game event.
FireGameEvent void FireGameEvent( cstring, hscript ) Fire a game event.
FireGameEventLocal void FireGameEventLocal( cstring, hscript ) Fire a game event without broadcasting to the client.
PauseGame void PauseGame( bool ) Pause or unpause the game.
EntIndexToHScript hscript EntIndexToHScript( int ) Turn an entity index integer to an HScript representing that entity's script instance.
PlayerInstanceFromIndex hscript PlayerInstanceFromIndex( int ) Get a script instance of a player by index.
GetListenServerHost hscript GetListenServerHost() Get the local player on a listen server.
ScreenShake void ScreenShake( vector, float, float, float, float, int, bool ) Start a screenshake with the following parameters. vecCenter, flAmplitude, flFrequency, flDuration, flRadius, eCommand( SHAKE_START = 0, SHAKE_STOP = 1 ), bAirShake
SpawnEntityFromTable bool SpawnEntityFromTable( cstring, hscript, hscript, hscript, hscript ) Spawns a single entity from a table
SpawnEntityFromTableSync hscript SpawnEntityFromTableSync( cstring, hscript ) Spawns a single entity from a table
SpawnEntityGroupFromTable bool SpawnEntityGroupFromTable( hscript, bool, hscript ) Hierarchically spawn an entity group from a set of spawn tables.
PrecacheEntityFromTable bool PrecacheEntityFromTable( hscript ) Precache an entity from KeyValues in table
PrecacheResource void PrecacheResource( cstring, cstring ) Manually precache a single resource
VectorToAngles qangle VectorToAngles( vector ) Get Qangles (with no roll) for a Vector.
RotatePosition vector RotatePosition( vector, qangle, vector ) Rotate a Vector around a point.
RotateOrientation qangle RotateOrientation( qangle, qangle ) Rotate a QAngle by another QAngle.
RotationDelta qangle RotationDelta( qangle, qangle ) Find the delta between two angles.
EmitSoundOn void EmitSoundOn( cstring, hscript ) Play named sound on Entity
EmitSoundOnClient void EmitSoundOnClient( cstring, hscript ) Play named sound only on the client for the passed in player
EmitGlobalSound void EmitGlobalSound( cstring ) Play named sound for all players
StopSoundOn void StopSoundOn( cstring, hscript ) Stop named sound on Entity
GetPhysVelocity vector GetPhysVelocity( hscript ) Get Velocity for VPHYS or normal object
GetPhysAngularVelocity vector GetPhysAngularVelocity( hscript ) Get Angular Velocity for VPHYS or normal object
Say void Say( hscript, cstring, bool ) Have Entity say string, and teamOnly or not
AddThinkToEnt void AddThinkToEnt( hscript, cstring ) Adds a late bound think function to the C++ think tables for the obj
LoadKeyValues variant LoadKeyValues( cstring ) Creates a table from the specified keyvalues text file
LoadKeyValuesFromString variant LoadKeyValuesFromString( cstring ) Creates a table from the specified keyvalues string
DebugDrawScreenTextLine void DebugDrawScreenTextLine( float, float, int, cstring, int, int, int, int, float ) Draw text with a line offset (x, y, lineOffset, text, r, g, b, a, duration)
DebugDrawText void DebugDrawText( vector, cstring, bool, float ) Draw text in 3d (origin, text, bViewCheck, duration)
DebugDrawBox void DebugDrawBox( vector, vector, vector, int, int, int, int, float ) Draw a debug overlay box (origin, mins, maxs, forward, r, g, b, a, duration )
DebugDrawLine void DebugDrawLine( vector, vector, int, int, int, bool, float ) Draw a debug overlay line (origin, target, r, g, b, ztest, duration)
DebugDrawCircle void DebugDrawCircle( vector, vector, float, float, bool, float ) Draw a debug circle (center, vRgb, a, rad, a, ztest, duration)
DebugDrawLine_vCol void DebugDrawLine_vCol( vector, vector, vector, bool, float ) Draw a debug line using color vec (start, end, vRgb, a, ztest, duration)
DebugDrawBoxDirection void DebugDrawBoxDirection( vector, vector, vector, vector, vector, float, float ) Draw a debug forward box (cent, min, max, forward, vRgb, a, duration)
DebugDrawClear void DebugDrawClear() Try to clear all the debug overlay info
GetFrameCount int GetFrameCount() Returns the engines current frame count
IsDedicatedServer bool IsDedicatedServer() Returns true if this server is a dedicated server.
CreateUnitByName hscript CreateUnitByName( cstring, vector, bool, hscript, hscript, int ) Creates a DOTA unit by its dota_npc_units.txt name
PrecacheUnitByName bool PrecacheUnitByName( cstring ) Precaches a DOTA unit by its dota_npc_units.txt name
CreateHeroForPlayer hscript CreateHeroForPlayer( cstring, hscript ) Creates a DOTA hero by its dota_npc_units.txt name and sets it as the given player's controlled hero
CreateItem hscript CreateItem( cstring, hscript, hscript ) Create a DOTA item
CreateItemOnPosition hscript CreateItemOnPosition( vector ) Create a physical item at a given location
FindClearSpaceForUnit void FindClearSpaceForUnit( hscript, vector, bool ) Place a unit somewhere not already occupied.
FindUnitsInRadius variant FindUnitsInRadius( int, vector, hscript, float, int, int, int, int, bool ) Finds the units in a given radius with the given flags.
PrecacheUnit void PrecacheUnit( cstring ) Precaches all the resources for a given unit.
GetFrostyPointsForRound int GetFrostyPointsForRound( int, int, int )
GetGoldFrostyPointsForRound int GetGoldFrostyPointsForRound( int, int, int )
GetFrostyBoostAmount float GetFrostyBoostAmount( int, int )
GetGoldFrostyBoostAmount float GetGoldFrostyBoostAmount( int, int )
SendFrostyPointsMessageToGC void SendFrostyPointsMessageToGC( hscript )
SendFrostivusTimeElapsedToGC void SendFrostivusTimeElapsedToGC()
ExecuteOrderFromTable void ExecuteOrderFromTable( hscript ) Issue an order from a script table
ShowGenericPopup void ShowGenericPopup( cstring, cstring, cstring, cstring, int ) Show a generic popup dialog for all players.
ShowGenericPopupToPlayer void ShowGenericPopupToPlayer( hscript, cstring, cstring, cstring, cstring, int ) Show a generic popup dialog to a specific player.