Dota 2 Workshop Tools/Scripting/API/

From Valve Developer Community
Jump to: navigation, search
Icon-broom.png
This article is an orphan, meaning that few or no articles link to it.
You can help by adding links to this article from other relevant articles.
January 2024


Global

No Description Set

Function Signature Description
AngleDiff float AngleDiff(float , float ) Returns the number of degrees difference between two yaw angles
AppendToLogFile void AppendToLogFile(string , string ) Appends a string to a log file on the server
ApplyDamage float ApplyDamage(handle ) Pass table - Inputs: victim, attacker, damage, damage_type, damage_flags, abilityReturn damage done.
AxisAngleToQuaternion Quaternion AxisAngleToQuaternion(Vector , float ) (vector,float) constructs a quaternion representing a rotation by angle around the specified vector axis
CancelEntityIOEvents void CancelEntityIOEvents(ehandle ) Create all I/O events for a particular entity
CreateEffect bool CreateEffect(handle ) Pass table - Inputs: entity, effect
CreateHeroForPlayer handle CreateHeroForPlayer(string , handle ) Creates a DOTA hero by its dota_npc_units.txt name and sets it as the given player's controlled hero
CreateItem handle CreateItem(string , handle , handle ) Create a DOTA item ( szScriptName, hParent, hOwner )
CreateItemOnPositionSync handle CreateItemOnPositionSync(Vector , handle ) Create a physical item at a given location
CreateTrigger handle CreateTrigger(Vector , Vector , Vector ) CreateTrigger( vecMin, vecMax ) : Creates and returns an AABB trigger
CreateTriggerRadiusApproximate handle CreateTriggerRadiusApproximate(Vector , float ) CreateTriggerRadiusApproximate( vecOrigin, flRadius ) : Creates and returns an AABB trigger thats bigger than the radius provided
CreateUnitByName handle CreateUnitByName(string , Vector , bool , handle , handle , int ) Creates a DOTA unit by its dota_npc_units.txt name ( szUnitName, vLocation, bFindClearSpace, hNPCOwner, hUnitOwner, iTeamNumber )
CreateUnitByNameAsync int CreateUnitByNameAsync(string , Vector , bool , handle , handle , int , handle ) Creates a DOTA unit by its dota_npc_units.txt name ( szUnitName, vLocation, bFindClearSpace, hNPCOwner, hUnitOwner, iTeamNumber, hCallback )
cvar_getf float cvar_getf(string ) Gets the value of the given cvar, as a float.
cvar_setf bool cvar_setf(string , float ) Sets the value of the given cvar, as a float.
DebugBreak void DebugBreak() Breaks in the debugger
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 )
DebugDrawBoxDirection void DebugDrawBoxDirection(Vector , Vector , Vector , Vector , Vector , float , float ) Draw a debug forward box (cent, min, max, forward, vRgb, a, duration)
DebugDrawCircle void DebugDrawCircle(Vector , Vector , float , float , bool , float ) Draw a debug circle (center, vRgb, a, rad, ztest, duration)
DebugDrawClear void DebugDrawClear() Try to clear all the debug overlay info
DebugDrawLine void DebugDrawLine(Vector , Vector , int , int , int , bool , float ) Draw a debug overlay line (origin, target, r, g, b, 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)
DebugDrawScreenTextLine void DebugDrawScreenTextLine(float , float , int , string , int , int , int , int , float ) Draw text with a line offset (x, y, lineOffset, text, r, g, b, a, duration)
DebugDrawSphere void DebugDrawSphere(Vector , Vector , float , float , bool , float ) Draw a debug sphere (center, vRgb, a, rad, ztest, duration)
DebugDrawText void DebugDrawText(Vector , string , bool , float ) Draw text in 3d (origin, text, bViewCheck, duration)
DebugScreenTextPretty void DebugScreenTextPretty(float , float , int , string , int , int , int , int , float , string , int , bool ) Draw pretty debug text (x, y, lineOffset, text, r, g, b, a, duration, font, size, bBold)
DoEntFire void DoEntFire(string , string , string , float , handle , handle ) EntFire: Generate an entity i/o event ( szTarget, szAction, szValue, flDelay, hActivator, hCaller )
DoEntFireByInstanceHandle void DoEntFireByInstanceHandle(handle , string , string , float , handle , handle ) EntFireByHandle:Generate and entity i/o event
DoIncludeScript bool DoIncludeScript(string , handle ) Execute a script (internal)
DoScriptAssert void DoScriptAssert(bool , string ) ScriptAssert:Asserts the passed in value. Prints out a message and brings up the assert dialog.
DoUniqueString string DoUniqueString(string ) 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 table's when not sure what keys are already in use in that table.
EmitGlobalSound void EmitGlobalSound(string ) Play named sound for all players
EmitSoundOn void EmitSoundOn(string , handle ) Play named sound on Entity
EmitSoundOnClient void EmitSoundOnClient(string , handle ) Play named sound only on the client for the passed in player
EntIndexToHScript handle EntIndexToHScript(int ) Turn an entity index integer to an HScript representing that entity's script instance.
ExecuteOrderFromTable void ExecuteOrderFromTable(handle ) Issue an order from a script table
ExponentialDecay float ExponentialDecay(float , float , float ) Smooth curve decreasing slower as it approaches zero
FileToString string FileToString(string ) Reads a string from a file to send to script
FindClearSpaceForUnit void FindClearSpaceForUnit(handle , Vector , bool ) Place a unit somewhere not already occupied.
FindUnitsInRadius table FindUnitsInRadius(int , Vector , handle , float , int , int , int , int , bool ) Finds the units in a given radius with the given flags. ( iTeamNumber, vPosition, hCacheUnit, flRadius, iTeamFilter, iTypeFilter, iFlagFilter, iOrder, bCanGrowCache )
FireEntityIOInputNameOnly void FireEntityIOInputNameOnly(ehandle , string ) Fire Entity's Action Input w/no data
FireEntityIOInputString void FireEntityIOInputString(ehandle , string , string ) Fire Entity's Action Input with passed String - you own the memory
FireEntityIOInputVec void FireEntityIOInputVec(ehandle , string , Vector ) Fire Entity's Action Input with passed Vector ( hEntity, szActionName, vector )
FireGameEvent void FireGameEvent(string , handle ) Fire a game event.
FireGameEventLocal void FireGameEventLocal(string , handle ) Fire a game event without broadcasting to the client.
FrameTime float FrameTime() Get the time spent on the server in the last frame
GetFrameCount int GetFrameCount() Returns the engines current frame count
GetFrostyBoostAmount float GetFrostyBoostAmount(int , int ) No Description Set
GetFrostyPointsForRound int GetFrostyPointsForRound(int , int , int ) No Description Set
GetGoldFrostyBoostAmount float GetGoldFrostyBoostAmount(int , int ) No Description Set
GetGoldFrostyPointsForRound int GetGoldFrostyPointsForRound(int , int , int ) No Description Set
GetGroundPosition Vector GetGroundPosition(Vector , handle ) Returns the supplied position moved to the ground. Second parameter is an NPC for measuring movement collision hull offset.
GetListenServerHost handle GetListenServerHost() Get the local player on a listen server.
GetMapName string GetMapName() Get the name of the map.
GetMaxOutputDelay float GetMaxOutputDelay(ehandle , string ) Get the longest delay for all events attached to an output
GetPhysAngularVelocity Vector GetPhysAngularVelocity(handle ) Get Angular Velocity for VPHYS or normal object
GetPhysVelocity Vector GetPhysVelocity(handle ) Get Velocity for VPHYS or normal object
GetSystemDate string GetSystemDate() Get the current real world date
GetSystemTime string GetSystemTime() Get the current real world time
GetWorldMaxX float GetWorldMaxX() Gets the world's maximum X position.
GetWorldMaxY float GetWorldMaxY() Gets the world's maximum Y position.
GetWorldMinX float GetWorldMinX() Gets the world's minimum X position.
GetWorldMinY float GetWorldMinY() Gets the world's minimum Y position.
InitLogFile void InitLogFile(string , string ) If the given file doesn't exist, creates it with the given contents; does nothing if it exists
IsDedicatedServer bool IsDedicatedServer() Returns true if this server is a dedicated server.
IsMarkedForDeletion bool IsMarkedForDeletion(handle ) Returns true if the entity is valid and marked for deletion.
IsValidEntity bool IsValidEntity(handle ) Checks to see if the given hScript is a valid entity
ListenToGameEvent int ListenToGameEvent(string , handle , handle ) Register as a listener for a game event from script. ( szEventName, hFunctionNameToCall, hContext )
Tip.pngTip:In addition to listening for standard engine events, you can also create your own events by placing them in /scripts/custom_events.txt.
LoadKeyValues table LoadKeyValues(string ) Creates a table from the specified keyvalues text file
LoadKeyValuesFromString table LoadKeyValuesFromString(string ) Creates a table from the specified keyvalues string
MakeStringToken int MakeStringToken(string ) Checks to see if the given hScript is a valid entity
Msg void Msg(string ) Print a message
PauseGame void PauseGame(bool ) Pause or unpause the game.
PlayerInstanceFromIndex handle PlayerInstanceFromIndex(int ) Get a script instance of a player by index.
PrecacheEntityFromTable void PrecacheEntityFromTable(string , handle , handle ) Precache an entity from KeyValues in table
PrecacheEntityListFromTable void PrecacheEntityListFromTable(handle , handle ) Precache a list of entity KeyValues table's
PrecacheItemByNameAsync void PrecacheItemByNameAsync(string , handle ) Asynchronously precaches a DOTA item by its dota_npc_items.txt name, provides a callback when it's finished.
PrecacheItemByNameSync void PrecacheItemByNameSync(string , handle ) Precaches a DOTA item by its dota_npc_items.txt name
PrecacheModel void PrecacheModel(string , handle ) ( modelName, context ) - Manually precache a single model
PrecacheResource void PrecacheResource(string , string , handle ) Manually precache a single resource
PrecacheUnitByNameAsync void PrecacheUnitByNameAsync(string , handle ) Asynchronously precaches a DOTA unit by its dota_npc_units.txt name, provides a callback when it's finished.
PrecacheUnitByNameSync void PrecacheUnitByNameSync(string , handle ) Precaches a DOTA unit by its dota_npc_units.txt name
PrintLinkedConsoleMessage void PrintLinkedConsoleMessage(string , string ) Print a console message with a linked console command
RandomFloat float RandomFloat(float , float ) Get a random float within a range
RandomInt int RandomInt(int , int ) Get a random int within a range
RandomVector Vector RandomVector(float ) Get a random 2D vector. Argument (float) is the minimum length of the returned vector.
RegisterSpawnGroupFilterProxy void RegisterSpawnGroupFilterProxy(string ) Create a C proxy for a script-based spawn group filter
ReloadMOTD void ReloadMOTD() Reloads the MotD file
RemoveSpawnGroupFilterProxy void RemoveSpawnGroupFilterProxy(string ) Remove the C proxy for a script-based spawn group filter
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
RotateOrientation QAngle RotateOrientation(QAngle , QAngle ) Rotate a QAngle by another QAngle.
RotatePosition Vector RotatePosition(Vector , QAngle , Vector ) Rotate a Vector around a point.
RotateQuaternionByAxisAngle Quaternion RotateQuaternionByAxisAngle(Quaternion , Vector , float ) Rotates a quaternion by the specified angle around the specified vector axis
RotationDelta QAngle RotationDelta(QAngle , QAngle ) Find the delta between two QAngles.
rr_AddDecisionRule bool rr_AddDecisionRule(handle ) Add a rule to the decision database.
rr_CommitAIResponse bool rr_CommitAIResponse(handle , handle ) Commit the result of QueryBestResponse back to the given entity to play. Call with params (entity, airesponse)
rr_GetResponseTargets handle rr_GetResponseTargets() Retrieve a table of all available expresser targets, in the form { name : handle, name: handle }.
rr_QueryBestResponse bool rr_QueryBestResponse(handle , handle , handle ) Params: ( hEnt, hQuery, hResult ) // Static : tests 'query' against entity's response system and returns the best response found (or nil if none found).
Say void Say(handle entity, string message, bool teamOnly) Have Entity say string, and teamOnly or not
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
SendFrostivusTimeElapsedToGC void SendFrostivusTimeElapsedToGC() No Description Set
SendFrostyPointsMessageToGC void SendFrostyPointsMessageToGC(handle ) No Description Set
SendToConsole void SendToConsole(string ) Send a string to the console as a client command
SendToServerConsole void SendToServerConsole(string ) Send a string to the console as a server command
SetOpvarFloatAll void SetOpvarFloatAll(string , string , string , float ) Sets an opvar value for all players
SetOpvarFloatPlayer void SetOpvarFloatPlayer(string , string , string , float , handle ) Sets an opvar value for a single player ( szStackName, szOperatorName, szOpvarName, flOpvarValue, hEnt )
SetQuestName void SetQuestName(string ) Set the current quest name.
SetQuestPhase void SetQuestPhase(int ) Set the current quest phase.
SetRenderingEnabled void SetRenderingEnabled(ehandle , bool ) Set rendering on/off for an ehandle
ShowGenericPopup void ShowGenericPopup(string , string , string , string , int ) Show a generic popup dialog for all players.
ShowGenericPopupToPlayer void ShowGenericPopupToPlayer(handle , string , string , string , string , int ) Show a generic popup dialog to a specific player.
ShowMessage void ShowMessage(string ) Print a hud message on all clients
SpawnEntityFromTableSynchronous handle SpawnEntityFromTableSynchronous(string , handle ) Synchronously spawns a single entity from a table
SpawnEntityGroupFromTable bool SpawnEntityGroupFromTable(handle groupSpawnTables, bool bAsync, handle hCallback) Hierarchically spawn an entity group from a set of spawn tables.
SpawnEntityListFromTableAsynchronous int SpawnEntityListFromTableAsynchronous(handle , handle ) Asynchronously spawn an entity group from a list of spawn table's. A callback will be triggered when the spawning is complete
SpawnEntityListFromTableSynchronous handle SpawnEntityListFromTableSynchronous(handle ) Synchronously spawn an entity group from a list of spawn table's.
SplineQuaternions Quaternion SplineQuaternions(Quaternion , Quaternion , float ) (quaternion,quaternion,float) very basic interpolation of v0 to v1 over t on [0,1]
SplineVectors Vector SplineVectors(Vector , Vector , float ) (vector,vector,float) very basic interpolation of v0 to v1 over t on [0,1]
StartSoundEvent void StartSoundEvent(string , handle ) Start a sound event
StopEffect void StopEffect(handle , string ) (hEntity, szEffectName)
StopListeningToAllGameEvents void StopListeningToAllGameEvents(handle ) Stop listening to all game events within a specific context.
StopListeningToGameEvent bool StopListeningToGameEvent(int ) Stop listening to a particular game event.
StopSoundEvent void StopSoundEvent(string , handle ) Stops a sound event
StopSoundOn void StopSoundOn(string soundName, handle playingEntity) Stop named sound on Entity
StringToFile bool StringToFile(string , string ) Store a string to a file for later reading
Time float Time() Get the current server time
TraceCollideable bool TraceCollideable(handle ) Pass table - Inputs: start, end, ent, (optional mins, maxs) -- outputs: pos, fraction, hit, startsolid, normal
TraceHull bool TraceHull(handle ) Pass table - Inputs: start, end, min, max, mask, ignore -- outputs: pos, fraction, hit, enthit, startsolid
TraceLine bool TraceLine(handle ) Pass table - Inputs: startpos, endpos, mask, ignore -- outputs: pos, fraction, hit, enthit, startsolid
UnloadSpawnGroup void UnloadSpawnGroup(string ) Unload a spawn group by name
UnloadSpawnGroupByHandle void UnloadSpawnGroupByHandle(int ) Unload a spawn group by handle
UpdateEventPoints void UpdateEventPoints(handle ) No Description Set
UTIL_Remove void UTIL_Remove(handle ) Removes the specified entity
UTIL_RemoveImmediate void UTIL_RemoveImmediate(handle ) Immediately removes the specified entity
VectorToAngles QAngle VectorToAngles(Vector ) Get Qangles (with no roll) for a Vector.
Warning void Warning(string ) Print a warning

CBaseEntity

No Description Set

Function Signature Description
ApplyAbsVelocityImpulse void ApplyAbsVelocityImpulse(Vector ) Apply a Velocity Impulse
ApplyLocalAngularVelocityImpulse void ApplyLocalAngularVelocityImpulse(Vector ) Apply an Ang Velocity Impulse
EmitSound void EmitSound(string soundName) Plays a sound from this entity.
EmitSoundParams void EmitSoundParams(string soundName, int pitch, float volume, float soundTime) Plays/modifies a sound from this entity. changes sound if Pitch and/or Volume or SoundTime is > 0.
EyeAngles QAngle EyeAngles() Get the qangles that this entity is looking at.
EyePosition Vector EyePosition() Get vector to eye position - absolute coords
FirstMoveChild handle FirstMoveChild() No Description Set
GatherCriteria void GatherCriteria(handle ) Returns a table containing the criteria that would be used for response queries on this entity. This is the same as the table that is passed to response rule script function callbacks.
GetAbsOrigin Vector GetAbsOrigin() No Description Set
GetAngles QAngle GetAngles() No Description Set
GetAnglesAsVector Vector GetAnglesAsVector() Get entity pitch, yaw, roll as a vector
GetAngularVelocity Vector GetAngularVelocity() Get the local angular velocity - returns a vector of pitch,yaw,roll
GetBaseVelocity Vector GetBaseVelocity() Get Base velocity
GetBoundingMaxs Vector GetBoundingMaxs() Get a vector containing max bounds, centered on object
GetBoundingMins Vector GetBoundingMins() Get a vector containing min bounds, centered on object
GetBounds table GetBounds() Get a table containing the 'Mins' & 'Maxs' vector bounds, centered on object
GetCenter Vector GetCenter() Get vector to center of object - absolute coords
GetChildren handle GetChildren() Get the entities parented to this entity.
GetContext table GetContext(string ) GetContext( name ): looks up a context and returns it if available. May return string, float, or nil (if the context isn't found)
GetForwardVector Vector GetForwardVector() Get the forward vector of the entity
GetHealth int GetHealth() No Description Set
GetLocalAngularVelocity QAngle GetLocalAngularVelocity() Maybe local angvel
GetLocalVelocity Vector GetLocalVelocity() Get Entity relative velocity
GetMaxHealth int GetMaxHealth() No Description Set
GetModelName string GetModelName() Returns the name of the model
GetMoveParent handle GetMoveParent() If in hierarchy, retrieves the entity's parent
GetOrigin Vector GetOrigin() No Description Set
GetOwner handle GetOwner() Gets this entity's owner
GetOwnerEntity handle GetOwnerEntity() Get the owner entity, if there is one
GetRightVector Vector GetRightVector() Get the right vector of the entity
GetRootMoveParent handle GetRootMoveParent() If in hierarchy, walks up the hierarchy to find the root parent
GetSoundDuration float GetSoundDuration(string soundName, string actormodelname) Returns float duration of the sound. Takes soundname and optional actormodelname.
GetTeam int GetTeam() No Description Set
GetUpVector Vector GetUpVector() Get the up vector of the entity
GetVelocity Vector GetVelocity() No Description Set
IsAlive bool IsAlive() No Description Set.
IsPlayer bool IsPlayer() Is this a player entity?
Kill void Kill() No Description Set
NextMovePeer handle NextMovePeer() No Description Set
OverrideFriction void OverrideFriction(float , float ) Takes duration, value for a temporary override
PrecacheScriptSound void PrecacheScriptSound(string ) Precache a sound for later playing.
SetAbsOrigin void SetAbsOrigin(Vector origin) SetAbsOrigin
SetAngles void SetAngles(float pitch, float yaw, float roll) Set entity pitch, yaw, roll
SetAngularVelocity void SetAngularVelocity(float pitch, float yaw, float roll) Set the local angular velocity - takes float pitch,yaw,roll velocities
SetContext void SetContext(string , string , float ) SetContext( name , value, duration ): store any key/value pair in this entity's dialog contexts. Value must be a string. Will last for duration (set 0 to mean 'forever').
SetContextNum void SetContextNum(string , float , float ) SetContext( name , value, duration ): store any key/value pair in this entity's dialog contexts. Value must be a number (int or float). Will last for duration (set 0 to mean 'forever').
SetContextThink void SetContextThink(string , handle , float ) Set a think function on this entity.
SetForwardVector void SetForwardVector(Vector forwardVec) Set the orientation of the entity to have this forward forwardVec
SetFriction void SetFriction(float ) Set PLAYER friction, ignored for objects
SetGravity void SetGravity(float ) Set PLAYER gravity, ignored for objects
SetHealth void SetHealth(int hp) No Description Set
SetMaxHealth void SetMaxHealth(int maxHP) No Description Set
SetModel void SetModel(string modelName) No Description Set
SetOrigin void SetOrigin(Vector origin) No Description Set
SetOwner void SetOwner(handle owningEntity) Sets this entity's owner
SetParent void SetParent(handle , string ) Set the parent for this entity.
SetRenderColor void SetRenderColor(int , int , int ) SetRenderColor( r, g, b ): Sets the render color of the entity.
SetSize void SetSize(Vector , Vector ) No Description Set
SetTeam void SetTeam(int team) No Description Set
SetVelocity void SetVelocity(Vector ) No Description Set
StopSound void StopSound(string soundName) Stops a named sound playing from this entity.
Trigger void Trigger() Fires off this entity's OnTrigger responses

CEntities

No Description Set

Global accessor variable: Entities

Function Signature Description
CreateByClassname handle CreateByClassname(string className) Creates an entity by classname
FindAllByClassname table FindAllByClassname(string ) Finds all entities by class name. Returns an array containing all the found entities.
FindAllByClassnameWithin table FindAllByClassnameWithin(string , Vector , float ) Find entities by class name within a radius.
FindAllByModel table FindAllByModel(string modelName) Find entities by model name.
FindAllByName table FindAllByName(string name) Find all entities by name. Returns an array containing all the found entities in it.
FindAllByNameWithin table FindAllByNameWithin(string name, Vector origin, float maxRadius) Find entities by name within a radius.
FindAllByTarget table FindAllByTarget(string targetName) Find entities by targetname.
FindAllInSphere table FindAllInSphere(Vector origin, float maxRadius) Find entities within a radius.
FindByClassname handle FindByClassname(handle startFrom, string className) Find entities by class name. Pass nil to start an iteration, or reference to a previously found entity to continue a search
FindByClassnameNearest handle FindByClassnameNearest(string className, Vector origin, float maxRadius) Find entities by class name nearest to a point.
FindByClassnameWithin handle FindByClassnameWithin(handle startFrom, string className, Vector origin, float maxRadius) Find entities by class name within a radius. Pass nil to start an iteration, or reference to a previously found entity to continue a search
FindByModel handle FindByModel(handle startFrom, string modelName) Find entities by model name. Pass nil to start an iteration, or reference to a previously found entity to continue a search
FindByModelWithin handle FindByModelWithin(handle startFrom, string modelName, Vector origin, float maxRadius) Find entities by model name within a radius. Pass nil to start an iteration, or reference to a previously found entity to continue a search
FindByName handle FindByName(handle lastEnt, string searchString) Find entities by name. Pass nil to start an iteration, or reference to a previously found entity to continue a search
FindByNameNearest handle FindByNameNearest(string name, Vector origin, float maxRadius) Find entities by name nearest to a point.
FindByNameWithin handle FindByNameWithin(handle startFrom, string name, Vector origin, float maxRadius) Find entities by name within a radius. Pass nil to start an iteration, or reference to a previously found entity to continue a search
FindByTarget handle FindByTarget(handle startFrom, string targetName) Find entities by targetname. Pass nil to start an iteration, or reference to a previously found entity to continue a search
FindInSphere handle FindInSphere(handle startFrom, Vector origin, float maxRadius) Find entities within a radius. Pass nil to start an iteration, or reference to a previously found entity to continue a search
First handle First() Begin an iteration over the list of entities
Next handle Next(handle startFrom) Continue an iteration over the list of entities, providing reference to a previously found entity

CEntityInstance

No Description Set

Function Signature Description
ConnectOutput void ConnectOutput(string , string ) Adds an I/O connection that will call the named function on this entity when the specified output fires.
Destroy void Destroy() No Description Set
DisconnectOutput void DisconnectOutput(string , string ) Removes a connected script function from an I/O event on this entity.
DisconnectRedirectedOutput void DisconnectRedirectedOutput(string , string , handle ) Removes a connected script function from an I/O event on the passed entity.
entindex int entindex() No Description Set
FireOutput void FireOutput(string , handle , handle , table , float ) Fire an entity output
GetClassname string GetClassname() No Description Set
GetDebugName string GetDebugName() Get the entity name w/help if not defined (i.e. classname/etc)
GetEntityHandle ehandle GetEntityHandle() Get the entity as an EHANDLE
GetEntityIndex int GetEntityIndex() No Description Set
GetIntAttr int GetIntAttr(string ) Get Integer Attribute
GetName string GetName() No Description Set
GetOrCreatePrivateScriptScope handle GetOrCreatePrivateScriptScope() Retrieve, creating if necessary, the private per-instance script-side data associated with an entity
GetOrCreatePublicScriptScope handle GetOrCreatePublicScriptScope() Retrieve, creating if necessary, the public script-side data associated with an entity
GetPrivateScriptScope handle GetPrivateScriptScope() Retrieve the private per-instance script-side data associated with an entity
GetPublicScriptScope handle GetPublicScriptScope() Retrieve the public script-side data associated with an entity
RedirectOutput void RedirectOutput(string , string , handle ) Adds an I/O connection that will call the named function on the passed entity when the specified output fires.
RemoveSelf void RemoveSelf() Delete this entity
SetIntAttr void SetIntAttr(string , int ) Set Integer Attribute

CDOTABaseAbility

extends CBaseEntity

No Description Set

Function Signature Description
CastAbility void CastAbility() No Description Set
ContinueCasting bool ContinueCasting() No Description Set
CreateVisibilityNode void CreateVisibilityNode(Vector , float , float ) No Description Set
DecrementModifierRefCount void DecrementModifierRefCount() No Description Set
EndChannel void EndChannel(bool ) Param: bool bInterrupted
EndCooldown void EndCooldown() Clear the cooldown remaining on this ability.
GetAbilityDamage int GetAbilityDamage() No Description Set
GetAbilityDamageType int GetAbilityDamageType() No Description Set
GetAbilityIndex int GetAbilityIndex() No Description Set
GetAbilityName string GetAbilityName() No Description Set
GetAbilityTargetFlags int GetAbilityTargetFlags() No Description Set
GetAbilityTargetTeam int GetAbilityTargetTeam() No Description Set
GetAbilityTargetType int GetAbilityTargetType() No Description Set
GetAbilityType int GetAbilityType() No Description Set
GetAnimationIgnoresModelScale bool GetAnimationIgnoresModelScale() No Description Set
GetAssociatedPrimaryAbilities string GetAssociatedPrimaryAbilities() No Description Set
GetAssociatedSecondaryAbilities string GetAssociatedSecondaryAbilities() No Description Set
GetAutoCastState bool GetAutoCastState() No Description Set
GetBackswingTime float GetBackswingTime() No Description Set
GetBehavior int GetBehavior() No Description Set
GetCaster handle GetCaster() No Description Set
GetCastPoint float GetCastPoint() No Description Set
GetCastRange int GetCastRange() No Description Set
GetChannelledManaCostPerSecond int GetChannelledManaCostPerSecond(int ) No Description Set
GetChannelStartTime float GetChannelStartTime() No Description Set
GetChannelTime float GetChannelTime() No Description Set
GetCloneSource handle GetCloneSource() No Description Set
GetConceptRecipientType int GetConceptRecipientType() No Description Set
GetCooldown float GetCooldown(int ) Get the cooldown duration for this ability at a given level, not the amount of cooldown actually left.
GetCooldownTime float GetCooldownTime() No Description Set
GetCooldownTimeRemaining float GetCooldownTimeRemaining() No Description Set
GetCursorPosition Vector GetCursorPosition() No Description Set
GetCursorTarget handle GetCursorTarget() No Description Set
GetCursorTargetingNothing bool GetCursorTargetingNothing() No Description Set
GetDuration float GetDuration() No Description Set
GetGoldCost int GetGoldCost(int ) No Description Set
GetGoldCostForUpgrade int GetGoldCostForUpgrade(int ) No Description Set
GetHeroLevelRequiredToUpgrade int GetHeroLevelRequiredToUpgrade() No Description Set
GetIntrinsicModifierName string GetIntrinsicModifierName() No Description Set
GetLevel int GetLevel() Get the current level of the ability
GetLevelSpecialValueFor table GetLevelSpecialValueFor(string , int ) No Description Set
GetManaCost int GetManaCost(int ) No Description Set
GetMaxLevel int GetMaxLevel() No Description Set
GetModifierValue float GetModifierValue() No Description Set
GetModifierValueBonus float GetModifierValueBonus() No Description Set
GetPlaybackRateOverride float GetPlaybackRateOverride() No Description Set
GetSharedCooldownName string GetSharedCooldownName() No Description Set
GetSpecialValueFor table GetSpecialValueFor(string ) No Description Set
GetStolenActivityModifier string GetStolenActivityModifier() No Description Set
GetToggleState bool GetToggleState() No Description Set
HeroXPChange bool HeroXPChange(float ) No Description Set
IncrementModifierRefCount void IncrementModifierRefCount() No Description Set
IsActivated bool IsActivated() No Description Set
IsAttributeBonus bool IsAttributeBonus() No Description Set
IsChanneling bool IsChanneling() Returns whether the ability is currently channeling.
IsCooldownReady bool IsCooldownReady() No Description Set
IsCosmetic bool IsCosmetic() No Description Set
IsFullyCastable bool IsFullyCastable() Returns whether the ability can be cast.
IsHidden bool IsHidden() No Description Set
IsHiddenWhenStolen bool IsHiddenWhenStolen() No Description Set
IsInAbilityPhase bool IsInAbilityPhase() Returns whether the ability is currently casting.
IsItem bool IsItem() No Description Set
IsOwnersGoldEnough bool IsOwnersGoldEnough(int ) No Description Set
IsOwnersGoldEnoughForUpgrade bool IsOwnersGoldEnoughForUpgrade() No Description Set
IsOwnersManaEnough bool IsOwnersManaEnough() No Description Set
IsPassive bool IsPassive() No Description Set
IsSharedWithTeammates bool IsSharedWithTeammates() No Description Set
IsStealable bool IsStealable() No Description Set
IsStolen bool IsStolen() No Description Set
IsToggle bool IsToggle() No Description Set
IsTrained bool IsTrained() No Description Set
MarkAbilityButtonDirty void MarkAbilityButtonDirty() Mark the ability button for this ability as needing a refresh
NumModifiersUsingAbility int NumModifiersUsingAbility() No Description Set
OnAbilityPhaseInterrupted void OnAbilityPhaseInterrupted() No Description Set
OnAbilityPhaseStart bool OnAbilityPhaseStart() No Description Set
OnAbilityPinged void OnAbilityPinged() No Description Set
OnChannelFinish void OnChannelFinish(bool ) No Description Set
OnChannelThink void OnChannelThink(float ) No Description Set
OnHeroCalculateStatBonus void OnHeroCalculateStatBonus() No Description Set
OnHeroLevelUp void OnHeroLevelUp() No Description Set
OnInventoryContentsChanged void OnInventoryContentsChanged() No Description Set
OnOwnerDied void OnOwnerDied() No Description Set
OnOwnerSpawned void OnOwnerSpawned() No Description Set
OnSpellStart void OnSpellStart() No Description Set
OnToggle void OnToggle() No Description Set
OnUpgrade void OnUpgrade() No Description Set
PayGoldCost void PayGoldCost() No Description Set
PayGoldCostForUpgrade void PayGoldCostForUpgrade() No Description Set
PayManaCost void PayManaCost() No Description Set
PlaysDefaultAnimWhenStolen bool PlaysDefaultAnimWhenStolen() No Description Set
ProcsMagicStick bool ProcsMagicStick() No Description Set
RefCountsModifiers bool RefCountsModifiers() No Description Set
RefundManaCost void RefundManaCost() No Description Set
ResetToggleOnRespawn bool ResetToggleOnRespawn() No Description Set
SetAbilityIndex void SetAbilityIndex(int ) No Description Set
SetActivated void SetActivated(bool ) No Description Set
SetChanneling void SetChanneling(bool ) No Description Set
SetHidden void SetHidden(bool ) No Description Set
SetInAbilityPhase void SetInAbilityPhase(bool ) No Description Set
SetLevel void SetLevel(int ) Sets the level of this ability.
SetOverrideCastPoint void SetOverrideCastPoint(float ) No Description Set
SetRefCountsModifiers void SetRefCountsModifiers(bool ) No Description Set
SetStolen void SetStolen(bool ) No Description Set
ShouldUseResources bool ShouldUseResources() No Description Set
SpeakAbilityConcept void SpeakAbilityConcept(int ) No Description Set
SpeakTrigger bool SpeakTrigger() No Description Set
StartCooldown void StartCooldown(float ) param: flCooldown
ToggleAbility void ToggleAbility() No Description Set
ToggleAutoCast void ToggleAutoCast() No Description Set
UpgradeAbility void UpgradeAbility() No Description Set
UseResources void UseResources(bool , bool , bool ) No Description Set

CDOTA_Ability_Animation_Attack

extends CDOTABaseAbility

No Description Set

Function Signature Description
SetPlaybackRate void SetPlaybackRate(float ) Override playbackrate

CDOTA_Ability_Animation_TailSpin

extends CDOTABaseAbility

No Description Set

Function Signature Description
SetPlaybackRate void SetPlaybackRate(float ) Override playbackrate

CDOTA_Ability_Nian_Leap

extends CDOTABaseAbility

No Description Set

Function Signature Description
SetPlaybackRate void SetPlaybackRate(float ) Override playbackrate

CDOTA_Ability_Nian_Dive

extends CDOTABaseAbility

No Description Set

Function Signature Description
SetPlaybackRate void SetPlaybackRate(float ) Override playbackrate

CDOTA_Ability_Nian_Roar

extends CDOTABaseAbility

No Description Set

Function Signature Description
GetCastCount int GetCastCount() Number of times Nian has used the roar

CDOTA_Item

No Description Set

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

CDOTA_Item_Physical

No Description Set

Function Signature Description
GetContainedItem handle GetContainedItem() Returned the contained item.
GetCreationTime float GetCreationTime() Returns the game time when this item was created in the world
SetContainedItem void SetContainedItem(handle ) Set the contained item.

CDOTA_Item_DataDriven

No Description Set

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

CDOTA_Unit_Nian

No Description Set

Function Signature Description
GetHorn handle GetHorn() Is the Nian horn?
GetTail handle GetTail() Is the Nian's tail broken?
IsHornAlive bool IsHornAlive() Is the Nian's horn broken?
IsTailAlive bool IsTailAlive() Is the Nian's tail broken?

CBasePlayer

No Description Set

Function Signature Description
IsNoclipping bool IsNoclipping() Returns true if the player is in noclip mode.

CDOTAPlayer

No Description Set

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

CDOTA_PlayerResource

No Description Set

Global accessor variable: PlayerResource

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

CDOTA_BaseNPC

No Description Set

Function Signature Description
AddAbility void AddAbility(string ) Add an ability to this unit by name.
AddItem void AddItem(handle ) Add an item to this unit's inventory.
AddNewModifier void AddNewModifier(handle , handle , string , handle ) Add a modifier to this unit
AddNoDraw void AddNoDraw() Adds the no draw flag.
AlertNearbyUnits void AlertNearbyUnits(handle , handle ) No Description Set
AngerNearbyUnits void AngerNearbyUnits() No Description Set
AttackNoEarlierThan void AttackNoEarlierThan(float ) No Description Set
AttackReady bool AttackReady() No Description Set
BoundingRadius2D float BoundingRadius2D() No Description Set
CastAbilityImmediately void CastAbilityImmediately(handle , int ) Cast an ability immediately.
CastAbilityNoTarget void CastAbilityNoTarget(handle ability, int playerIndex) Cast an ability with no target. ( hAbility, iPlayerIndex )
CastAbilityOnPosition void CastAbilityOnPosition(Vector , handle , int ) Cast an ability on a position.
CastAbilityOnTarget void CastAbilityOnTarget(handle target, handle ability, int playerIndex) Cast an ability on a target entity.
CastAbilityToggle void CastAbilityToggle(handle , int ) Toggle an ability. ( hAbility, iPlayerIndex )
DisassembleItem void DisassembleItem(handle ) Disassemble the passed item in this unit's inventory.
DropItemAtPosition void DropItemAtPosition(Vector , handle ) Drop an item at a given point.
DropItemAtPositionImmediate void DropItemAtPositionImmediate(handle , Vector ) Immediately drop a carried item at a given position.
EjectItemFromStash void EjectItemFromStash(handle ) Drops the selected item out of this unit's stash.
FindAbilityByName handle FindAbilityByName(string ) Retrieve an ability by name from the unit.
ForceKill void ForceKill(bool ) Kill this unit immediately.
GetAbilityByIndex handle GetAbilityByIndex(int ) Retrieve an ability by index from the unit.
GetAbilityCount int GetAbilityCount() No Description Set
GetAcquisitionRange float GetAcquisitionRange() Gets the range at which this unit will auto-acquire.
GetAdditionalBattleMusicWeight float GetAdditionalBattleMusicWeight() Combat involving this creature will have this weight added to the music calcuations
GetAttackAnimationPoint float GetAttackAnimationPoint() No Description Set
GetAttackDamage int GetAttackDamage() Returns a random integer between the minimum and maximum base damage of the unit.
GetAttackRange float GetAttackRange() Gets this unit's attack range after all modifiers.
GetAttackRangeBuffer float GetAttackRangeBuffer() Gets the attack range buffer.
GetAttackSpeed float GetAttackSpeed() No Description Set
GetAttacksPerSecond float GetAttacksPerSecond() No Description Set
GetAttackTarget handle GetAttackTarget() No Description Set
GetAverageTrueAttackDamage int GetAverageTrueAttackDamage() Returns the average value of the minimum and maximum damage values.
GetBaseAttackRange int GetBaseAttackRange() Gets this unit's attack range before modifiers.
GetBaseAttackTime float GetBaseAttackTime() No Description Set
GetBaseDamageMax int GetBaseDamageMax() Gets the minimum base damage.
GetBaseDamageMin int GetBaseDamageMin() Gets the minimum base damage.
GetBaseDayTimeVisionRange int GetBaseDayTimeVisionRange() Returns the vision range before modifiers.
GetBaseHealthRegen float GetBaseHealthRegen() No Description Set
GetBaseMagicalResistanceValue float GetBaseMagicalResistanceValue() Returns base magical armor value.
GetBaseMaxHealth float GetBaseMaxHealth() Gets the base max health value.
GetBaseMoveSpeed float GetBaseMoveSpeed() No Description Set
GetBaseNightTimeVisionRange int GetBaseNightTimeVisionRange() Returns the vision range before modifiers.
GetCastPoint float GetCastPoint(bool ) Parameter: bAttack
GetCollisionPadding float GetCollisionPadding() Returns the size of the collision padding around the hull.
GetConstantBasedManaRegen float GetConstantBasedManaRegen() This Mana regen is derived from constant bonuses like Basilius.
GetCreationTime float GetCreationTime() No Description Set
GetCurrentActiveAbility handle GetCurrentActiveAbility() Get the ability this unit is currently casting.
GetCurrentVisionRange int GetCurrentVisionRange() Gets the current vision range.
GetCursorCastTarget handle GetCursorCastTarget() No Description Set
GetCursorPosition Vector GetCursorPosition() No Description Set
GetCursorTargetingNothing bool GetCursorTargetingNothing() No Description Set
GetDayTimeVisionRange int GetDayTimeVisionRange() Returns the vision range after modifiers.
GetDeathXP int GetDeathXP() Get the XP bounty on this unit
GetForceAttackTarget handle GetForceAttackTarget() No Description Set
GetGoldBounty int GetGoldBounty() Get the gold bounty on this unit
GetHasteFactor float GetHasteFactor() No Description Set
GetHealth int GetHealth() Get the health of this unit.
GetHealthDeficit int GetHealthDeficit() Returns integer amount of health missing from max.
GetHealthPercent int GetHealthPercent() Get the current health percent of the unit.
GetHealthRegen float GetHealthRegen() No Description Set
GetHullRadius float GetHullRadius() Get the collision hull radius of this NPC
GetIdealSpeed float GetIdealSpeed() Returns speed after all modifiers.
GetIncreasedAttackSpeed float GetIncreasedAttackSpeed() No Description Set
GetInitialGoalEntity handle GetInitialGoalEntity() Returns the initial waypoint goal for this NPC
GetItemInSlot handle GetItemInSlot(int ) Returns nth item in inventory slot (index is zero based)
GetLastIdleChangeTime float GetLastIdleChangeTime() Get the last game time that this unit switched to/from idle state.
GetLevel int GetLevel() Returns the level of this unit.
GetMagicalArmorValue float GetMagicalArmorValue() Returns current magical armor value.
GetMainControllingPlayer int GetMainControllingPlayer() Returns the player ID of the controlling player.
GetMana float GetMana() Get the mana on this unit.
GetManaPercent int GetManaPercent() Get the percent of mana remaining.
GetManaRegen float GetManaRegen() No Description Set
GetMaxHealth int GetMaxHealth() Get the maximum health of this unit.
GetMaxMana float GetMaxMana() Get the maximum mana of this unit.
GetModelRadius float GetModelRadius() No Description Set
GetModifierCount int GetModifierCount() How many modifiers does this unit have?
GetModifierNameByIndex string GetModifierNameByIndex(int ) Get a modifier name by index.
GetMoveSpeedModifier float GetMoveSpeedModifier(float ) No Description Set
GetMustReachEachGoalEntity bool GetMustReachEachGoalEntity() Get whether this NPC is required to reach each goal entity, rather than being allowed to 'unkink' their path
GetNightTimeVisionRange int GetNightTimeVisionRange() Returns the vision range after modifiers.
GetOpposingTeamNumber int GetOpposingTeamNumber() No Description Set
GetPaddedCollisionRadius float GetPaddedCollisionRadius() Get the collision hull radius (including padding) of this NPC
GetPercentageBasedManaRegen float GetPercentageBasedManaRegen() This Mana regen is derived from % bonuses (from items like Void Stone).
GetPhysicalArmorBaseValue float GetPhysicalArmorBaseValue() Returns base physical armor value.
GetPhysicalArmorValue float GetPhysicalArmorValue() Returns current physical armor value.
GetPlayerOwner handle GetPlayerOwner() Returns the player that owns this unit
GetPlayerOwnerID int GetPlayerOwnerID() Get the owner player ID for this unit.
GetProjectileSpeed int GetProjectileSpeed() No Description Set
GetRangeToUnit float GetRangeToUnit(handle ) No Description Set
GetSecondsPerAttack float GetSecondsPerAttack() No Description Set
GetStatsBasedManaRegen float GetStatsBasedManaRegen() Returns mana regen rate per intelligence.
GetTeamNumber int GetTeamNumber() Get the team number of this unit.
GetTotalPurchasedUpgradeGoldCost int GetTotalPurchasedUpgradeGoldCost() Get how much gold has been spent on ability upgrades.
GetUnitLabel string GetUnitLabel() No Description Set
GetUnitName string GetUnitName() No Description Set
GiveMana void GiveMana(float ) Give mana to this unit, this can be used for mana gained by abilities or item usage.
HasAbility bool HasAbility(string ) See whether this unit has an ability by name.
HasAttackCapability bool HasAttackCapability() No Description Set
HasFlyingVision bool HasFlyingVision() No Description Set
HasFlyMovementCapability bool HasFlyMovementCapability() No Description Set
HasGroundMovementCapability bool HasGroundMovementCapability() No Description Set
HasInventory bool HasInventory() No Description Set
HasItemInInventory bool HasItemInInventory(string ) See whether this unit has an item by name.
HasModifier bool HasModifier(string ) Sees if this unit has a given modifier
HasMovementCapability bool HasMovementCapability() No Description Set
HasScepter bool HasScepter() No Description Set
Heal void Heal(float , handle ) Heal this unit.
Hold void Hold() Hold position.
Interrupt void Interrupt() No Description Set
InterruptChannel void InterruptChannel() No Description Set
InterruptMotionControllers void InterruptMotionControllers(bool ) Parameter boolean determines finding clear space.
IsAlive bool IsAlive() Is this unit alive?
IsAncient bool IsAncient() Is this creature an Ancient?
IsAttackImmune bool IsAttackImmune() No Description Set
IsAttacking bool IsAttacking() No Description Set
IsAttackingEntity bool IsAttackingEntity(handle ) No Description Set
IsBlind bool IsBlind() No Description Set
IsBlockDisabled bool IsBlockDisabled() No Description Set
IsCommandRestricted bool IsCommandRestricted() No Description Set
IsControllableByAnyPlayer bool IsControllableByAnyPlayer() Is this unit controlled by any non-bot player?
IsCreature bool IsCreature() Is this a Creature type NPC
IsDeniable bool IsDeniable() No Description Set
IsDisarmed bool IsDisarmed() No Description Set
IsDominated bool IsDominated() No Description Set
IsEvadeDisabled bool IsEvadeDisabled() No Description Set
IsFrozen bool IsFrozen() No Description Set
IsHardDisarmed bool IsHardDisarmed() No Description Set
IsHero bool IsHero() Is this a hero or hero illusion?
IsHexed bool IsHexed() No Description Set
IsIdle bool IsIdle() Is this creature currently idle?
IsIllusion bool IsIllusion() No Description Set
IsInvisible bool IsInvisible() No Description Set
IsInvulnerable bool IsInvulnerable() No Description Set
IsLowAttackPriority bool IsLowAttackPriority() No Description Set
IsMagicImmune bool IsMagicImmune() No Description Set
IsMechanical bool IsMechanical() Is the unit mechanical?
IsMovementImpaired bool IsMovementImpaired() No Description Set
IsMuted bool IsMuted() No Description Set
IsNeutralUnitType bool IsNeutralUnitType() Is this a neutral?
IsNightmared bool IsNightmared() No Description Set
IsOpposingTeam bool IsOpposingTeam(int ) No Description Set
IsOutOfGame bool IsOutOfGame() No Description Set
IsOwnedByAnyPlayer bool IsOwnedByAnyPlayer() Is this unit owned by any non-bot player?
IsPhantom bool IsPhantom() Is this a phantom unit?
IsPhantomBlocker bool IsPhantomBlocker() No Description Set
IsPhased bool IsPhased() No Description Set
IsPositionInRange bool IsPositionInRange(Vector , float ) No Description Set
IsRangedAttacker bool IsRangedAttacker() Is this unit a ranged attacker?
IsRealHero bool IsRealHero() Returns true if the hero is a true Hero, not a creep or an Illusion of a hero
IsRooted bool IsRooted() No Description Set
IsSilenced bool IsSilenced() No Description Set
IsSoftDisarmed bool IsSoftDisarmed() No Description Set
IsSpeciallyDeniable bool IsSpeciallyDeniable() No Description Set
IsStunned bool IsStunned() No Description Set
IsSummoned bool IsSummoned() Is this unit summoned?
IsTower bool IsTower() Is this a tower?
IsUnableToMiss bool IsUnableToMiss() No Description Set
IsUnselectable bool IsUnselectable() No Description Set
Kill void Kill(handle , handle ) Kills this NPC, with the params Ability and Attacker
MakeIllusion void MakeIllusion() No Description Set
MakePhantomBlocker void MakePhantomBlocker() No Description Set
MakeVisibleDueToAttack void MakeVisibleDueToAttack(int ) No Description Set
MakeVisibleToTeam void MakeVisibleToTeam(int , float ) No Description Set
ModifyHealth void ModifyHealth(int , handle , bool , int ) Sets the health to a specific value, with optional flags or inflictors.
MoveToNPC void MoveToNPC(handle ) Move to follow a unit.
MoveToNPCToGiveItem void MoveToNPCToGiveItem(handle , handle ) Give an item to another unit.
MoveToPosition void MoveToPosition(Vector ) Issue a Move-To command
MoveToPositionAggressive void MoveToPositionAggressive(Vector ) Issue an Attack-Move-To command
MoveToTargetToAttack void MoveToTargetToAttack(handle ) Move to a target to attack.
NoHealthBar bool NoHealthBar() No Description Set
NoTeamMoveTo bool NoTeamMoveTo() No Description Set
NoTeamSelect bool NoTeamSelect() No Description Set
NotOnMinimap bool NotOnMinimap() No Description Set
NotOnMinimapForEnemies bool NotOnMinimapForEnemies() No Description Set
NoUnitCollision bool NoUnitCollision() No Description Set
PassivesDisabled bool PassivesDisabled() No Description Set
PerformAttack void PerformAttack(handle , bool , bool , bool , bool ) Performs an attack on a target. Params: Target, bUseCastAttackOrb, bProcessProcs, bSkipCooldown, bIgnoreInvis
PickupDroppedItem void PickupDroppedItem(handle ) Pick up a dropped item.
PickupRune void PickupRune(handle ) Pick up a rune.
ProvidesVision bool ProvidesVision() No Description Set
Purge void Purge(bool, bool, bool, bool, bool) Removes certain type of modifiers on this unit.
ReduceMana void ReduceMana(float ) Remove mana from this unit, this can be used for involuntary mana loss, not for mana that is spent.
RemoveAbility void RemoveAbility(string ) Remove an ability from this unit by name.
RemoveItem void RemoveItem(handle ) Removes the passed item from this unit's inventory.
RemoveModifierByName void RemoveModifierByName(string ) Removes a modifier
RemoveModifierByNameAndCaster void RemoveModifierByNameAndCaster(string , handle ) Removes a modifier that was cast by the given caster
RemoveNoDraw void RemoveNoDraw() Remove the no draw flag.
RespawnUnit void RespawnUnit() Respawns the target unit if it can be respawned.
SellItem void SellItem(handle ) Sells the passed item in this unit's inventory.
SetAdditionalBattleMusicWeight void SetAdditionalBattleMusicWeight(float ) Combat involving this creature will have this weight added to the music calcuations
SetAttackCapability void SetAttackCapability(int ) No Description Set
SetAttacking void SetAttacking(handle ) No Description Set
SetBaseAttackTime void SetBaseAttackTime(float ) No Description Set
SetBaseDamageMax void SetBaseDamageMax(int ) Sets the minimum base damage.
SetBaseDamageMin void SetBaseDamageMin(int ) Sets the minimum base damage.
SetBaseHealthRegen void SetBaseHealthRegen(float ) No Description Set
SetBaseMagicalResistanceValue void SetBaseMagicalResistanceValue(float ) Sets base magical armor value.
SetBaseManaRegen void SetBaseManaRegen(float ) No Description Set
SetBaseMaxHealth void SetBaseMaxHealth(float ) Set a new base max health value.
SetBaseMoveSpeed void SetBaseMoveSpeed(int ) No Description Set
SetControllableByPlayer void SetControllableByPlayer(int , bool ) Set this unit controllable by the player with the passed ID.
SetCursorCastTarget void SetCursorCastTarget(handle ) No Description Set
SetCursorPosition void SetCursorPosition(Vector ) No Description Set
SetCursorTargetingNothing void SetCursorTargetingNothing(bool ) No Description Set
SetDayTimeVisionRange void SetDayTimeVisionRange(int ) Set the base vision range.
SetDeathXP void SetDeathXP(int ) Set the XP bounty on this unit
SetForceAttackTarget void SetForceAttackTarget(handle ) No Description Set
SetHasInventory void SetHasInventory(bool ) No Description Set
SetHullRadius void SetHullRadius(float ) Set the collision hull radius of this NPC
SetIdleAcquire void SetIdleAcquire(bool ) No Description Set
SetInitialGoalEntity void SetInitialGoalEntity(handle ) Sets the initial waypoint goal for this NPC
SetMana void SetMana(float ) Set the mana on 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.
SetMoveCapability void SetMoveCapability(int ) No Description Set
SetMustReachEachGoalEntity void SetMustReachEachGoalEntity(bool ) Set whether this NPC is required to reach each goal entity, rather than being allowed to 'unkink' their path
SetNeverMoveToClearSpace void SetNeverMoveToClearSpace(bool ) If set to true, we will never attempt to move this unit to clear space, even when it unphases.
SetNightTimeVisionRange void SetNightTimeVisionRange(int ) Set the base vision range.
SetOriginalModel void SetOriginalModel(string originalModel) Sets the original model of this entity, which it will tend to fall back to anytime its state changes
SetPhysicalArmorBaseValue void SetPhysicalArmorBaseValue(float ) Sets base physical armor value.
SetRangedProjectileName void SetRangedProjectileName(string ) No Description Set
SetStolenScepter void SetStolenScepter(bool ) No Description Set
SetUnitName void SetUnitName(string ) No Description Set
ShouldIdleAcquire bool ShouldIdleAcquire() No Description Set
SpendMana void SpendMana(float , handle ) Spend mana from this unit, this can be used for spending mana from abilities or item usage.
Stop void Stop() Stop the current order.
SwapAbilities void SwapAbilities(string , string , bool , bool ) Swaps the slots of the two passed abilities and sets them enabled/disabled: const char* AbilityName1, const char* AbilityName2, bool bEnable1, bool bEnable2. The boolean controls which ability is active. The ability order is never swapped when swapping abilities, only the boolean statements are flipped.
TimeUntilNextAttack float TimeUntilNextAttack() No Description Set
TriggerModifierDodge bool TriggerModifierDodge() No Description Set
TriggerSpellAbsorb bool TriggerSpellAbsorb(handle ) Query whether the passed ability will trigger spell absorb on this unit.
UnitCanRespawn bool UnitCanRespawn() No Description Set

CDOTA_BaseNPC_Hero

No Description Set

Function Signature Description
AddExperience bool AddExperience(float , bool ) Params: Float XP, Bool applyBotDifficultyScaling
Buyback void Buyback() Spend the gold and buyback with this hero.
CalculateStatBonus void CalculateStatBonus() Recalculate all stats after the hero gains stats.
CanEarnGold bool CanEarnGold() Returns boolean value result of buyback gold limit time less than game time.
ClearLastHitMultikill void ClearLastHitMultikill() Value is stored in PlayerResource.
ClearLastHitStreak void ClearLastHitStreak() Value is stored in PlayerResource.
ClearStreak void ClearStreak() Value is stored in PlayerResource.
GetAbilityPoints int GetAbilityPoints() Gets the current unspent ability point's.
GetAgility float GetAgility() No Description Set
GetAgilityGain float GetAgilityGain() No Description Set
GetAssists int GetAssists() Value is stored in PlayerResource.
GetAttacker int GetAttacker(int ) No Description Set
GetBaseAgility float GetBaseAgility() No Description Set
GetBaseDamageMax int GetBaseDamageMax() Hero damage is also affected by attributes.
GetBaseDamageMin int GetBaseDamageMin() Hero damage is also affected by attributes.
GetBaseIntellect float GetBaseIntellect() No Description Set
GetBaseStrength float GetBaseStrength() No Description Set
GetBonusDamageFromPrimaryStat int GetBonusDamageFromPrimaryStat() No Description Set
GetBuybackCooldownTime float GetBuybackCooldownTime() Return float value for the amount of time left on cooldown for this hero's buyback.
GetBuybackCost int GetBuybackCost() Return integer value for the gold cost of a buyback.
GetBuybackGoldLimitTime float GetBuybackGoldLimitTime() Returns the amount of time gold gain is limited after buying back.
GetCurrentXP int GetCurrentXP() Returns the amount of XP
GetDeathGoldCost int GetDeathGoldCost() No Description Set
GetDeaths int GetDeaths() Value is stored in PlayerResource.
GetDenies int GetDenies() Value is stored in PlayerResource.
GetGold int GetGold() Returns gold amount for the player owning this hero
GetGoldBounty int GetGoldBounty() No Description Set
GetHealthRegen float GetHealthRegen() Hero health regen is affected by attributes.
GetIncreasedAttackSpeed float GetIncreasedAttackSpeed() Hero attack speed is also affected by agility.
GetIntellect float GetIntellect() No Description Set
GetIntellectGain float GetIntellectGain() No Description Set
GetKills int GetKills() Value is stored in PlayerResource.
GetLastHits int GetLastHits() Value is stored in PlayerResource.
GetManaRegen float GetManaRegen() Hero mana regen is affected by attributes.
GetMostRecentDamageTime float GetMostRecentDamageTime() No Description Set
GetMultipleKillCount int GetMultipleKillCount() No Description Set
GetNumAttackers int GetNumAttackers() No Description Set
GetPhysicalArmorValue float GetPhysicalArmorValue() Hero armor is affected by attributes.
GetPlayerID int GetPlayerID() Returns player ID of the player owning this hero
GetPrimaryAttribute int GetPrimaryAttribute() 0 = strength, 1 = agility, 2 = intelligence.
GetPrimaryStatValue float GetPrimaryStatValue() No Description Set
GetRespawnTime float GetRespawnTime() No Description Set
GetStatsBasedManaRegen float GetStatsBasedManaRegen() Returns only the regen based on Intelligence.
GetStreak int GetStreak() Value is stored in PlayerResource.
GetStrength float GetStrength() No Description Set
GetStrengthGain float GetStrengthGain() No Description Set
GetTimeUntilRespawn float GetTimeUntilRespawn() No Description Set
HasAnyAvailableInventorySpace bool HasAnyAvailableInventorySpace() No Description Set
HasFlyingVision bool HasFlyingVision() No Description Set
HasOwnerAbandoned bool HasOwnerAbandoned() No Description Set
HasRoomForItem int HasRoomForItem(string , bool , bool ) Args: const char* pItemName, bool bIncludeStashCombines, bool bAllowSelling
HeroLevelUp void HeroLevelUp(bool ) Levels up the hero, true or false to play effects.
IncrementAssists void IncrementAssists() Value is stored in PlayerResource.
IncrementDeaths void IncrementDeaths() Value is stored in PlayerResource.
IncrementDenies void IncrementDenies() Value is stored in PlayerResource.
IncrementKills void IncrementKills(int kills) Passed ID is for the victim, killer ID is ID of the current hero. Value is stored in PlayerResource.
IncrementLastHitMultikill void IncrementLastHitMultikill() Value is stored in PlayerResource.
IncrementLastHits void IncrementLastHits() Value is stored in PlayerResource.
IncrementLastHitStreak void IncrementLastHitStreak() Value is stored in PlayerResource.
IncrementNearbyCreepDeaths void IncrementNearbyCreepDeaths() Value is stored in PlayerResource.
IncrementStreak void IncrementStreak() Value is stored in PlayerResource.
IsBuybackDisabledByReapersScythe bool IsBuybackDisabledByReapersScythe() No Description Set
IsReincarnating bool IsReincarnating() No Description Set
KilledHero void KilledHero(handle , handle ) Args: Hero, Inflictor
ModifyAgility void ModifyAgility(float ) Adds passed value to base attribute value, then calls CalculateStatBonus.
ModifyGold int ModifyGold(int goldAmmt, bool reliable, int reason) Gives this hero some gold. Args: int nGoldChange, bool bReliable, int reason
ModifyIntellect void ModifyIntellect(float ) Adds passed value to base attribute value, then calls CalculateStatBonus.
ModifyStrength void ModifyStrength(float ) Adds passed value to base attribute value, then calls CalculateStatBonus.
PerformTaunt void PerformTaunt() No Description Set
RecordLastHit void RecordLastHit() No Description Set
RespawnHero void RespawnHero(bool , bool , bool ) Respawn this hero.
SetAbilityPoints void SetAbilityPoints(int ) Sets the current unspent ability point's.
SetBaseAgility void SetBaseAgility(float ) No Description Set
SetBaseIntellect void SetBaseIntellect(float ) No Description Set
SetBaseStrength void SetBaseStrength(float ) No Description Set
SetBuybackCooldownTime void SetBuybackCooldownTime(float ) Sets the buyback cooldown time.
SetBuyBackDisabledByReapersScythe void SetBuyBackDisabledByReapersScythe(bool ) No Description Set
SetBuybackGoldLimitTime void SetBuybackGoldLimitTime(float ) Set the amount of time gold gain is limited after buying back.
SetCustomDeathXP void SetCustomDeathXP(int ) Sets a custom experience value for this hero.
Tip.pngTip:GameRules boolean must be set for this to work!
SetGold void SetGold(int , bool ) Sets the gold amount for the player owning this hero
SetPlayerID void SetPlayerID(int ) No Description Set
SetRespawnPosition void SetRespawnPosition(Vector ) No Description Set
SetTimeUntilRespawn void SetTimeUntilRespawn(float ) No Description Set
ShouldDoFlyHeightVisual bool ShouldDoFlyHeightVisual() No Description Set
SpendGold void SpendGold(int , int ) Args: int nGold, int nReason
UnitCanRespawn bool UnitCanRespawn() No Description Set
UpgradeAbility void UpgradeAbility(handle ) This upgrades the passed ability if it exists and the hero has enough ability point's.
WillReincarnate bool WillReincarnate() No Description Set

CDOTA_BaseNPC_Creature

No Description Set

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

CDOTA_BaseNPC_Building

No Description Set

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

CRPG_Unit

No Description Set

Function Signature Description
ActionState handle ActionState() return the ActionState object for this unit.
ClearMovementTarget void ClearMovementTarget() Clear any movement target entity/position.
FindSensedEnemies table FindSensedEnemies() returns list of all enemy units within this unit's sight cone or sensing sphere
GetMaxSpeed float GetMaxSpeed() returns unit's max speed
GetMaxStamina float GetMaxStamina() returns maximum stamina amount.
GetMovementTargetEntity handle GetMovementTargetEntity() Returs the movement target entity, if set.
GetSensingSphereRange float GetSensingSphereRange() returns range of unit's 360 degree sensing sphere
GetSightConeAngle float GetSightConeAngle() returns angle in which the unit can see things up to sight range
GetSightConeRange float GetSightConeRange() returns range of unit's sight cone
GetStamina float GetStamina() returns current stamina amount.
GetTurnRate float GetTurnRate() returns unit's turn rate in degrees per second
GetUnitName string GetUnitName() get the unit name for this unit.
GrantItem void GrantItem(string , bool ) ( sItemName ) - grant an item to the unit by name.
IsBlocking bool IsBlocking() is this unit blocking?
IsFacing bool IsFacing(Vector , float ) ( vecTargetPosition, flAngleTolerance ) - returns true if the unit is within flAngleTolerance degrees of the target position
SetBlocking void SetBlocking(bool ) ( bShouldBlock ) - Set the blocking state of this unit.
SetMaxSpeed void SetMaxSpeed(float ) ( flMaxSpeed ) - sets unit's max speed
SetMovementTargetEntity void SetMovementTargetEntity(handle , float ) ( hTargetEntity, flTargetRange ) - Try to move this unit to the given range from the target entity.
SetMovementTargetPosition void SetMovementTargetPosition(Vector , float ) ( vecTargetPosition, flTargetRange ) - Try to move this unit to the given range from the target point.
SetSensingSphereRange void SetSensingSphereRange(float ) ( flSightRange ) - set range of unit's 360 degree sensing sphere
SetSightConeAngle void SetSightConeAngle(float ) ( flAngleDegrees ) - sets angle in which the unit can see things up to sight range
SetSightConeRange void SetSightConeRange(float ) ( fRange ) - set range of unit's sight cone
SetTurnRate void SetTurnRate(float ) ( flTurnRate ) - sets unit's turn rate in degrees per second

CDOTABaseGameMode

No Description Set

Function Signature Description
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.
SetAlwaysShowPlayerInventory void SetAlwaysShowPlayerInventory(bool ) Show the player hero's inventory in the HUD, regardless of what unit is selected.
SetBotThinkingEnabled void SetBotThinkingEnabled(bool ) Enables/Disables bot thinking. Requires a very Dota PvP-like map with 3 lanes, a shop, etc.
SetBuybackEnabled void SetBuybackEnabled(bool ) Enables or disables buyback completely
SetCameraDistanceOverride void SetCameraDistanceOverride(float ) Set a different camera distance; dota default is 1134.
SetCustomBuybackCooldownEnabled void SetCustomBuybackCooldownEnabled(bool ) Turns on capability to define custom buyback cooldowns.
SetCustomBuybackCostEnabled void SetCustomBuybackCostEnabled(bool ) Turns on capability to define custom buyback costs.
SetCustomHeroMaxLevel void SetCustomHeroMaxLevel(int maxLevel) Allows definition of the max level heroes can achieve (default is 25).
SetCustomXPRequiredToReachNextLevel void SetCustomXPRequiredToReachNextLevel(handle ) Allows definition of a table of hero XP values.
SetFogOfWarDisabled void SetFogOfWarDisabled(bool ) Turn the fog of war on or off.
SetGoldSoundDisabled void SetGoldSoundDisabled(bool ) Turn the sound when gold is acquired off/on. Takes a bool.
SetOverrideSelectionEntity void SetOverrideSelectionEntity(handle unit) Set an override for the default selection entity, instead of each player's hero.
SetRecommendedItemsDisabled void SetRecommendedItemsDisabled(bool ) Turn the panel for showing recommended items at the shop off/on. Takes a bool.
SetRemoveIllusionsOnDeath void SetRemoveIllusionsOnDeath(bool ) Make it so illusions are immediately removed upon death, rather than sticking around for a few seconds.
SetTopBarTeamValue void SetTopBarTeamValue(int , int ) Set the team values on the top game bar.
SetTopBarTeamValuesOverride void SetTopBarTeamValuesOverride(bool ) Override the values of the team values on the top game bar.
SetTopBarTeamValuesVisible void SetTopBarTeamValuesVisible(bool ) Turning on/off the team values on the top game bar.
SetTowerBackdoorProtectionEnabled void SetTowerBackdoorProtectionEnabled(bool ) Enables/Disables tower backdoor protection
SetUseCustomHeroLevels void SetUseCustomHeroLevels(bool ) Turn on custom-defined XP values for hero level ups. The table should be defined before switching this on.

CDotaQuest

No Description Set

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

CDotaSubquestBase

No Description Set

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

CPhysicsComponent

No Description Set

Function Signature Description
ExpensiveInstantRayCast bool ExpensiveInstantRayCast(Vector , Vector , handle ) Do an instant (i.e. blocking) Ray Cast. Will do a handle/queue version later. Don't plan to use this for real!

CPointTemplate

No Description Set

Function Signature Description
DeleteCreatedSpawnGroups void DeleteCreatedSpawnGroups() DeleteCreatedSpawnGroups() : Deletes any spawn groups that this point_template has spawned. Note: The point_template will not be deleted by this.
ForceSpawn void ForceSpawn() ForceSpawn() : Spawns all of the entities the point_template is pointing at.
GetSpawnedEntities handle GetSpawnedEntities() GetSpawnedEntities() : Get the list of the most recent spawned entities
SetSpawnCallback void SetSpawnCallback(handle , handle ) SetSpawnCallback( hCallbackFunc, hCallbackScope, hCallbackData ) : Set a callback for when the template spawns entities. The spawned entities will be passed in as an array.

CBodyComponent

No Description Set

Function Signature Description
AddImpulseAtPosition void AddImpulseAtPosition(Vector , Vector ) Apply an impulse at a worldspace position to the physics
AddVelocity void AddVelocity(Vector , Vector ) Add linear and angular velocity to the physics object
DetachFromParent void DetachFromParent() Detach from its parent
GetSequence <> GetSequence() Returns the active sequence
IsAttachedToParent bool IsAttachedToParent() Is attached to parent
LookupSequence <> LookupSequence(string ) Returns a sequence id given a name
SequenceDuration float SequenceDuration(string ) Returns the duration in seconds of the specified sequence
SetAngularVelocity void SetAngularVelocity(Vector ) No Description Set
SetAnimation void SetAnimation(string ) Pass string for the animation to play on this model
SetBodyGroup void SetBodyGroup(string ) No Description Set
SetMaterialGroup void SetMaterialGroup(utlstringtoken ) No Description Set
SetVelocity void SetVelocity(Vector velocity) No Description Set

CBaseAnimating

No Description Set

Function Signature Description
GetAttachmentAngles Vector GetAttachmentAngles(int ) Get the attachement id's angles as a p,y,r vector
GetAttachmentOrigin Vector GetAttachmentOrigin(int ) Get the attachement id's origin vector
IsSequenceFinished bool IsSequenceFinished() Ask whether the main sequence is done playing
ScriptLookupAttachment int ScriptLookupAttachment(string ) Get the named attachment id
SetBodygroup void SetBodygroup(int , int ) Sets a bodygroup
SetModelScale void SetModelScale(float modelScale) ( flScale ) - set scale of entity's model
SetPoseParameter float SetPoseParameter(string , float ) Set the specified pose parameter to the specified value

CBaseCombatCharacter

No Description Set

Function Signature Description
GetEquippedWeapons table GetEquippedWeapons() GetEquippedWeapons() : Returns an array of all the equipped weapons
GetWeaponCount int GetWeaponCount() GetWeaponCount() : Gets the number of weapons currently equipped

ProjectileManager

No Description Set

Function Signature Description
CreateLinearProjectile int CreateLinearProjectile(handle ) Creates a linear projectile and returns the projectile ID
CreateTrackingProjectile void CreateTrackingProjectile(handle ) Creates a tracking projectile
DestroyLinearProjectile void DestroyLinearProjectile(int ) Destroys the linear projectile matching the argument ID
ProjectileDodge void ProjectileDodge(handle ) Makes the specified unit dodge projectiles

CBaseTrigger

No Description Set

Function Signature Description
Disable void Disable() Disable the trigger
Enable void Enable() Enable the trigger
IsTouching bool IsTouching(handle ) Checks whether the passed entity is touching the trigger.

CEnvEntityMaker

No Description Set

Function Signature Description
SpawnEntity void SpawnEntity() Create an entity at the location of the maker
SpawnEntityAtEntityOrigin void SpawnEntityAtEntityOrigin(handle ) Create an entity at the location of a specified entity instance
SpawnEntityAtLocation void SpawnEntityAtLocation(Vector , Vector ) Create an entity at a specified location and orientaton, orientation is Euler angle in degrees (pitch, yaw, roll)
SpawnEntityAtNamedEntityOrigin void SpawnEntityAtNamedEntityOrigin(string ) Create an entity at the location of a named entity

CDOTAVoteSystem

No Description Set

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

CMarkupVolumeTagged

No Description Set

Function Signature Description
HasTag bool HasTag(string ) Does this volume have the given tag.

CScriptPrecacheContext

No Description Set

Function Signature Description
AddResource void AddResource(string ) Precaches a specific resource
GetValue table GetValue(string ) Reads a spawn key

CScriptKeyValues

No Description Set

Function Signature Description
GetValue table GetValue(string ) Reads a spawn key

CScriptParticleManager

No Description Set

Global accessor variable: ParticleManager

Function Signature Description
CreateParticle int CreateParticle(string particleName, int particleAttach, handle owningEntity) Creates a new particle effect
CreateParticleForPlayer int CreateParticleForPlayer(string particleName, int particleAttach, handle owningEntity, handle owningPlayer) Creates a new particle effect that only plays for the specified player
GetParticleReplacement string GetParticleReplacement(string , handle ) No Description Set
ReleaseParticleIndex void ReleaseParticleIndex(int particleId) Frees the specified particle index
SetParticleAlwaysSimulate void SetParticleAlwaysSimulate(int ) No Description Set
SetParticleControl void SetParticleControl(int particleId, int controlIndex, Vector controlData) Set the control point data for a control on a particle effect
SetParticleControlEnt void SetParticleControlEnt(int , int , handle , int , string , Vector , bool ) No Description Set

CScriptHeroList

No Description Set

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

CNativeOutputs

No Description Set

Function Signature Description
AddOutput void AddOutput(string , string ) Add an output
Init void Init(int ) Initialize with number of outputs

CEnvProjectedTexture

No Description Set

Function Signature Description
SetFarRange void SetFarRange(float ) Set light maximum range
SetLinearAttenuation void SetLinearAttenuation(float ) Set light linear attenuation value
SetNearRange void SetNearRange(float ) Set light minimum range
SetQuadraticAttenuation void SetQuadraticAttenuation(float ) Set light quadratic attenuation value
SetVolumetrics void SetVolumetrics(bool , float , float , int , float ) Turn on/off light volumetrics: bool bOn, float flIntensity, float flNoise, int nPlanes, float flPlaneOffset

CInfoData

No Description Set

Function Signature Description
QueryColor Vector QueryColor(utlstringtoken , Vector ) Query color data for this key
QueryFloat float QueryFloat(utlstringtoken , float ) Query float data for this key
QueryInt int QueryInt(utlstringtoken , int ) Query int data for this key
QueryNumber float QueryNumber(utlstringtoken , float ) Query number data for this key
QueryString string QueryString(utlstringtoken , string ) Query string data for this key
QueryVector Vector QueryVector(utlstringtoken , Vector ) Query vector data for this key

CPhysicsProp

No Description Set

Function Signature Description
DisableMotion void DisableMotion() Enable motion for the prop
EnableMotion void EnableMotion() Enable motion for the prop

CDOTAGamerules

No Description Set

Function Signature Description
Defeated void Defeated() Kills the ancient, etc.
DidMatchSignoutTimeOut bool DidMatchSignoutTimeOut() true when we have waited some time after end of the game and not received signout
GetCustomGameDifficulty int GetCustomGameDifficulty() Returns the difficulty level of the custom game mode
GetDifficulty int GetDifficulty() Returns difficulty level of the custom game mode
GetDroppedItem handle GetDroppedItem(int dropIndex) Gets the Xth dropped item
GetGameModeEntity handle GetGameModeEntity() Get the game mode entity
GetGameTime float GetGameTime() Returns the number of seconds elapsed since map start. This time doesn't count up when the game is paused
GetDOTATime float GetDOTATime(bool IncludePregameTime, bool IncludeNegativeTime) Returns the actual Dota in-game clock time.
GetMatchSignoutComplete bool GetMatchSignoutComplete() Have we received the post match signout message that includes reward information
GetNianFightStartTime float GetNianFightStartTime() Gets the start time for the Nian fight
GetNianTotalDamageTaken int GetNianTotalDamageTaken() For New Bloom, get total damage taken by the Nian / Year Beast
GetTimeOfDay float GetTimeOfDay() Get the time of day
IsDaytime bool IsDaytime() Is it day time.
MakeTeamLose void MakeTeamLose(int team) Makes ths specified team lose
NumDroppedItems int NumDroppedItems() Returns the number of items currently dropped on the ground
Playtesting_UpdateAddOnKeyValues void Playtesting_UpdateAddOnKeyValues() Updates custom hero, unit and ability KeyValues in memory with the latest values from disk
ResetDefeated void ResetDefeated() Restart after killing the ancient, etc.
ResetToHeroSelection void ResetToHeroSelection() Restart the game at hero selection
SendCustomMessage void SendCustomMessage(string , int , int ) Sends a string to the defined team.
SetCreepMinimapIconScale void SetCreepMinimapIconScale(float scale) Scale the creep icons on the minimap.
SetCustomGameDifficulty void SetCustomGameDifficulty(int ) Set the difficulty level of the custom game mode
SetFirstBloodActive void SetFirstBloodActive(bool ) Sets whether First Blood has been triggered.
SetGameWinner void SetGameWinner(int team) Makes ths specified team win
SetGoldPerTick void SetGoldPerTick(int ) Set the auto gold increase per timed interval.
SetGoldTickTime void SetGoldTickTime(float ) Set the time interval between auto gold increases.
SetHeroMinimapIconSize void SetHeroMinimapIconSize(int iconSize) (nMinimapHeroIconSize) - Set the hero minimap icon size.
SetHeroRespawnEnabled void SetHeroRespawnEnabled(bool canRespawn) Control if the normal DOTA hero respawn rules apply.
SetHeroSelectionTime void SetHeroSelectionTime(float time) Sets the amount of time players have to pick their hero.
SetNianFightStartTime void SetNianFightStartTime(float ) Sets the start time for the Nian fight
SetOverlayHealthBarUnit void SetOverlayHealthBarUnit(handle unit, int style) Show this unit's health on the overlay health bar
SetPostGameTime void SetPostGameTime(float time) Sets the amount of time players have between the game ending and the server disconnecting them.
SetPreGameTime void SetPreGameTime(float time) Sets the amount of time players have between picking their hero and game start.
SetRuneMinimapIconScale void SetRuneMinimapIconScale(float scale) Scale the rune icons on the minimap.
SetRuneSpawnTime void SetRuneSpawnTime(float time) Sets the amount of time between rune spawns.
SetSafeToLeave void SetSafeToLeave(bool safeToLeave) Mark this game as safe to leave.
SetSameHeroSelectionEnabled void SetSameHeroSelectionEnabled(bool enabled) When true, players can repeatedly pick the same hero.
SetTimeOfDay void SetTimeOfDay(float time) Set the time of day.
SetTreeRegrowTime void SetTreeRegrowTime(float time) Sets the tree regrow time in seconds.
SetUseBaseGoldBountyOnHeroes void SetUseBaseGoldBountyOnHeroes(bool ) Heroes will use the basic NPC functionality for determining their bounty, rather than DOTA specific formulas.
SetUseCustomHeroXPValues void SetUseCustomHeroXPValues(bool ) Allows heroes in the map to give a specific amount of XP (this value must be set).
SetUseUniversalShopMode void SetUseUniversalShopMode(bool enabled) When true, all items are available at as long as any shop is in range, including Secret Shop items
State_Get <> State_Get() Get the current Gamerules state

CToneMapControllerComponent

No Description Set

Function Signature Description
GetBloomScale float GetBloomScale() Gets bloomscale for this tonemap controller
GetMaxExposure float GetMaxExposure() Gets max exposure for this tonemap controller
GetMinExposure float GetMinExposure() Gets min exposure for this tonemap controller
SetBloomScale void SetBloomScale(float ) Sets bloom scale for this tonemap controller
SetMaxExposure void SetMaxExposure(float ) Sets max exposure for this tonemap controller
SetMinExposure void SetMinExposure(float ) Sets min exposure for this tonemap controller

CDebugOverlayScriptHelper

No Description Set

Function Signature Description
Axis void Axis(Vector , Quaternion , float , bool , float ) Draws an axis. Specify origin + orientation in world space.
Box void Box(Vector , Vector , int , int , int , int , bool , float ) Draws a world-space axis-aligned box. Specify bounds in world space.
BoxAngles void BoxAngles(Vector , Vector , Vector , Quaternion , int , int , int , int , bool , float ) Draws an oriented box at the origin. Specify bounds in local space.
Capsule void Capsule(Vector , Quaternion , float , float , int , int , int , int , bool , float ) Draws a capsule. Specify base in world space.
Circle void Circle(Vector , Quaternion , float , int , int , int , int , bool , float ) Draws a circle. Specify center in world space.
CircleScreenOriented void CircleScreenOriented(Vector , float , int , int , int , int , bool , float ) Draws a circle oriented to the screen. Specify center in world space.
Cone void Cone(Vector , Vector , float , float , int , int , int , int , bool , float ) Draws a wireframe cone. Specify endpoint and direction in world space.
Cross void Cross(Vector , float , int , int , int , int , bool , float ) Draws a screen-aligned cross. Specify origin in world space.
Cross3D void Cross3D(Vector , float , int , int , int , int , bool , float ) Draws a world-aligned cross. Specify origin in world space.
Cross3DOriented void Cross3DOriented(Vector , Quaternion , float , int , int , int , int , bool , float ) Draws an oriented cross. Specify origin in world space.
DrawTickMarkedLine void DrawTickMarkedLine(Vector , Vector , float , int , int , int , int , int , bool , float ) Draws a dashed line. Specify endpoint's in world space.
EntityAttachments void EntityAttachments(ehandle , float ) Draws the attachments of the entity
EntityAxis void EntityAxis(ehandle , float , bool , float ) Draws the axis of the entity origin
EntityBounds void EntityBounds(ehandle , int , int , int , int , bool , float ) Draws bounds of an entity
EntitySkeleton void EntitySkeleton(ehandle , float ) Draws the skeleton of the entity
EntityText void EntityText(ehandle , int , string , int , int , int , int , float ) Draws text on an entity
FilledRect2D void FilledRect2D(Vector2D , Vector2D , int , int , int , int , float ) Draws a screen-space filled 2D rectangle. Coordinates are in pixels.
HorzArrow void HorzArrow(Vector , Vector , float , int , int , int , int , bool , float ) Draws a horizontal arrow. Specify endpoint's in world space.
Line void Line(Vector , Vector , int , int , int , int , bool , float ) Draws a line between two point's
Line2D void Line2D(Vector2D , Vector2D , int , int , int , int , float ) Draws a line between two point's in screenspace
PopDebugOverlayScope void PopDebugOverlayScope() Pops the identifier used to group overlays. Overlays marked with this identifier can be deleted in a big batch.
PushAndClearDebugOverlayScope void PushAndClearDebugOverlayScope(utlstringtoken ) Pushes an identifier used to group overlays. Deletes all existing overlays using this overlay id.
PushDebugOverlayScope void PushDebugOverlayScope(utlstringtoken ) Pushes an identifier used to group overlays. Overlays marked with this identifier can be deleted in a big batch.
RemoveAllInScope void RemoveAllInScope(utlstringtoken ) Removes all overlays marked with a specific identifier, regardless of their lifetime.
SolidCone void SolidCone(Vector , Vector , float , float , int , int , int , int , bool , float ) Draws a solid cone. Specify endpoint and direction in world space.
Sphere void Sphere(Vector , float , int , int , int , int , bool , float ) Draws a wireframe sphere. Specify center in world space.
SweptBox void SweptBox(Vector , Vector , Vector , Vector , Quaternion , int , int , int , int , float ) Draws a swept box. Specify endpoint's in world space and the bounds in local space.
Text void Text(Vector , int , string , float , int , int , int , int , float ) Draws 2D text. Specify origin in world space.
Texture void Texture(string , Vector2D , Vector2D , int , int , int , int , Vector2D , Vector2D , float ) Draws a screen-space texture. Coordinates are in pixels.
Triangle void Triangle(Vector , Vector , Vector , int , int , int , int , bool , float ) Draws a filled triangle. Specify vertices in world space.
UnitTestCycleOverlayRenderType void UnitTestCycleOverlayRenderType() Toggles the overlay render type, for unit tests
VectorText3D void VectorText3D(Vector , Quaternion , string , int , int , int , int , bool , float ) Draws 3D text. Specify origin + orientation in world space.
VertArrow void VertArrow(Vector , Vector , float , int , int , int , int , bool , float ) Draws a vertical arrow. Specify endpoint's in world space.
YawArrow void YawArrow(Vector , float , float , float , int , int , int , int , bool , float ) Draws a arrow associated with a specific yaw. Specify endpoint's in world space.

CBaseFlex

No Description Set

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

CSceneEntity

No Description Set

Function Signature Description
AddBroadcastTeamTarget void AddBroadcastTeamTarget(int ) Adds a team (by index) to the broadcast list
Cancel void Cancel() Cancel scene playback
EstimateLength float EstimateLength() Returns length of this scene in seconds.
FindCamera handle FindCamera() Get the camera
FindNamedEntity handle FindNamedEntity(string ) given an entity reference, such as !target, get actual entity from scene object
IsPaused bool IsPaused() If this scene is currently paused.
IsPlayingBack bool IsPlayingBack() If this scene is currently playing.
LoadSceneFromString bool LoadSceneFromString(string , string ) given a dummy scene name and a vcd string, load the scene
RemoveBroadcastTeamTarget void RemoveBroadcastTeamTarget(int ) Removes a team (by index) from the broadcast list
Start void Start(handle ) Start scene playback, takes activatorEntity as param

GridNav

No Description Set

Function Signature Description
GridPosToWorldCenterX float GridPosToWorldCenterX(int ) Get the X position of the center of a given X index
GridPosToWorldCenterY float GridPosToWorldCenterY(int ) Get the Y position of the center of a given Y index
IsBlocked bool IsBlocked(Vector ) Checks whether the given position is blocked
IsNearbyTree bool IsNearbyTree(Vector , float , bool ) (position, radius, checkFullTreeRadius?) Checks whether there are any trees overlapping the given point
IsTraversable bool IsTraversable(Vector ) Checks whether the given position is traversable
RegrowAllTrees void RegrowAllTrees() Causes all trees in the map to regrow
WorldToGridPosX int WorldToGridPosX(float ) Get the X index of a given world X position
WorldToGridPosY int WorldToGridPosY(float ) Get the Y index of a given world Y position

Convars

No Description Set

Global accessor variable: ConVars

Function Signature Description
GetBool table GetBool(string variableName) GetBool(name) : returns the convar as a boolean flag.
GetCommandClient handle GetCommandClient() GetCommandClient() : returns the player who issued this console command.
GetDOTACommandClient handle GetDOTACommandClient() GetDOTACommandClient() : returns the DOTA player who issued this console command.
GetFloat table GetFloat(string name) GetFloat(name) : returns the convar as a float. May return nil if no such convar.
GetInt table GetInt(string ) GetInt(name) : returns the convar as an int. May return nil if no such convar.
GetStr table GetStr(string variableName) GetStr(name) : returns the convar as a string. May return nil if no such convar.
RegisterCommand void RegisterCommand(string variableName, handle function, string helpText, int flags) RegisterCommand(name, fn, helpString, flags) : register a console command.
RegisterConvar void RegisterConvar(string name, string defaultValue, string helpText, int flags) RegisterConvar(name, defaultValue, helpString, flags): register a new console variable.
SetBool void SetBool(string variableName, bool value) SetBool(name, val) : sets the value of the convar to the bool.
SetFloat void SetFloat(string variableName, float value) SetFloat(name, val) : sets the value of the convar to the float.
SetInt void SetInt(string , int ) SetInt(name, val) : sets the value of the convar to the int.
SetStr void SetStr(string , string ) SetStr(name, val) : sets the value of the convar to the string.
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Dota_2_Workshop_Tools/Scripting/API/&oldid=381918"