Skip to content

Lua API — Interfaces & Classes

Global Singletons

Name Type Description
CustomGameEventManager CCustomGameEventManager
CustomNetTables CCustomNetTableManager
debugoverlay CDebugOverlayScriptHelper
CustomUI CustomUIManager
PlayerResource PlayerResourceType
DOTAGameManager GameManager
GameRules GameRulesType
Tutorial TutorialType
VoteSystem VoteSystemType
Entities CEntities
NativeFunctions CEntityScriptFramework
Convars ConvarsType
HeroList CScriptHeroList
ParticleManager CScriptParticleManager
GlobalSys GlobalSysType
GridNav GridNavType
ProjectileManager ProjectileManagerType
SteamInfo SteamInfoType

CBaseAnimatingActivity

Native name: CBaseAnimatingActivity

Extends: CBaseModelEntity

Properties

Property Type Native Name Description
cycle var Float GetCycle / SetCycle Get the cycle of the animation.
sequence var String GetSequence / SetSequence Returns the name of the active sequence.
isSequenceFinished val Boolean IsSequenceFinished Ask whether the main sequence is done playing.

Methods

Method Return Type Native Name Description
activeSequenceDuration() Float = externalSource() ActiveSequenceDuration Returns the duration in seconds of the active sequence.
sequenceDuration(sequenceName: String) Float = externalSource() SequenceDuration Returns the duration in seconds of the given sequence name.
setPoseParameter(name: String, value: Float,) Float = externalSource() SetPoseParameter Set the specified pose parameter to the specified value.

CBaseAnimatingOverlay

Native name: CBaseAnimatingOverlay

Extends: CBaseAnimatingActivity


CBaseAnimGraph

Native name: CBaseAnimGraph

Extends: CBaseModelEntity


CBaseCombatCharacter

Native name: CBaseCombatCharacter

Extends: CBaseAnimatingOverlay


CBaseEntity

Native name: CBaseEntity

Extends: CEntityInstance

Properties

Property Type Native Name Description
absOrigin var Vector GetAbsOrigin / SetAbsOrigin
absScale var Float GetAbsScale / SetAbsScale
angles val QAngle GetAngles
anglesAsVector val Vector GetAnglesAsVector Get entity pitch, yaw, roll as a vector.
angularVelocity val Vector GetAngularVelocity Get the local angular velocity - returns a vector of pitch,yaw,roll.
baseVelocity val Vector GetBaseVelocity Get Base? velocity.
boundingMaxs val Vector GetBoundingMaxs Get a vector containing max bounds, centered on object.
boundingMins val Vector GetBoundingMins Get a vector containing min bounds, centered on object.
bounds val EntityBounds GetBounds Get a table containing the 'Mins' & 'Maxs' vector bounds, centered on object.
center val Vector GetCenter Get vector to center of object - absolute coords.
children val List<CBaseEntity> GetChildren Get the entities parented to this entity.
forwardVector var Vector GetForwardVector / SetForwardVector Get the forward vector of the entity.
health var Int GetHealth / SetHealth Get the health of this entity.
leftVector val Vector GetLeftVector Get the left vector of the entity.
localAngles val QAngle GetLocalAngles Get entity local pitch, yaw, roll as a QAngle.
localAngularVelocity val QAngle GetLocalAngularVelocity Maybe local angvel.
localOrigin var Vector GetLocalOrigin / SetLocalOrigin Get entity local origin as a Vector.
localScale var Float GetLocalScale / SetLocalScale
localVelocity val Vector GetLocalVelocity Get Entity relative velocity.
mass var Float GetMass / SetMass Get the mass of an entity. (returns 0 if it doesn't have a physics object).
maxHealth var Int GetMaxHealth / SetMaxHealth Get the maximum health of this entity.
modelName val String GetModelName Returns the name of the model.
moveParent val CBaseEntity GetMoveParent If in hierarchy, retrieves the entity's parent.
origin var Vector GetOrigin / SetOrigin Set the unit's origin.
owner var CBaseEntity GetOwner / SetOwner Gets this entity's owner.
ownerEntity val CBaseEntity GetOwnerEntity Get the owner entity, if there is one.
rightVector val Vector GetRightVector Get the right vector of the entity. WARNING: This produces a left-handed coordinate system. Use GetLeftVector instead (which is aligned with the y axis of the entity).
rootMoveParent val CBaseEntity GetRootMoveParent If in hierarchy, walks up the hierarchy to find the root parent.
spawnGroupHandle val SpawnGroupHandle GetSpawnGroupHandle Returns the spawn group handle of this entity.
team var DOTATeam GetTeam / SetTeam Get the team number of this entity.
teamNumber val DOTATeam GetTeamNumber Get the team number of this entity.
upVector val Vector GetUpVector Get the up vector of the entity.
velocity var Vector GetVelocity / SetVelocity
isAlive val Boolean IsAlive Is this entity alive?
isBaseNPC val Boolean IsBaseNPC Is this entity an CDOTA_BaseNPC?
isDOTANPC val Boolean IsDOTANPC Is this entity a Dota NPC?
isNPC val Boolean IsNPC Is this entity an CAI_BaseNPC?
isPlayer val Boolean IsPlayer Back compat: Is this entity a player pawn or controller?
isPlayerController val Boolean IsPlayerController Is this entity a player controller?
isPlayerPawn val Boolean IsPlayerPawn Is this entity a player pawn?

Methods

Method Return Type Native Name Description
attributeGetFloatValue(name: String, default: Float,) Float = externalSource() Attribute_GetFloatValue Get float value for an entity attribute.
attributeGetIntValue(name: String, default: Int,) Int = externalSource() Attribute_GetIntValue Get int value for an entity attribute.
eyeAngles() QAngle = externalSource() EyeAngles Get the qangles that this entity is looking at.
eyePosition() Vector = externalSource() EyePosition Get vector to eye position - absolute coords.
firstMoveChild() CBaseEntity = externalSource() FirstMoveChild
getContext(name: String) String? = externalSource() GetContext Looks up a context and returns it if available. May return string, float, or null (if the context isn't found).
getSoundDuration(soundname: String, actormodel: String,) Float = externalSource() GetSoundDuration Returns float duration of the sound. Takes soundname and optional actormodelname.
hasAttribute(name: String) Boolean = externalSource() HasAttribute See if an entity has a particular attribute.
isInstance(classOrClassName: String) Boolean = externalSource() IsInstance
nextMovePeer() CBaseEntity = externalSource() NextMovePeer
takeDamage(damageInfo: CTakeDamageInfo) Int = externalSource() TakeDamage Apply damage to this entity. Use CreateDamageInfo() to create a damageinfo object.
transformPointEntityToWorld(point: Vector) Vector = externalSource() TransformPointEntityToWorld Returns the input Vector transformed from entity to world space.
transformPointWorldToEntity(point: Vector) Vector = externalSource() TransformPointWorldToEntity Returns the input Vector transformed from world to entity space.

CBaseModelEntity

Native name: CBaseModelEntity

Extends: CBaseEntity

Properties

Property Type Native Name Description
materialGroupHash var UInt GetMaterialGroupHash / SetMaterialGroupHash Get the material group hash of this entity.
materialGroupMask var Uint64 GetMaterialGroupMask / SetMaterialGroupMask Get the mesh group mask of this entity.
modelScale var Float GetModelScale / SetModelScale Get scale of entity's model.
renderAlpha var Int GetRenderAlpha / SetRenderAlpha Get the alpha modulation of this entity.
renderColor val Vector GetRenderColor Get the render color of the entity.

Methods

Method Return Type Native Name Description
getAttachmentAngles(attachment: Int) Vector = externalSource() GetAttachmentAngles Get the attachment id's angles as a p,y,r vector.
getAttachmentForward(attachment: Int) Vector = externalSource() GetAttachmentForward Get the attachment id's forward vector.
getAttachmentOrigin(attachment: Int) Vector = externalSource() GetAttachmentOrigin Get the attachment id's origin vector.
scriptLookupAttachment(attachmentName: String) Int = externalSource() ScriptLookupAttachment Get the named attachment id.

CBasePlayerController

Native name: CBasePlayerController

Extends: CBaseEntity

Properties

Property Type Native Name Description
pawn val Any GetPawn Returns the pawn for this controller.

CBasePlayerPawn

Native name: CBasePlayerPawn

Extends: CBaseCombatCharacter

Properties

Property Type Native Name Description
controller val Any GetController Returns the controller for this pawn.
equippedWeapons val Any GetEquippedWeapons Returns an array of all the equipped weapons.
weaponCount val Int GetWeaponCount Gets the number of weapons currently equipped.
isNoclipping val Boolean IsNoclipping Returns true if the player is in noclip mode.

CBaseTrigger

Native name: CBaseTrigger

Extends: CBaseEntity

Methods

Method Return Type Native Name Description
isTouching(ent: CBaseEntity) Boolean = externalSource() IsTouching Checks whether the passed entity is touching the trigger.

CBodyComponent

Native name: CBodyComponent

Properties

Property Type Native Name Description
isAttachedToParent val Boolean IsAttachedToParent Is attached to parent.

CCustomGameEventManager

Native name: CCustomGameEventManager


CCustomNetTableManager

Native name: CCustomNetTableManager

Methods

Method Return Type Native Name Description
getTableValue(tableName: String, keyName: String,) Any = externalSource() GetTableValue
setTableValue(tableName: String, keyName: String, value: Any,) Boolean = externalSource() SetTableValue

CDebugOverlayScriptHelper

Native name: CDebugOverlayScriptHelper


AbilityAghanimSpear

Native name: CDOTA_Ability_Aghanim_Spear

Extends: BaseAbility


AbilityAnimationAttack

Native name: CDOTA_Ability_Animation_Attack

Extends: BaseAbility


AbilityAnimationTailSpin

Native name: CDOTA_Ability_Animation_TailSpin

Extends: BaseAbility


AbilityDataDriven

Native name: CDOTA_Ability_DataDriven

Extends: BaseAbility

Methods

Method Return Type Native Name Description
applyDataDrivenModifier(caster: BaseNPC, target: BaseNPC, modifierName: String, modifierTable: Any?,) Buff = externalSource() ApplyDataDrivenModifier Applies a data driven modifier to the target.
applyDataDrivenThinker(caster: BaseNPC, location: Vector, modifierName: String, modifierTable: Any?,) Buff = externalSource() ApplyDataDrivenThinker Applies a data driven thinker at the location.

AbilityLua

Native name: CDOTA_Ability_Lua

Extends: BaseAbility

Properties

Property Type Native Name Description
abilityTextureName val String GetAbilityTextureName Allows code overriding of the ability texture shown in the HUD.
castAnimation val GameActivity GetCastAnimation Return casting animation of this ability.
channelAnimation val GameActivity GetChannelAnimation Return channel animation of this ability.
customCastError val String GetCustomCastError Return the error string of a failed command with no target.
isHiddenAbilityCastable val Boolean IsHiddenAbilityCastable Returns true if this ability can be used when not on the action panel.

Methods

Method Return Type Native Name Description
castFilterResult() UnitFilterResult = externalSource() CastFilterResult Determine whether an issued command with no target is valid.
castFilterResultLocation(location: Vector) UnitFilterResult = externalSource() CastFilterResultLocation Determine whether an issued command on a location is valid.
castFilterResultTarget(target: BaseNPC) UnitFilterResult = externalSource() CastFilterResultTarget Determine whether an issued command on a target is valid.
getCastRangeBonus(target: Any, pseudoCastRange: Int,) Int = externalSource() GetCastRangeBonus
getCustomCastErrorLocation(location: Vector) String = externalSource() GetCustomCastErrorLocation Return the error string of a failed command on a location.
getCustomCastErrorTarget(target: BaseNPC) String = externalSource() GetCustomCastErrorTarget Return the error string of a failed command on a target.
getCustomHudErrorMessage(reason: Int) String = externalSource() GetCustomHudErrorMessage (DOTA_INVALID_ORDERS nReason) Return the error string of a failed order.
isCosmetic(entity: Any) Boolean = externalSource() IsCosmetic Is this a cosmetic only ability?
onProjectileHit(target: BaseNPC?, location: Vector,) Boolean? = externalSource() OnProjectileHit Projectile has collided with a given target or reached its destination. If 'true` is returned, projectile would be destroyed.
onProjectileHitExtraData(target: BaseNPC?, location: Vector, extraData: Any,) Boolean? = externalSource() OnProjectileHit_ExtraData Projectile has collided with a given target or reached its destination. If 'true` is returned, projectile would be destroyed.
onProjectileHitHandle(target: BaseNPC?, location: Vector, projectileHandle: ProjectileID,) Boolean? = externalSource() OnProjectileHitHandle Projectile has collided with a given target or reached its destination. If 'true` is returned, projectile would be destroyed.
otherAbilitiesAlwaysInterruptChanneling() Boolean = externalSource() OtherAbilitiesAlwaysInterruptChanneling

AbilityNianDive

Native name: CDOTA_Ability_Nian_Dive

Extends: BaseAbility


AbilityNianLeap

Native name: CDOTA_Ability_Nian_Leap

Extends: BaseAbility


AbilityNianRoar

Native name: CDOTA_Ability_Nian_Roar

Extends: BaseAbility

Properties

Property Type Native Name Description
castCount val Int GetCastCount Number of times Nian has used the roar.

BaseNPC

Native name: CDOTA_BaseNPC

Extends: CBaseAnimatingOverlay

Properties

Property Type Native Name Description
canBeSeenByAnyOpposingTeam val Boolean CanBeSeenByAnyOpposingTeam
canSellItems var Boolean CanSellItems / SetCanSellItems Query if this unit can sell items.
abilityCount val Int GetAbilityCount
acquisitionRange var Float GetAcquisitionRange / SetAcquisitionRange Gets the range at which this unit will auto-acquire.
additionalBattleMusicWeight var Float GetAdditionalBattleMusicWeight / SetAdditionalBattleMusicWeight Combat involving this creature will have this weight added to the music calcuations.
aggroTarget var BaseNPC? GetAggroTarget / SetAggroTarget Returns this unit's aggro target.
attackAnimationPoint val Float GetAttackAnimationPoint
attackCapability var DOTAUnitAttackCapability GetAttackCapability / SetAttackCapability
attackDamage val Int GetAttackDamage Returns a random integer between the minimum and maximum base damage of the unit.
attackRangeBuffer val Float GetAttackRangeBuffer Gets the attack range buffer.
attackTarget val BaseNPC? GetAttackTarget
baseAttackRange val Int GetBaseAttackRange
baseAttackTime var Float GetBaseAttackTime / SetBaseAttackTime
baseDamageMax var Int GetBaseDamageMax / SetBaseDamageMax Get the maximum attack damage of this unit.
baseDamageMin var Int GetBaseDamageMin / SetBaseDamageMin Get the minimum attack damage of this unit.
baseDayTimeVisionRange val Int GetBaseDayTimeVisionRange Returns the vision range before modifiers.
baseHealthBarOffset val Int GetBaseHealthBarOffset
baseHealthRegen var Float GetBaseHealthRegen / SetBaseHealthRegen
baseMagicalResistanceValue var Float GetBaseMagicalResistanceValue / SetBaseMagicalResistanceValue Returns base magical armor value.
baseMaxHealth var Float GetBaseMaxHealth / SetBaseMaxHealth Gets the base max health value.
baseMoveSpeed var Float GetBaseMoveSpeed / SetBaseMoveSpeed
baseNightTimeVisionRange val Int GetBaseNightTimeVisionRange Returns the vision range after modifiers.
bonusManaRegen val Float GetBonusManaRegen This Mana regen is derived from constant bonuses like Basilius.
castRangeBonus val Float GetCastRangeBonus
cloneSource val BaseNPC? GetCloneSource Get clone source (Meepo Prime, if this is a Meepo).
collisionPadding val Float GetCollisionPadding Returns the size of the collision padding around the hull.
cooldownReduction val Float GetCooldownReduction
creationTime val Float GetCreationTime
currentActiveAbility val BaseAbility? GetCurrentActiveAbility Get the ability this unit is currently casting.
currentVisionRange val Int GetCurrentVisionRange Gets the current vision range.
cursorCastTarget var BaseNPC? GetCursorCastTarget / SetCursorCastTarget
cursorPosition var Vector GetCursorPosition / SetCursorPosition
cursorTargetingNothing var Boolean GetCursorTargetingNothing / SetCursorTargetingNothing
damageMax val Int GetDamageMax Get the maximum attack damage of this unit.
damageMin val Int GetDamageMin Get the minimum attack damage of this unit.
dayTimeVisionRange var Int GetDayTimeVisionRange / SetDayTimeVisionRange Returns the vision range after modifiers.
deathXP var Int GetDeathXP / SetDeathXP Get the XP bounty on this unit.
displayAttackSpeed val Float GetDisplayAttackSpeed Attack speed expressed as constant value.
evasion val Float GetEvasion
forceAttackTarget var BaseNPC? GetForceAttackTarget / SetForceAttackTarget
goldBounty val Int GetGoldBounty Get the gold bounty on this unit.
hasteFactor val Float GetHasteFactor
healthDeficit val Int GetHealthDeficit Returns integer amount of health missing from max.
healthPercent val Int GetHealthPercent Get the current health percent of the unit.
healthRegen val Float GetHealthRegen
hullRadius var Float GetHullRadius / SetHullRadius Get the collision hull radius of this NPC.
idealSpeed val Float GetIdealSpeed Returns speed after all modifiers.
idealSpeedNoSlows val Float GetIdealSpeedNoSlows Returns speed after all modifiers, but excluding those that reduce speed.
initialGoalEntity var CBaseEntity? GetInitialGoalEntity / SetInitialGoalEntity Returns the initial waypoint goal for this NPC.
initialGoalPosition var Vector GetInitialGoalPosition / SetInitialGoalPosition Get waypoint position for this NPC.
lastAttackTime val Float GetLastAttackTime
lastDamageTime val Float GetLastDamageTime Get the last time this NPC took damage.
lastIdleChangeTime val Float GetLastIdleChangeTime Get the last game time that this unit switched to/from idle state.
level val Int GetLevel Returns the level of this unit.
mainControllingPlayer val Int GetMainControllingPlayer Returns the player ID of the controlling player.
mana var Float GetMana / SetMana Get the mana on this unit.
manaPercent val Int GetManaPercent Get the percent of mana remaining.
manaRegen val Float GetManaRegen
maximumGoldBounty var Int GetMaximumGoldBounty / SetMaximumGoldBounty Get the maximum gold bounty for this unit.
maxMana var Float GetMaxMana / SetMaxMana Get the maximum mana of this unit.
minimumGoldBounty var Int GetMinimumGoldBounty / SetMinimumGoldBounty Get the minimum gold bounty for this unit.
modelRadius val Float GetModelRadius
modifierCount val Int GetModifierCount How many modifiers does this unit have?
mustReachEachGoalEntity var Boolean GetMustReachEachGoalEntity / SetMustReachEachGoalEntity Set whether this NPC is required to reach each goal entity, rather than being allowed to unkink their path.
neutralSpawnerName val String GetNeutralSpawnerName Get the name of this camp's neutral spawner.
neverMoveToClearSpace var Boolean GetNeverMoveToClearSpace / SetNeverMoveToClearSpace If set to true, we will never attempt to move this unit to clear space, even when it unphases.
nightTimeVisionRange var Int GetNightTimeVisionRange / SetNightTimeVisionRange Returns the vision range after modifiers.
opposingTeamNumber val DOTATeam GetOpposingTeamNumber
paddedCollisionRadius val Float GetPaddedCollisionRadius Get the collision hull radius (including padding) of this NPC.
physicalArmorBaseValue var Float GetPhysicalArmorBaseValue / SetPhysicalArmorBaseValue Returns base physical armor value.
playerOwner val PlayerController GetPlayerOwner Returns the player that owns this unit.
playerOwnerID val PlayerID GetPlayerOwnerID Get the owner player ID for this unit.
projectileSpeed val Int GetProjectileSpeed
rangedProjectileName var String GetRangedProjectileName / SetRangedProjectileName
remainingPathLength val Float GetRemainingPathLength
statusResistance val Float GetStatusResistance
totalPurchasedUpgradeGoldCost val Int GetTotalPurchasedUpgradeGoldCost Get how much gold has been spent on ability upgrades.
unitLabel val String GetUnitLabel
unitLocToken val String GetUnitLocToken Get the localization token for this unit's name.
unitName var String GetUnitName / SetUnitName Get the name of this unit.
hasAnyActiveAbilities val Boolean HasAnyActiveAbilities
hasAttackCapability val Boolean HasAttackCapability
hasFlyingVision val Boolean HasFlyingVision
hasFlyMovementCapability val Boolean HasFlyMovementCapability
hasGroundMovementCapability val Boolean HasGroundMovementCapability
hasInventory var Boolean HasInventory / SetHasInventory Does this unit have an inventory.
hasMovementCapability val Boolean HasMovementCapability
hasScepter val Boolean HasScepter
isAncient val Boolean IsAncient Is this unit an Ancient?
isAttackImmune val Boolean IsAttackImmune
isAttacking var Boolean IsAttacking / SetAttacking
isBarracks val Boolean IsBarracks Is this unit a Barracks?
isBlind val Boolean IsBlind
isBlockDisabled val Boolean IsBlockDisabled
isBoss val Boolean IsBoss Is this unit a boss?
isBossCreature val Boolean IsBossCreature Is this unit a Boss Creature? (used by custom games).
isBuilding val Boolean IsBuilding Is this unit a building?
isChanneling val Boolean IsChanneling Is this unit currently channeling a spell?
isClone val Boolean IsClone Is this unit a clone? (Meepo).
isCommandRestricted val Boolean IsCommandRestricted
isConsideredHero val Boolean IsConsideredHero Is this unit a considered a hero for targeting purposes?
isControllableByAnyPlayer val Boolean IsControllableByAnyPlayer Is this unit controlled by any non-bot player?
isCourier val Boolean IsCourier Is this unit a courier?
isCreature val Boolean IsCreature Is this a Creature type NPC?
isCreep val Boolean IsCreep Is this unit a creep?
isCreepHero val Boolean IsCreepHero Is this unit a creep hero?
isCurrentlyHorizontalMotionControlled val Boolean IsCurrentlyHorizontalMotionControlled
isCurrentlyVerticalMotionControlled val Boolean IsCurrentlyVerticalMotionControlled
isDebuffImmune val Boolean IsDebuffImmune
isDisarmed val Boolean IsDisarmed
isDominated val Boolean IsDominated
isEvadeDisabled val Boolean IsEvadeDisabled
isFeared val Boolean IsFeared
isFort val Boolean IsFort Is this unit an Ancient?
isFrozen val Boolean IsFrozen
isHero val Boolean IsHero Is this a hero or hero illusion?
isHeroWard val Boolean IsHeroWard Is this a Hero Ward?
isHexed val Boolean IsHexed
isIdle val Boolean IsIdle Is this creature currently idle?
isIllusion val Boolean IsIllusion
isInventoryEnabled val Boolean IsInventoryEnabled Does this unit have an inventory.
isInvisible val Boolean IsInvisible
isInvulnerable val Boolean IsInvulnerable
isLowAttackPriority val Boolean IsLowAttackPriority
isMagicImmune val Boolean IsMagicImmune
isMovementImpaired val Boolean IsMovementImpaired
isMoving val Boolean IsMoving Is this unit moving?
isMuted val Boolean IsMuted
isNeutralUnitType val Boolean IsNeutralUnitType Is this a neutral?
isNightmared val Boolean IsNightmared
isOther val Boolean IsOther Is this unit a ward-type unit?
isOutOfGame val Boolean IsOutOfGame
isOwnedByAnyPlayer val Boolean IsOwnedByAnyPlayer Is this unit owned by any non-bot player?
isPhantom val Boolean IsPhantom Is this a phantom unit?
isPhantomBlocker val Boolean IsPhantomBlocker
isPhased val Boolean IsPhased
isRangedAttacker val Boolean IsRangedAttacker Is this unit a ranged attacker?
isRealHero val Boolean IsRealHero Is this a real hero?
isReincarnating val Boolean IsReincarnating Is this creature respawning?
isRooted val Boolean IsRooted
isShrine val Boolean IsShrine Is this a shrine?
isSilenced val Boolean IsSilenced
isSpeciallyDeniable val Boolean IsSpeciallyDeniable
isSpeciallyUndeniable val Boolean IsSpeciallyUndeniable
isStrongIllusion val Boolean IsStrongIllusion
isStunned val Boolean IsStunned
isSummoned val Boolean IsSummoned Is this unit summoned?
isTaunted val Boolean IsTaunted
isTempestDouble val Boolean IsTempestDouble
isTower val Boolean IsTower Is this a tower?
isUnableToMiss val Boolean IsUnableToMiss
isUnselectable val Boolean IsUnselectable
isUntargetable val Boolean IsUntargetable
isWard val Boolean IsWard Is this a Ward?
isZombie val Boolean IsZombie Is this entity an Undying Zombie?
noHealthBar val Boolean NoHealthBar
noTeamMoveTo val Boolean NoTeamMoveTo
noTeamSelect val Boolean NoTeamSelect
noUnitCollision val Boolean NoUnitCollision
shouldIdleAcquire var Boolean ShouldIdleAcquire / SetIdleAcquire

Methods

Method Return Type Native Name Description
addAbility(abilityName: String) BaseAbility = externalSource() AddAbility Add an ability to this unit by name.
addItem(item: Item) Item = externalSource() AddItem Add an item to this unit's inventory.
addItemByName(itemName: String) Item = externalSource() AddItemByName Add an item to this unit's inventory.
addNewModifier(caster: BaseNPC?, ability: BaseAbility?, modifierName: String, modifierTable: Any?,) Buff = externalSource() AddNewModifier Add a modifier to this unit.
attackReady() Boolean = externalSource() AttackReady
boundingRadius2D() Float = externalSource() BoundingRadius2D
canEntityBeSeenByMyTeam(entity: BaseNPC) Boolean = externalSource() CanEntityBeSeenByMyTeam Check FoW to see if an entity is visible.
findAbilityByName(abilityName: String) BaseAbility? = externalSource() FindAbilityByName Retrieve an ability by name from the unit.
findAllModifiers() List<Buff> = externalSource() FindAllModifiers Returns a table of all of the modifiers on the NPC.
findAllModifiersByName(modifierName: String) List<Buff> = externalSource() FindAllModifiersByName Returns a table of all of the modifiers on the NPC with the passed name (modifierName).
findItemInInventory(itemName: String) Item? = externalSource() FindItemInInventory Get handle to first item in inventory, else nil.
findModifierByName(modifierName: String) Buff? = externalSource() FindModifierByName Return a handle to the modifier of the given name if found, else nil (string Name ).
findModifierByNameAndCaster(modifierName: String, caster: BaseNPC,) Buff? = externalSource() FindModifierByNameAndCaster Return a handle to the modifier of the given name from the passed caster if found, else nil.
getAbilityByIndex(index: Int) BaseAbility? = externalSource() GetAbilityByIndex Retrieve an ability by index from the unit.
getAttackSpeed(ignoreTempAttackSpeed: Boolean) Float = externalSource() GetAttackSpeed
getAttacksPerSecond(ignoreTempAttackSpeed: Boolean) Float = externalSource() GetAttacksPerSecond
getAverageTrueAttackDamage(target: BaseNPC?) Int = externalSource() GetAverageTrueAttackDamage Returns the average value of the minimum and maximum damage values.
getCastPoint(attack: Boolean) Float = externalSource() GetCastPoint
getIncreasedAttackSpeed(ignoreTempAttackSpeed: Boolean) Float = externalSource() GetIncreasedAttackSpeed Hero attack speed is also affected by agility.
getItemInSlot(slot: Int) Item? = externalSource() GetItemInSlot Returns nth item in inventory slot (index is zero based).
getModifierNameByIndex(index: Int) String = externalSource() GetModifierNameByIndex Get a modifier name by index.
getModifierStackCount(modifierName: String, caster: BaseNPC,) Int = externalSource() GetModifierStackCount Gets the stack count of a given modifier.
getMoveSpeedModifier(baseSpeed: Float, returnUnslowed: Boolean,) Float = externalSource() GetMoveSpeedModifier
getPhysicalArmorValue(ignoreBase: Boolean) Float = externalSource() GetPhysicalArmorValue Returns current physical armor value.
getRangeToUnit(npc: BaseNPC) Float = externalSource() GetRangeToUnit
getSecondsPerAttack(ignoreTempAttackSpeed: Boolean) Float = externalSource() GetSecondsPerAttack
getSpellAmplification(baseOnly: Boolean) Float = externalSource() GetSpellAmplification
hasAbility(abilityName: String) Boolean = externalSource() HasAbility See whether this unit has an ability by name.
hasItemInInventory(itemName: String) Boolean = externalSource() HasItemInInventory See whether this unit has an item by name.
hasModifier(scriptName: String) Boolean = externalSource() HasModifier Sees if this unit has a given modifier.
isAttackingEntity(entity: BaseNPC) Boolean = externalSource() IsAttackingEntity
isInRangeOfShop(shopType: DotaShopType, physical: Boolean,) Boolean = externalSource() IsInRangeOfShop Ask whether this unit is in range of the specified shop.
isOpposingTeam(team: DOTATeam) Boolean = externalSource() IsOpposingTeam
isPositionInRange(position: Vector, range: Float,) Boolean = externalSource() IsPositionInRange
isUntargetableFrom(targettingSource: Any) Boolean = externalSource() IsUntargetableFrom
notOnMinimap() Boolean = externalSource() NotOnMinimap
notOnMinimapForEnemies() Boolean = externalSource() NotOnMinimapForEnemies
passivesDisabled() Boolean = externalSource() PassivesDisabled
providesVision() Boolean = externalSource() ProvidesVision
scriptGetAttackRange() Float = externalSource() Script_GetAttackRange Gets this unit's attack range after all modifiers.
scriptGetMagicalArmorValue(inflictor: Any) Float = externalSource() Script_GetMagicalArmorValue Returns current magical armor value.
scriptIsDeniable() Boolean = externalSource() Script_IsDeniable
scriptReduceMana(mana: Float, ability: Any,) Float = externalSource() Script_ReduceMana Remove mana from this unit, this can be used for involuntary mana loss, not for mana that is spent.
takeItem(item: Item) Item = externalSource() TakeItem Removed the passed item from this unit's inventory. Returns the passed item.
timeUntilNextAttack() Float = externalSource() TimeUntilNextAttack
triggerModifierDodge(ability: Any, buff: Any,) Boolean = externalSource() TriggerModifierDodge
triggerSpellAbsorb(ability: BaseAbility) Boolean = externalSource() TriggerSpellAbsorb
unitCanRespawn() Boolean = externalSource() UnitCanRespawn Can the unit respawn?
wasKilledPassively() Boolean = externalSource() WasKilledPassively

BaseNPCBuilding

Native name: CDOTA_BaseNPC_Building

Extends: BaseNPC

Properties

Property Type Native Name Description
invulnCount var Int GetInvulnCount / SetInvulnCount Get the invulnerability count for a building.

BaseNPCCreature

Native name: CDOTA_BaseNPC_Creature

Extends: BaseNPC

Properties

Property Type Native Name Description
disableResistance var Float GetDisableResistance / SetDisableResistance Set creature's current disable resistance.
ultimateDisableResistance var Float GetUltimateDisableResistance / SetUltimateDisableResistance Set creature's current disable resistance from ultimates.
isChampion var Boolean IsChampion / SetChampion Is this unit a champion?

BaseNPCHero

Native name: CDOTA_BaseNPC_Hero

Extends: BaseNPC

Properties

Property Type Native Name Description
canEarnGold val Boolean CanEarnGold Returns boolean value result of buyback gold limit time less than game time.
abilityPoints var Int GetAbilityPoints / SetAbilityPoints Gets the current unspent ability points.
additionalOwnedUnits val List<BaseNPC> GetAdditionalOwnedUnits
agility val Float GetAgility
agilityGain val Float GetAgilityGain
assists val Int GetAssists Value is stored in PlayerResource.
baseAgility var Float GetBaseAgility / SetBaseAgility
baseIntellect var Float GetBaseIntellect / SetBaseIntellect
baseManaRegen val Float GetBaseManaRegen Returns the base mana regen.
baseStrength var Float GetBaseStrength / SetBaseStrength
bonusDamageFromPrimaryStat val Int GetBonusDamageFromPrimaryStat
buybackCooldownTime var Float GetBuybackCooldownTime / SetBuybackCooldownTime Return float value for the amount of time left on cooldown for this hero's buyback.
buybackCost val Int GetBuybackCost Return integer value for the gold cost of a buyback.
buybackGoldLimitTime var Float GetBuybackGoldLimitTime / SetBuybackGoldLimitTime Returns the amount of time gold gain is limited after buying back.
currentXP val Int GetCurrentXP Returns the amount of XP.
deathGoldCost val Int GetDeathGoldCost
deaths val Int GetDeaths Value is stored in PlayerResource.
denies val Int GetDenies Value is stored in PlayerResource.
gold val Int GetGold Returns gold amount for the player owning this hero.
heroFacetID val UInt GetHeroFacetID
heroID val Int GetHeroID
intellectGain val Float GetIntellectGain
kills val Int GetKills Value is stored in PlayerResource.
lastHits val Int GetLastHits Value is stored in PlayerResource.
mostRecentDamageTime val Float GetMostRecentDamageTime
multipleKillCount val Int GetMultipleKillCount
numAttackers val Int GetNumAttackers
numItemsInInventory val Int GetNumItemsInInventory
numItemsInStash val Int GetNumItemsInStash
playerID var PlayerID GetPlayerID / SetPlayerID Returns player ID of the player owning this hero.
primaryAttribute var Attributes GetPrimaryAttribute / SetPrimaryAttribute Set this hero's primary attribute value.
primaryStatValue val Float GetPrimaryStatValue
replicatingOtherHero val BaseNPCHero? GetReplicatingOtherHero If hero is under Replicate effect, returns original hero entity.
respawnsDisabled var Boolean GetRespawnsDisabled / SetRespawnsDisabled Is this hero prevented from respawning?
respawnTime val Float GetRespawnTime
streak val Int GetStreak Value is stored in PlayerResource.
strength val Float GetStrength
strengthGain val Float GetStrengthGain
timeUntilRespawn var Float GetTimeUntilRespawn / SetTimeUntilRespawn
hasAnyAvailableInventorySpace val Boolean HasAnyAvailableInventorySpace
hasOwnerAbandoned val Boolean HasOwnerAbandoned
isBuybackDisabledByDevilsBargain val Boolean IsBuybackDisabledByDevilsBargain
isStashEnabled var Boolean IsStashEnabled / SetStashEnabled
shouldDoFlyHeightVisual val Boolean ShouldDoFlyHeightVisual
willReincarnate val Boolean WillReincarnate

Methods

Method Return Type Native Name Description
addExperience(xp: Float, reason: ModifyXPReason, applyBotDifficultyScaling: Boolean, incrementTotal: Boolean, cloneCount: Int,) Boolean = externalSource() AddExperience
getAttacker(index: Int) Int = externalSource() GetAttacker
getIntellect(skipNoConsume: Boolean) Float = externalSource() GetIntellect
getTogglableWearable(slotType: DOTASlotType) CBaseAnimatingActivity? = externalSource() GetTogglableWearable Get wearable entity in slot (slot).
hasRoomForItem(itemName: String, includeStashCombines: Boolean, allowSelling: Boolean,) Int = externalSource() HasRoomForItem
modifyGold(goldChange: Int, reliable: Boolean, reason: ModifyGoldReason,) Int = externalSource() ModifyGold Gives this hero some gold.
modifyGoldFiltered(goldChange: Int, reliable: Boolean, reason: ModifyGoldReason,) Int = externalSource() ModifyGoldFiltered Gives this hero some gold, using the gold filter if extra filtering is on.

BaseNPCLotusPool

Native name: CDOTA_BaseNPC_LotusPool

Extends: BaseNPCBuilding


BaseNPCNeutralItemStash

Native name: CDOTA_BaseNPC_NeutralItemStash

Extends: BaseNPCBuilding


BaseNPCShop

Native name: CDOTA_BaseNPC_Shop

Extends: BaseNPCBuilding

Properties

Property Type Native Name Description
shopType var DotaShopType GetShopType / SetShopType Get the DOTA_SHOP_TYPE.

BaseNPCTrapWard

Native name: CDOTA_BaseNPC_Trap_Ward

Extends: BaseNPCCreature

Properties

Property Type Native Name Description
trapTarget val Vector GetTrapTarget Get the trap target for this entity.

BaseNPCWatchTower

Native name: CDOTA_BaseNPC_Watch_Tower

Extends: BaseNPCBuilding

Properties

Property Type Native Name Description
interactAbilityName var String GetInteractAbilityName / SetInteractAbilityName The name of the ability used when triggering interaction on the outpost.

Buff

Native name: CDOTA_Buff

Properties

Property Type Native Name Description
ability val BaseAbility? GetAbility Get the ability that generated the modifier.
auraDuration val Float GetAuraDuration Returns aura stickiness (default 0.5).
auraOwner val BaseNPC? GetAuraOwner Returns the owner of the aura modifier, that applied this modifier. Always nil on the client.
caster val BaseNPC? GetCaster Get the owner of the ability responsible for the modifier.
creationTime val Float GetCreationTime
dieTime val Float GetDieTime
duration val Float GetDuration
elapsedTime val Float GetElapsedTime
lastAppliedTime val Float GetLastAppliedTime
name val String GetName
parent val BaseNPC GetParent Get the unit the modifier is parented to.
remainingTime val Float GetRemainingTime
serialNumber val Int GetSerialNumber
stackCount var Int GetStackCount / SetStackCount
isDebuff val Boolean IsDebuff True/false if this modifier should be displayed as a debuff.
isHexDebuff val Boolean IsHexDebuff
isNull val Boolean IsNull Has underlying C++ entity object been deleted?
isStunDebuff val Boolean IsStunDebuff True/false if this modifier is considered a stun for purge reasons.

Methods

Method Return Type Native Name Description
destroyOnExpire() Boolean = externalSource() DestroyOnExpire True/false if this buff is removed when the duration expires.
hasFunction(function: Modifierfunction) Boolean = externalSource() HasFunction
setOverheadEffectOffset(offset: Float) Boolean = externalSource() SetOverheadEffectOffset

CustomUIManager

Native name: CDOTA_CustomUIManager


Item

Native name: CDOTA_Item

Extends: BaseAbility

Properties

Property Type Native Name Description
canBeUsedOutOfInventory var Boolean CanBeUsedOutOfInventory / SetCanBeUsedOutOfInventory
canOnlyPlayerHeroPickup var Boolean CanOnlyPlayerHeroPickup / SetOnlyPlayerHeroPickup
container val ItemPhysical? GetContainer Get the container for this item.
cost val Int GetCost
currentCharges var Int GetCurrentCharges / SetCurrentCharges Get the number of charges this item currently has.
initialCharges val Int GetInitialCharges Get the initial number of charges this item has.
itemSlot val Int GetItemSlot
itemState var Int GetItemState / SetItemState Gets whether item is unequipped or ready.
parent val Any GetParent Get the parent for this item.
purchaser var BaseNPC? GetPurchaser / SetPurchaser Get the purchaser for this item.
purchaseTime var Float GetPurchaseTime / SetPurchaseTime Get the purchase time of this item.
secondaryCharges var Int GetSecondaryCharges / SetSecondaryCharges Get the number of secondary charges this item currently has.
shareability var EShareAbility GetShareability / SetShareability
valuelessCharges val Int GetValuelessCharges Get the number of valueless charges this item currently has.
isActiveNeutral val Boolean IsActiveNeutral
isAlertableItem val Boolean IsAlertableItem
isCastOnPickup var Boolean IsCastOnPickup / SetCastOnPickup
isCombinable val Boolean IsCombinable
isCombineLocked var Boolean IsCombineLocked / SetCombineLocked
isDisassemblable val Boolean IsDisassemblable
isDroppable var Boolean IsDroppable / SetDroppable
isInBackpack val Boolean IsInBackpack
isKillable val Boolean IsKillable
isMuted val Boolean IsMuted Returns whether this item is muted or not.
isPermanent val Boolean IsPermanent Is this a permanent item?
isPurchasable val Boolean IsPurchasable
isRecipe val Boolean IsRecipe
isRecipeGenerated val Boolean IsRecipeGenerated
isSellable var Boolean IsSellable / SetSellable
isStackable val Boolean IsStackable

Methods

Method Return Type Native Name Description
requiresCharges() Boolean = externalSource() RequiresCharges
stacksWithOtherOwners() Boolean = externalSource() StacksWithOtherOwners

ItemBagOfGold

Native name: CDOTA_Item_BagOfGold

Extends: Item


ItemDataDriven

Native name: CDOTA_Item_DataDriven

Extends: Item

Methods

Method Return Type Native Name Description
applyDataDrivenThinker(caster: BaseNPC, location: Vector, modifierName: String, modifierTable: Any?,) Buff = externalSource() ApplyDataDrivenThinker Applies a data driven thinker at the location.

ItemEmptyBottle

Native name: CDOTA_Item_EmptyBottle

Extends: Item

Methods

Method Return Type Native Name Description
onRune(runeType: Int) Boolean = externalSource() OnRune Place a rune in the bottle.

ItemLua

Native name: CDOTA_Item_Lua

Extends: Item

Properties

Property Type Native Name Description
abilityTextureName val String GetAbilityTextureName Allows code overriding of the item texture shown in the HUD.
customCastError val String GetCustomCastError Return the error string of a failed command with no target.
isHiddenAbilityCastable val Boolean IsHiddenAbilityCastable Returns true if this ability can be used when not on the action panel.

Methods

Method Return Type Native Name Description
canUnitPickUp(unit: BaseNPC) Boolean = externalSource() CanUnitPickUp Returns true if this item can be picked up by the target unit.
castFilterResult() UnitFilterResult = externalSource() CastFilterResult Determine whether an issued command with no target is valid.
castFilterResultLocation(location: Vector) UnitFilterResult = externalSource() CastFilterResultLocation Determine whether an issued command on a location is valid.
castFilterResultTarget(target: BaseNPC) UnitFilterResult = externalSource() CastFilterResultTarget Determine whether an issued command on a target is valid.
getCustomCastErrorLocation(location: Vector) String = externalSource() GetCustomCastErrorLocation Return the error string of a failed command on a location.
getCustomCastErrorTarget(target: BaseNPC) String = externalSource() GetCustomCastErrorTarget Return the error string of a failed command on a target.
getCustomHudErrorMessage(reason: Int) String = externalSource() GetCustomHudErrorMessage (DOTA_INVALID_ORDERS nReason) Return the error string of a failed order.
onProjectileHit(target: BaseNPC?, location: Vector,) Boolean? = externalSource() OnProjectileHit Projectile has collided with a given target or reached its destination. If 'true` is returned, projectile would be destroyed.

ItemPhysical

Native name: CDOTA_Item_Physical

Extends: CBaseAnimatingActivity

Properties

Property Type Native Name Description
containedItem var Item GetContainedItem / SetContainedItem Returned the contained item.
creationTime val Float GetCreationTime Returns the game time when this item was created in the world.
isLoot var Boolean IsLoot / SetIsLoot Is this drop flagged as a loot drop?

ItemSpawner

Native name: CDOTA_ItemSpawner

Extends: CBaseEntity

Properties

Property Type Native Name Description
itemName val String GetItemName Returns the item name.

MapTree

Native name: CDOTA_MapTree

Extends: CBaseEntity

Properties

Property Type Native Name Description
isStanding val Boolean IsStanding Returns true if the tree is standing, false if it has been cut down.

ModifierLua

Native name: CDOTA_Modifier_Lua

Extends: Buff

Properties

Property Type Native Name Description
canParentBeAutoAttacked val Boolean CanParentBeAutoAttacked
attributes val DOTAModifierAttribute GetAttributes Return the types of attributes applied to this modifier.
auraRadius val Float GetAuraRadius Return the range around the parent this aura tries to apply its buff.
auraSearchFlags val DotaUnitTargetFlags GetAuraSearchFlags Return the unit flags this aura respects when placing buffs.
auraSearchTeam val DotaUnitTargetTeam GetAuraSearchTeam Return the teams this aura applies its buff to.
auraSearchType val DotaUnitTargetType GetAuraSearchType Return the unit classifications this aura applies its buff to.
critDamage val Float GetCritDamage A Modifier that listens to MODIFIER_PROPERTY_PREATTACK_CRITICALSTRIKE has to have a GetCritDamage implementation so we can know when to evaluate it. Value should be in 'times the original value format' e.g: 1.5 not 150.
effectAttachType val ParticleAttachment GetEffectAttachType Return the attach type of the particle system from GetEffectName.
effectName val String GetEffectName Return the name of the particle system that is created while this modifier is active.
heroEffectName val String GetHeroEffectName Return the name of the hero effect particle system that is created while this modifier is active.
modifierAura val String GetModifierAura The name of the secondary modifier that will be applied by this modifier (if it is an aura).
priority val Modifierpriority GetPriority Return the priority order this modifier will be applied over others.
statusEffectName val String GetStatusEffectName Return the name of the status effect particle system that is created while this modifier is active.
texture val String GetTexture Return the name of the buff icon to be shown for this modifier.
isAura val Boolean IsAura True/false if this modifier is an aura.
isAuraActiveOnDeath val Boolean IsAuraActiveOnDeath True/false if this aura provides buffs when the parent is dead.
isHidden val Boolean IsHidden True/false if this modifier should be displayed on the buff bar.
isPermanent val Boolean IsPermanent
isPurgable val Boolean IsPurgable True/false if this modifier can be purged.
isPurgeException val Boolean IsPurgeException True/false if this modifier can be purged by strong dispels.
shouldUseOverheadOffset val Boolean ShouldUseOverheadOffset Apply the overhead offset to the attached effect.
activityTranslationModifiers val String GetActivityTranslationModifiers
allowEtherealAttack val Unit GetAllowEtherealAttack
alwaysAllowAttack val Int GetAlwaysAllowAttack
alwaysAutoAttackWhileHoldPosition val Unit GetAlwaysAutoAttackWhileHoldPosition
attackSound val String GetAttackSound
baseAttackPostBonus val Unit GetBaseAttackPostBonus
bonusDayVision val Float GetBonusDayVision
bonusDayVisionPercentage val Unit GetBonusDayVisionPercentage
bonusNightVision val Float GetBonusNightVision
bonusNightVisionUnique val Float GetBonusNightVisionUnique
bonusVisionPercentage val Float GetBonusVisionPercentage
buffAmplification val Unit GetBuffAmplification
convertAttackPhysicalToPure val Unit GetConvertAttackPhysicalToPure
criticalStrikeBonus val Unit GetCriticalStrikeBonus
disableAutoAttack val Int GetDisableAutoAttack
disableHealing val Int GetDisableHealing
disableManaGain val Unit GetDisableManaGain
fixedDayVision val Float GetFixedDayVision
fixedNightVision val Float GetFixedNightVision
forceDrawOnMinimap val Int GetForceDrawOnMinimap
isIllusion val Int GetIsIllusion
magicalArmorPiercingPercentageTarget val Unit GetMagicalArmorPiercingPercentageTarget
minHealth val Float GetMinHealth
minMana val Unit GetMinMana
modifierAbilityLayout val Float GetModifierAbilityLayout
modifierAbilityPoints val Unit GetModifierAbilityPoints
modifierAdditionalNutralItemDrops val Unit GetModifierAdditionalNutralItemDrops
modifierAoEBonusConstant val Unit GetModifierAoEBonusConstant
modifierAoEBonusConstantStacking val Unit GetModifierAoEBonusConstantStacking
modifierAoEBonusPercentage val Float GetModifierAoEBonusPercentage
modifierAttackHeightBonus val Unit GetModifierAttackHeightBonus
modifierAttackPointConstant val Float GetModifierAttackPointConstant
modifierAttackRangeBonus val Float GetModifierAttackRangeBonus
modifierAttackRangeBonusPercentage val Float GetModifierAttackRangeBonusPercentage
modifierAttackRangeBonusUnique val Float GetModifierAttackRangeBonusUnique
modifierAttackRangeOverride val Float GetModifierAttackRangeOverride
modifierAttackSpeedLimit val Unit GetModifierAttackSpeed_Limit
modifierAttackSpeedAbsoluteMax val Unit GetModifierAttackSpeedAbsoluteMax
modifierAttackSpeedBaseOverride val Float GetModifierAttackSpeedBaseOverride
modifierAttackSpeedBonusConstant val Float GetModifierAttackSpeedBonus_Constant
modifierAttackSpeedPercentage val Float GetModifierAttackSpeedPercentage
modifierAttackSpeedReductionPercentage val Float GetModifierAttackSpeedReductionPercentage
modifierAvoidAttackProcs val Unit GetModifierAvoidAttackProcs
modifierBaseArmorPerAgiBonusPercentage val Unit GetModifierBaseArmorPerAgiBonusPercentage
modifierBaseAttackBonusDamage val Float GetModifierBaseAttack_BonusDamage
modifierBaseAttackSpeedPerAgiBonusPercentage val Unit GetModifierBaseAttackSpeedPerAgiBonusPercentage
modifierBaseAttackTimeConstant val Float GetModifierBaseAttackTimeConstant
modifierBaseAttackTimeConstantAdjust val Float GetModifierBaseAttackTimeConstant_Adjust
modifierBaseAttackTimePercentage val Float GetModifierBaseAttackTimePercentage
modifierBaseHpRegenPerStrBonusPercentage val Unit GetModifierBaseHpRegenPerStrBonusPercentage
modifierBaseMagicResistPerIntBonusPercentage val Unit GetModifierBaseMagicResistPerIntBonusPercentage
modifierBaseManaRegenPerIntBonusPercentage val Unit GetModifierBaseManaRegenPerIntBonusPercentage
modifierBaseRegen val Float GetModifierBaseRegen
modifierBecomeAgility val Unit GetModifierBecomeAgility
modifierBecomeIntelligence val Unit GetModifierBecomeIntelligence
modifierBecomeStrength val Unit GetModifierBecomeStrength
modifierBecomeUniversal val Int GetModifierBecomeUniversal
modifierBonusDamageOutgoingPercentage val Unit GetModifierBonusDamageOutgoing_Percentage
modifierBonusLotusHeal val Unit GetModifierBonusLotusHeal
modifierBonusStatsAgility val Float GetModifierBonusStats_Agility
modifierBonusStatsAgilityPercentage val Float GetModifierBonusStats_Agility_Percentage
modifierBonusStatsIntellect val Float GetModifierBonusStats_Intellect
modifierBonusStatsIntellectPercentage val Float GetModifierBonusStats_Intellect_Percentage
modifierBonusStatsStrength val Float GetModifierBonusStats_Strength
modifierBonusStatsStrengthPercentage val Float GetModifierBonusStats_Strength_Percentage
modifierBonusUphillMissChance val Unit GetModifierBonusUphillMissChance
modifierBuybackPenaltyPercent val Unit GetModifierBuybackPenaltyPercent
modifierCanAttackTrees val Int GetModifierCanAttackTrees
modifierChangeAbilityValue val Unit GetModifierChangeAbilityValue
modifierConstantDeathGoldCost val Float GetModifierConstantDeathGoldCost
modifierConstantHealthRegen val Float GetModifierConstantHealthRegen
modifierConstantManaRegen val Float GetModifierConstantManaRegen
modifierConstantManaRegenUnique val Float GetModifierConstantManaRegenUnique
modifierConstantRespawnTime val Float GetModifierConstantRespawnTime
modifierConvertManaCostToHealthCost val Unit GetModifierConvertManaCostToHealthCost
modifierCreateBonusIllusionChance val Unit GetModifierCreateBonusIllusionChance
modifierCreateBonusIllusionCount val Unit GetModifierCreateBonusIllusionCount
modifierCreepDenyPercent val Unit GetModifierCreepDenyPercent
modifierDamageOutgoingPercentageIllusionAmplify val Unit GetModifierDamageOutgoing_Percentage_Illusion_Amplify
modifierDamageOutgoingPercentageMultiplicative val Unit GetModifierDamageOutgoing_PercentageMultiplicative
modifierDisableTurning val Int GetModifierDisableTurning
modifierDisassembleAnything val Unit GetModifierDisassembleAnything
modifierDodgeProjectile val Int GetModifierDodgeProjectile
modifierExtraHealthBonus val Float GetModifierExtraHealthBonus
modifierExtraHealthPercentage val Float GetModifierExtraHealthPercentage
modifierExtraManaBonus val Float GetModifierExtraManaBonus
modifierExtraManaBonusPercentage val Unit GetModifierExtraManaBonusPercentage
modifierExtraManaPercentage val Unit GetModifierExtraManaPercentage
modifierExtraStrengthBonus val Float GetModifierExtraStrengthBonus
modifierFixedAttackRate val Float GetModifierFixedAttackRate
modifierFixedManaRegen val Unit GetModifierFixedManaRegen
modifierForceMaxHealth val Unit GetModifierForceMaxHealth
modifierForceMaxMana val Unit GetModifierForceMaxMana
modifierFoWTeam val Unit GetModifierFoWTeam
modifierHasBonusNeutralItemChoice val Unit GetModifierHasBonusNeutralItemChoice
modifierHealAmplifyPercentageSource val Unit GetModifierHealAmplify_PercentageSource
modifierHealAmplifyPercentageTarget val Unit GetModifierHealAmplify_PercentageTarget
modifierHealthBonus val Float GetModifierHealthBonus
modifierHealthcostReductionConstant val Unit GetModifierHealthcostReduction_Constant
modifierHealthRegenPercentage val Float GetModifierHealthRegenPercentage
modifierHealthRegenPercentageUnique val Float GetModifierHealthRegenPercentageUnique
modifierHeroFacetOverride val Unit GetModifierHeroFacetOverride
modifierHeroLevelScale val Unit GetModifierHeroLevelScale
modifierHPRegenAmplifyPercentage val Float GetModifierHPRegenAmplify_Percentage
modifierHPRegenMultiplierPreAmplification val Unit GetModifierHPRegenMultiplierPreAmplification
modifierIgnoreCastAngle val Int GetModifierIgnoreCastAngle
modifierIgnoreCooldown val Int GetModifierIgnoreCooldown
modifierIgnoreMovespeedLimit val Int GetModifierIgnoreMovespeedLimit
modifierIllusionLabel val Int GetModifierIllusionLabel
modifierInnateDamageBlockPctOverride val Unit GetModifierInnateDamageBlockPctOverride
modifierIntellectNone val Unit GetModifierIntellectNone
modifierInventorySlotRestricted val Unit GetModifierInventorySlotRestricted
modifierInvisibilityAttackBehaviorException val Unit GetModifierInvisibilityAttackBehaviorException
modifierInvisibilityLevel val Float GetModifierInvisibilityLevel
modifierIsPackRat val Unit GetModifierIsPackRat
modifierItemSellbackCost val Unit GetModifierItemSellbackCost
modifierKillStreakBonusGoldPercentage val Unit GetModifierKillStreakBonusGoldPercentage
modifierKnockbackAmplificationPercentage val Unit GetModifierKnockbackAmplification_Percentage
modifierLifestealRegenAmplifyPercentage val Unit GetModifierLifestealRegenAmplify_Percentage
modifierMagicalResistanceBaseReduction val Unit GetModifierMagicalResistanceBaseReduction
modifierMagicalResistanceBonusIllusions val Unit GetModifierMagicalResistanceBonusIllusions
modifierMagicalResistanceBonusUnique val Unit GetModifierMagicalResistanceBonusUnique
modifierManaBonus val Float GetModifierManaBonus
modifierManaDrainAmplifyPercentage val Unit GetModifierManaDrainAmplify_Percentage
modifierMaxAttackRange val Float GetModifierMaxAttackRange
modifierMinPhysicalArmor val Unit GetModifierMinPhysicalArmor
modifierMissPercentage val Float GetModifierMiss_Percentage
modifierMissPercentageTarget val Unit GetModifierMiss_Percentage_Target
modifierModelChange val String GetModifierModelChange
modifierModelScale val Float GetModifierModelScale
modifierModelScaleAnimateTime val Unit GetModifierModelScaleAnimateTime
modifierModelScaleConstant val Unit GetModifierModelScaleConstant
modifierModelScaleUseInOutEase val Unit GetModifierModelScaleUseInOutEase
modifierMoveSpeedAbsolute val Float GetModifierMoveSpeed_Absolute
modifierMoveSpeedAbsoluteMax val Unit GetModifierMoveSpeed_AbsoluteMax
modifierMoveSpeedAbsoluteMin val Float GetModifierMoveSpeed_AbsoluteMin
modifierMoveSpeedLimit val Float GetModifierMoveSpeed_Limit
modifierMoveSpeedMaxOverride val Unit GetModifierMoveSpeed_MaxOverride
modifierMoveSpeedMinOverride val Unit GetModifierMoveSpeed_MinOverride
modifierMoveSpeedBonusConstant val Float GetModifierMoveSpeedBonus_Constant
modifierMoveSpeedBonusConstantUnique val Unit GetModifierMoveSpeedBonus_Constant_Unique
modifierMoveSpeedBonusConstantUnique2 val Float GetModifierMoveSpeedBonus_Constant_Unique_2
modifierMoveSpeedBonusPercentage val Float GetModifierMoveSpeedBonus_Percentage
modifierMoveSpeedBonusPercentageUnique val Float GetModifierMoveSpeedBonus_Percentage_Unique
modifierMoveSpeedBonusSpecialBoots val Float GetModifierMoveSpeedBonus_Special_Boots
modifierMoveSpeedBonusSpecialBoots2 val Float GetModifierMoveSpeedBonus_Special_Boots_2
modifierMoveSpeedMaxBonusConstant val Unit GetModifierMoveSpeedMax_BonusConstant
modifierMoveSpeedOverride val Float GetModifierMoveSpeedOverride
modifierMoveSpeedPostMultiplierBonusConstant val Unit GetModifierMoveSpeedPostMultiplierBonus_Constant
modifierMoveSpeedReductionPercentage val Unit GetModifierMoveSpeedReductionPercentage
modifierMPRegenAmplifyPercentage val Float GetModifierMPRegenAmplify_Percentage
modifierMPRegenAmplifyPercentageUnique val Unit GetModifierMPRegenAmplify_Percentage_Unique
modifierMPRestoreAmplifyPercentage val Float GetModifierMPRestoreAmplify_Percentage Total amplify value is clamped to 0.
modifierNegativeEvasionConstant val Float GetModifierNegativeEvasion_Constant
modifierNeutralEnhancementOptions val Unit GetModifierNeutralEnhancementOptions
modifierNeutralTrinketOptions val Unit GetModifierNeutralTrinketOptions
modifierNoFreeTPScrollOnDeath val Unit GetModifierNoFreeTPScrollOnDeath
modifierNoVisionOfAttacker val Unit GetModifierNoVisionOfAttacker
modifierOverrideAttackDamage val Float GetModifierOverrideAttackDamage
modifierOverrideBaseDamage val Unit GetModifierOverrideBaseDamage
modifierOverrideCreepBounty val Unit GetModifierOverrideCreepBounty
modifierOverrideUntargetableFrom val Unit GetModifierOverrideUntargetableFrom
modifierOverrideUntargetableTo val Unit GetModifierOverrideUntargetableTo
modifierPercentageAttackAnimTime val Float GetModifierPercentageAttackAnimTime
modifierPercentageConvertExpToGold val Unit GetModifierPercentageConvertExpToGold
modifierPercentageDeathGoldCost val Unit GetModifierPercentageDeathGoldCost
modifierPercentageExpRateBoost val Float GetModifierPercentageExpRateBoost
modifierPercentageGoldRateBoost val Unit GetModifierPercentageGoldRateBoost
modifierPercentageKillAssistGoldBoost val Unit GetModifierPercentageKillAssistGoldBoost
modifierPercentageManacostStacking val Float GetModifierPercentageManacostStacking
modifierPercentageRespawnTime val Float GetModifierPercentageRespawnTime
modifierPersistentInvisibility val Float GetModifierPersistentInvisibility
modifierPhysicalConstantBlockBonus val Unit GetModifierPhysical_ConstantBlockBonus
modifierPhysicalConstantBlockSpecial val Float GetModifierPhysical_ConstantBlockSpecial
modifierPhysicalArmorBasePercentage val Float GetModifierPhysicalArmorBase_Percentage Values above 100% are ignored.
modifierPhysicalArmorBonusPost val Unit GetModifierPhysicalArmorBonusPost
modifierPhysicalArmorTotalPercentage val Unit GetModifierPhysicalArmorTotal_Percentage
modifierPhysicalDamageOutgoingPercentage val Unit GetModifierPhysicalDamageOutgoing_Percentage
modifierPreAttackBonusDamage val Float GetModifierPreAttack_BonusDamage
modifierPreAttackBonusDamageProc val Float GetModifierPreAttack_BonusDamage_Proc
modifierPreAttackBonusDamageTarget val Unit GetModifierPreAttack_BonusDamage_Target
modifierPreAttackDeadlyBlow val Unit GetModifierPreAttack_DeadlyBlow
modifierPreAttackTargetCriticalStrike val Float GetModifierPreAttack_Target_CriticalStrike
modifierPrereduceIncomingDamageMult val Unit GetModifierPrereduceIncomingDamage_Mult
modifierPreserveNeutralItemPassives val Unit GetModifierPreserveNeutralItemPassives
modifierProcAttackBonusDamageMagicalTarget val Unit GetModifierProcAttack_BonusDamage_Magical_Target
modifierProcAttackConvertPhysicalToMagical val Unit GetModifierProcAttack_ConvertPhysicalToMagical
modifierProjectileName val String GetModifierProjectileName
modifierProjectileSpeed val Float GetModifierProjectileSpeed
modifierProjectileSpeedBonus val Float GetModifierProjectileSpeedBonus
modifierProjectileSpeedBonusPercentage val Float GetModifierProjectileSpeedBonusPercentage
modifierProjectileSpeedTarget val Unit GetModifierProjectileSpeedTarget
modifierPropertyMagicalLifesteal val Unit GetModifierProperty_MagicalLifesteal
modifierPropertyPhysicalLifesteal val Unit GetModifierProperty_PhysicalLifesteal
modifierPropertyConsumableUseSpeed val Unit GetModifierPropertyConsumableUseSpeed
modifierPropertyForbidIllusions val Unit GetModifierPropertyForbidIllusions
modifierPropertyHealingAmplificationUnique val Unit GetModifierPropertyHealingAmplificationUnique
modifierPropertyManacostOverride val Unit GetModifierPropertyManacostOverride
modifierPropertyRestorationAmplification val Unit GetModifierPropertyRestorationAmplification
modifierPropertyRestorationAmplificationUnique val Unit GetModifierPropertyRestorationAmplificationUnique
modifierPropertySuppressInvalidMoveAttackOrders val Unit GetModifierPropertySuppressInvalidMoveAttackOrders
modifierPropertyUpgradeNeutralArtifacts val Unit GetModifierPropertyUpgradeNeutralArtifacts
modifierPropetyFailAttack val Unit GetModifierPropetyFailAttack
modifierProvidesFOWVision val Int GetModifierProvidesFOWVision
modifierRadarCooldownReduction val Float GetModifierRadarCooldownReduction
modifierScepter val Int GetModifierScepter Applies scepter when this property is active
modifierShard val Int GetModifierShard Applies shard when this property is active
modifierShareXPRune val Unit GetModifierShareXPRune
modifierSlowResistanceStacking val Unit GetModifierSlowResistance_Stacking
modifierSlowResistanceAppliesToAttacks val Unit GetModifierSlowResistanceAppliesToAttacks
modifierSpellAmplifyPercentageTarget val Unit GetModifierSpellAmplify_PercentageTarget
modifierSpellAmplifyPercentageUnique val Float GetModifierSpellAmplify_PercentageUnique
modifierSpellLifestealRegenAmplifyPercentage val Unit GetModifierSpellLifestealRegenAmplify_Percentage
modifierSpellLifestealRegenAmplifyPercentageUnique val Unit GetModifierSpellLifestealRegenAmplify_Percentage_Unique
modifierSpellRedirectTarget val Unit GetModifierSpellRedirectTarget
modifierSpellsRequireHP val Float GetModifierSpellsRequireHP
modifierStackingRespawnTime val Float GetModifierStackingRespawnTime
modifierStatusResistance val Float GetModifierStatusResistance
modifierStatusResistanceStacking val Float GetModifierStatusResistanceStacking
modifierStrongIllusion val Unit GetModifierStrongIllusion
modifierSuperIllusion val Int GetModifierSuperIllusion
modifierSuperIllusionWithItems val Unit GetModifierSuperIllusionWithItems
modifierSuperIllusionWithUltimate val Int GetModifierSuperIllusionWithUltimate
modifierSuppressFullscreenDeathFX val Unit GetModifierSuppressFullscreenDeathFX
modifierTempestDouble val Int GetModifierTempestDouble
modifierTickGoldMultiplier val Unit GetModifierTickGold_Multiplier
modifierTotalConstantBlockStacking val Unit GetModifierTotal_ConstantBlockStacking
modifierTotalPercentageManaRegen val Float GetModifierTotalPercentageManaRegen
modifierTurnRateOverride val Float GetModifierTurnRate_Override
modifierTurnRatePercentage val Float GetModifierTurnRate_Percentage
modifierTurnRateConstant val Float GetModifierTurnRateConstant
modifierUnitDisllowUpgrading val Int GetModifierUnitDisllowUpgrading
modifierUnitStatsNeedsRefresh val Int GetModifierUnitStatsNeedsRefresh
modifierXPDuringDeath val Unit GetModifierXPDuringDeath
modifierXPFountainCountdownTimeOverride val Unit GetModifierXPFountainCountdownTimeOverride
modofierPropertyPseudoRandomBonus val Unit GetModofierPropertyPseudoRandomBonus
overrideAnimation val GameActivity GetOverrideAnimation
overrideAnimationRate val Float GetOverrideAnimationRate
overrideAttackMagical val Int GetOverrideAttackMagical
physicalArmorPiercingPercentageTarget val Unit GetPhysicalArmorPiercingPercentageTarget
primaryStatDamageMultiplier val Float GetPrimaryStatDamageMultiplier
redirectSpell val Unit GetRedirectSpell
requiredLevel val Unit GetRequiredLevel
skipAttackRegulator val Unit GetSkipAttackRegulator
suppressAttackProcs val Unit GetSuppressAttackProcs
suppressCrit val Unit GetSuppressCrit
suppressIncomingCrit val Unit GetSuppressIncomingCrit
suppressTeleport val Int GetSuppressTeleport
tierTokenReroll val Unit GetTierTokenReroll
triggerCosmeticAndEndAttack val Unit GetTriggerCosmeticAndEndAttack
unitLifetimeFraction val Float GetUnitLifetimeFraction
visionDegreeRestriction val Unit GetVisionDegreeRestriction
visualZDelta val Float GetVisualZDelta
visualZSpeedBaseOverride val Unit GetVisualZSpeedBaseOverride
hasBonusNeutralItemPassive val Unit HasBonusNeutralItemPassive

Methods

Method Return Type Native Name Description
allowIllusionDuplicate() Boolean = externalSource() AllowIllusionDuplicate True/false if this modifier is active on illusions.
getAuraEntityReject(entity: BaseNPC) Boolean = externalSource() GetAuraEntityReject Return true/false if this entity should receive the aura under specific conditions.
heroEffectPriority() Modifierpriority = externalSource() HeroEffectPriority Relationship of this hero effect with those from other buffs (higher is more likely to be shown).
removeOnDeath() Boolean = externalSource() RemoveOnDeath True/false if this modifier is removed when the parent dies.
statusEffectPriority() Modifierpriority = externalSource() StatusEffectPriority Relationship of this status effect with those from other buffs (higher is more likely to be shown).
checkState() Map<Modifierstate, Boolean> = externalSource() CheckState Return a map of enabled/disabled states.
declareFunctions() List<Modifierfunction> = externalSource() DeclareFunctions Return a list of modifier functions this modifier implements.
getAbsoluteNoDamageMagical(event: ModifierAttackEvent) Int = externalSource() GetAbsoluteNoDamageMagical
getAbsoluteNoDamagePhysical(event: ModifierAttackEvent) Int = externalSource() GetAbsoluteNoDamagePhysical
getAbsoluteNoDamagePure(event: ModifierAttackEvent) Int = externalSource() GetAbsoluteNoDamagePure
getAbsorbSpell(event: ModifierAbilityEvent) Int = externalSource() GetAbsorbSpell
getModifierAvoidDamage(event: ModifierAttackEvent) Float = externalSource() GetModifierAvoidDamage
getModifierAvoidDamageAfterReductions(event: ModifierAttackEvent) Float = externalSource() GetModifierAvoidDamageAfterReductions
getModifierAvoidSpell(event: ModifierAttackEvent) Int = externalSource() GetModifierAvoidSpell
getModifierBaseDamageOutgoingPercentage(event: ModifierAttackEvent) Float = externalSource() GetModifierBaseDamageOutgoing_Percentage
getModifierBaseDamageOutgoingPercentageUnique(event: ModifierAttackEvent) Float = externalSource() GetModifierBaseDamageOutgoing_PercentageUnique
getModifierCastRangeBonus(event: ModifierAbilityEvent) Float = externalSource() GetModifierCastRangeBonus
getModifierCastRangeBonusPercentage(event: ModifierAbilityEvent) Float = externalSource() GetModifierCastRangeBonusPercentage
getModifierCastRangeBonusStacking(event: ModifierAbilityEvent) Float = externalSource() GetModifierCastRangeBonusStacking
getModifierCastRangeBonusTarget(event: ModifierAbilityEvent) Float = externalSource() GetModifierCastRangeBonusTarget
getModifierCooldownReductionConstant(event: ModifierAbilityEvent) Float = externalSource() GetModifierCooldownReduction_Constant
getModifierDamageOutgoingPercentage(event: ModifierAttackEvent) Float = externalSource() GetModifierDamageOutgoing_Percentage
getModifierDamageOutgoingPercentageIllusion(event: ModifierAttackEvent) Float = externalSource() GetModifierDamageOutgoing_Percentage_Illusion
getModifierEvasionConstant(event: ModifierAttackEvent) Float = externalSource() GetModifierEvasion_Constant
getModifierHealthBarPips(event: ModifierAttackEvent) Float = externalSource() GetModifierHealthBarPips Return value is a count of pips.
getModifierIgnorePhysicalArmor(event: ModifierAttackEvent) Float = externalSource() GetModifierIgnorePhysicalArmor
getModifierIncomingDamagePercentage(event: ModifierAttackEvent) Float = externalSource() GetModifierIncomingDamage_Percentage
getModifierIncomingDamageConstant(event: ModifierAttackEvent) Float = externalSource() GetModifierIncomingDamageConstant This property controls 'universal' shield, if defined both on client and server. Return value on client should be current shield health, as a positive integer, on server - amount of damage blocked.
getModifierIncomingPhysicalDamagePercentage(event: ModifierAttackEvent) Float = externalSource() GetModifierIncomingPhysicalDamage_Percentage
getModifierIncomingPhysicalDamageConstant(event: ModifierAttackEvent) Float = externalSource() GetModifierIncomingPhysicalDamageConstant This property controls 'physical' shield, if defined both on client and server. Return value on client should be current shield health, as a positive integer, on server - amount of damage blocked.
getModifierIncomingSpellDamageConstant(event: ModifierAttackEvent) Float = externalSource() GetModifierIncomingSpellDamageConstant This property controls 'spell' shield, if defined both on client and server. Return value on client should be current shield health, as a positive integer, on server - amount of damage blocked.
getModifierMagicalConstantBlock(event: ModifierAttackEvent) Float = externalSource() GetModifierMagical_ConstantBlock
getModifierMagicalResistanceBonus(event: ModifierAttackEvent) Float = externalSource() GetModifierMagicalResistanceBonus
getModifierMagicalResistanceDecrepifyUnique(event: ModifierAttackEvent) Float = externalSource() GetModifierMagicalResistanceDecrepifyUnique
getModifierMagicalResistanceDirectModification(event: ModifierAttackEvent) Float = externalSource() GetModifierMagicalResistanceDirectModification
getModifierManacostReductionConstant(event: ModifierAbilityEvent) Float = externalSource() GetModifierManacostReduction_Constant
getModifierOverrideAbilitySpecial(event: ModifierOverrideAbilitySpecialEvent) Int = externalSource() GetModifierOverrideAbilitySpecial
getModifierOverrideAbilitySpecialValue(event: ModifierOverrideAbilitySpecialEvent) Float = externalSource() GetModifierOverrideAbilitySpecialValue
getModifierPercentageCasttime(event: ModifierAbilityEvent) Float = externalSource() GetModifierPercentageCasttime
getModifierPercentageCooldown(event: ModifierAbilityEvent) Float = externalSource() GetModifierPercentageCooldown
getModifierPercentageCooldownOngoing(event: ModifierAbilityEvent) Float = externalSource() GetModifierPercentageCooldownOngoing
getModifierPercentageCooldownStacking(event: ModifierAbilityEvent) Float = externalSource() GetModifierPercentageCooldownStacking
getModifierPercentageHealthcost(event: ModifierAbilityEvent) Float = externalSource() GetModifierPercentageHealthcost
getModifierPercentageHealthcostStacking(event: ModifierAbilityEvent) Float = externalSource() GetModifierPercentageHealthcostStacking
getModifierPercentageManacost(event: ModifierAbilityEvent) Float = externalSource() GetModifierPercentageManacost
getModifierPhysicalConstantBlock(event: ModifierAttackEvent) Float = externalSource() GetModifierPhysical_ConstantBlock
getModifierPhysicalConstantBlockUnavoidablePreArmor(event: ModifierAttackEvent) Float = externalSource() GetModifierPhysical_ConstantBlockUnavoidablePreArmor
getModifierPhysicalArmorBonus(event: ModifierAttackEvent) Float = externalSource() GetModifierPhysicalArmorBonus
getModifierPhysicalArmorBonusUnique(event: ModifierAttackEvent) Float = externalSource() GetModifierPhysicalArmorBonusUnique
getModifierPhysicalArmorBonusUniqueActive(event: ModifierAttackEvent) Float = externalSource() GetModifierPhysicalArmorBonusUniqueActive
getModifierPreAttack(event: ModifierAttackEvent) Float = externalSource() GetModifierPreAttack
getModifierPreAttackBonusDamagePostCrit(event: ModifierAttackEvent) Float = externalSource() GetModifierPreAttack_BonusDamagePostCrit
getModifierPreAttackCriticalStrike(event: ModifierAttackEvent) Float = externalSource() GetModifierPreAttack_CriticalStrike
getModifierProcAttackBonusDamageMagical(event: ModifierAttackEvent) Float = externalSource() GetModifierProcAttack_BonusDamage_Magical
getModifierProcAttackBonusDamagePhysical(event: ModifierAttackEvent) Float = externalSource() GetModifierProcAttack_BonusDamage_Physical
getModifierProcAttackBonusDamagePure(event: ModifierAttackEvent) Float = externalSource() GetModifierProcAttack_BonusDamage_Pure
getModifierProcAttackFeedback(event: ModifierAttackEvent) Float = externalSource() GetModifierProcAttack_Feedback
getModifierSpellAmplifyPercentage(event: ModifierAttackEvent) Float = externalSource() GetModifierSpellAmplify_Percentage
getModifierStatusResistanceCaster(event: ModifierUnitEvent) Float = externalSource() GetModifierStatusResistanceCaster
getModifierTotalConstantBlock(event: ModifierAttackEvent) Float = externalSource() GetModifierTotal_ConstantBlock
getModifierTotalDamageOutgoingPercentage(event: ModifierAttackEvent) Float = externalSource() GetModifierTotalDamageOutgoing_Percentage
getReflectSpell(event: ModifierAbilityEvent) Int = externalSource() GetReflectSpell
getSuppressCleave(event: ModifierAttackEvent) Int = externalSource() GetSuppressCleave
onTooltip() Float = externalSource() OnTooltip
onTooltip2() Float = externalSource() OnTooltip2
preserveParticlesOnModelChanged() Int = externalSource() PreserveParticlesOnModelChanged
reincarnateTime() Float = externalSource() ReincarnateTime

ModifierLuaHorizontalMotion

Native name: CDOTA_Modifier_Lua_Horizontal_Motion

Extends: ModifierLua

Methods

Method Return Type Native Name Description
applyHorizontalMotionController() Boolean = externalSource() ApplyHorizontalMotionController Starts the horizontal motion controller effects for this buff. Returns true if successful.

ModifierLuaMotionBoth

Native name: CDOTA_Modifier_Lua_Motion_Both

Extends: ModifierLua

Methods

Method Return Type Native Name Description
applyHorizontalMotionController() Boolean = externalSource() ApplyHorizontalMotionController Starts the horizontal motion controller effects for this buff. Returns true if successful.
applyVerticalMotionController() Boolean = externalSource() ApplyVerticalMotionController Starts the vertical motion controller effects for this buff. Returns true if successful.

ModifierLuaVerticalMotion

Native name: CDOTA_Modifier_Lua_Vertical_Motion

Extends: ModifierLua

Properties

Property Type Native Name Description
motionPriority var Modifierpriority GetMotionPriority / SetMotionPriority Get the priority.

Methods

Method Return Type Native Name Description
applyVerticalMotionController() Boolean = externalSource() ApplyVerticalMotionController Starts the vertical motion controller effects for this buff. Returns true if successful.

NeutralSpawner

Native name: CDOTA_NeutralSpawner

Extends: CPointEntity


PlayerResourceType

Native name: CDOTA_PlayerResource

Extends: CBaseEntity

Properties

Property Type Native Name Description
numConnectedHumanPlayers val Int GetNumConnectedHumanPlayers Players on a valid team (radiant, dire, or custom*) who haven't abandoned the game.
playerCount val Int GetPlayerCount Includes spectators and players not assigned to a team.
teamPlayerCount val Int GetTeamPlayerCount (Deprecated: use GetNumConnectedHumanPlayers) Players on a valid team (radiant, dire, or custom*) who haven't abandoned the game.
hasSetNetworkedEventActionClaimCount val Boolean HasSetNetworkedEventActionClaimCount

Methods

Method Return Type Native Name Description
areUnitsSharedWithPlayerID(unitOwnerPlayerId: PlayerID, otherPlayerId: PlayerID,) Boolean = externalSource() AreUnitsSharedWithPlayerID
canRepick(playerId: PlayerID) Boolean = externalSource() CanRepick
getAegisPickups(playerId: PlayerID) Int = externalSource() GetAegisPickups
getAssists(playerId: PlayerID) Int = externalSource() GetAssists
getBroadcasterChannel(playerId: PlayerID) UInt = externalSource() GetBroadcasterChannel
getBroadcasterChannelSlot(playerId: PlayerID) UInt = externalSource() GetBroadcasterChannelSlot
getClaimedDenies(playerId: PlayerID) Int = externalSource() GetClaimedDenies
getClaimedFarm(playerId: PlayerID, onlyEarned: Boolean,) Float = externalSource() GetClaimedFarm
getClaimedMisses(playerId: PlayerID) Int = externalSource() GetClaimedMisses
getConnectionState(playerId: PlayerID) DOTAConnectionState = externalSource() GetConnectionState
getCreepDamageTaken(playerId: PlayerID, total: Boolean,) Float = externalSource() GetCreepDamageTaken
getCustomBuybackCooldown(playerId: PlayerID) Float = externalSource() GetCustomBuybackCooldown
getCustomBuybackCost(playerId: PlayerID) Int = externalSource() GetCustomBuybackCost
getCustomTeamAssignment(playerId: PlayerID) Int = externalSource() GetCustomTeamAssignment Get the current custom team assignment for this player.
getDamageDoneToHero(playerId: PlayerID, victimId: PlayerID,) Float = externalSource() GetDamageDoneToHero
getDeaths(playerId: PlayerID) Int = externalSource() GetDeaths
getDenies(playerId: PlayerID) Int = externalSource() GetDenies
getEventGameUpgrades(playerId: PlayerID) Any = externalSource() GetEventGameUpgrades (nPlayerID).
getEventPointsForPlayerID(playerId: PlayerID) UInt = externalSource() GetEventPointsForPlayerID
getEventPremiumPoints(playerId: PlayerID) UInt = externalSource() GetEventPremiumPoints
getEventRanks(playerId: PlayerID) Any = externalSource() GetEventRanks
getGold(playerId: PlayerID) Int = externalSource() GetGold
getGoldLostToDeath(playerId: PlayerID) Int = externalSource() GetGoldLostToDeath
getGoldPerMin(playerId: PlayerID) Float = externalSource() GetGoldPerMin
getGoldSpentOnBuybacks(playerId: PlayerID) Int = externalSource() GetGoldSpentOnBuybacks
getGoldSpentOnConsumables(playerId: PlayerID) Int = externalSource() GetGoldSpentOnConsumables
getGoldSpentOnItems(playerId: PlayerID) Int = externalSource() GetGoldSpentOnItems
getGoldSpentOnSupport(playerId: PlayerID) Int = externalSource() GetGoldSpentOnSupport
getHealing(playerId: PlayerID) Float = externalSource() GetHealing
getHeroDamageTaken(playerId: PlayerID, total: Boolean,) Float = externalSource() GetHeroDamageTaken
getKills(playerId: PlayerID) Int = externalSource() GetKills
getKillsDoneToHero(playerId: PlayerID, victimId: PlayerID,) Int = externalSource() GetKillsDoneToHero
getLabyrinthEventGameHeroUnlocks(playerId: PlayerID) Any = externalSource() GetLabyrinthEventGameHeroUnlocks (nPlayerID).
getLastHitMultikill(playerId: PlayerID) Int = externalSource() GetLastHitMultikill
getLastHits(playerId: PlayerID) Int = externalSource() GetLastHits
getLastHitStreak(playerId: PlayerID) Int = externalSource() GetLastHitStreak
getLevel(playerId: PlayerID) Int = externalSource() GetLevel
getLiveSpectatorTeam(playerId: PlayerID) DOTATeam = externalSource() GetLiveSpectatorTeam
getMisses(playerId: PlayerID) Int = externalSource() GetMisses
getNearbyCreepDeaths(playerId: PlayerID) Int = externalSource() GetNearbyCreepDeaths
getNetworkedEventActionClaimCount(playerId: PlayerID, eventId: Int, actionId: UInt,) Int = externalSource() GetNetworkedEventActionClaimCount
getNetworkedEventActionClaimCountByName(playerId: PlayerID, eventId: Int, actionName: String,) Int = externalSource() GetNetworkedEventActionClaimCountByName
getNetWorth(playerId: PlayerID) Int = externalSource() GetNetWorth
getNthCourierForTeam(courierIndex: Int, teamNumber: DOTATeam,) UnitCourier? = externalSource() GetNthCourierForTeam
getNthPlayerIDOnTeam(teamNumber: DOTATeam, nthPlayer: Int,) PlayerID = externalSource() GetNthPlayerIDOnTeam
getNumConsumablesPurchased(playerId: PlayerID) Int = externalSource() GetNumConsumablesPurchased
getNumCouriersForTeam(teamNumber: DOTATeam) Int = externalSource() GetNumCouriersForTeam
getNumItemsPurchased(playerId: PlayerID) Int = externalSource() GetNumItemsPurchased
getPartyID(playerId: PlayerID) Uint64 = externalSource() GetPartyID
getPlayer(playerId: PlayerID) PlayerController? = externalSource() GetPlayer Returns player entity for a player with specified id. Player entity represents a single connection, so a different entity might be returned. When player is disconnected nil would be returned.
getPlayerCountForTeam(team: DOTATeam) Int = externalSource() GetPlayerCountForTeam
getPlayerLoadedCompletely(playerId: PlayerID) Boolean = externalSource() GetPlayerLoadedCompletely
getPlayerName(playerId: PlayerID) String = externalSource() GetPlayerName
getPreferredCourierForPlayer(playerId: PlayerID) Any = externalSource() GetPreferredCourierForPlayer
getRawPlayerDamage(playerId: PlayerID) Float = externalSource() GetRawPlayerDamage
getReliableGold(playerId: PlayerID) Int = externalSource() GetReliableGold
getRespawnSeconds(playerId: PlayerID) Int = externalSource() GetRespawnSeconds
getRoshanKills(playerId: PlayerID) Int = externalSource() GetRoshanKills
getRunePickups(playerId: PlayerID) Int = externalSource() GetRunePickups
getSelectedHeroEntity(playerId: PlayerID) BaseNPCHero? = externalSource() GetSelectedHeroEntity
getSelectedHeroID(playerId: PlayerID) Int = externalSource() GetSelectedHeroID
getSelectedHeroName(playerId: PlayerID) String = externalSource() GetSelectedHeroName
getSteamAccountID(playerId: PlayerID) UInt = externalSource() GetSteamAccountID
getSteamID(playerId: PlayerID) Uint64 = externalSource() GetSteamID Get the 64 bit steam ID for a given player.
getStreak(playerId: PlayerID) Int = externalSource() GetStreak
getStuns(playerId: PlayerID) Float = externalSource() GetStuns
getTeam(playerId: PlayerID) DOTATeam = externalSource() GetTeam
getTeamKills(team: DOTATeam) Int = externalSource() GetTeamKills
getTimeOfLastConsumablePurchase(playerId: PlayerID) Float = externalSource() GetTimeOfLastConsumablePurchase
getTimeOfLastDeath(playerId: PlayerID) Float = externalSource() GetTimeOfLastDeath
getTimeOfLastItemPurchase(playerId: PlayerID) Float = externalSource() GetTimeOfLastItemPurchase
getTotalEarnedGold(playerId: PlayerID) Int = externalSource() GetTotalEarnedGold
getTotalEarnedXP(playerId: PlayerID) Int = externalSource() GetTotalEarnedXP
getTotalGoldSpent(playerId: PlayerID) Int = externalSource() GetTotalGoldSpent
getTowerDamageTaken(playerId: PlayerID, total: Boolean,) Float = externalSource() GetTowerDamageTaken
getTowerKills(playerId: PlayerID) Int = externalSource() GetTowerKills
getUnitShareMaskForPlayer(playerId: PlayerID, otherPlayerId: PlayerID,) Int = externalSource() GetUnitShareMaskForPlayer
getUnreliableGold(playerId: PlayerID) Int = externalSource() GetUnreliableGold
getXPPerMin(playerId: PlayerID) Float = externalSource() GetXPPerMin
hasCustomGameTicketForPlayerID(playerId: PlayerID) Boolean = externalSource() HasCustomGameTicketForPlayerID Does this player have a custom game ticket for this game?
hasRandomed(playerId: PlayerID) Boolean = externalSource() HasRandomed
hasSelectedHero(playerId: PlayerID) Boolean = externalSource() HasSelectedHero
haveAllPlayersJoined() Boolean = externalSource() HaveAllPlayersJoined
isBroadcaster(playerId: PlayerID) Boolean = externalSource() IsBroadcaster
isDisableHelpSetForPlayerID(playerId: PlayerID, otherPlayerId: PlayerID,) Boolean = externalSource() IsDisableHelpSetForPlayerID
isFakeClient(playerId: PlayerID) Boolean = externalSource() IsFakeClient
isHeroSelected(heroname: String, ignoreUnrevealedPick: Boolean,) Boolean = externalSource() IsHeroSelected
isHeroSharedWithPlayerID(unitOwnerPlayerId: PlayerID, otherPlayerId: PlayerID,) Boolean = externalSource() IsHeroSharedWithPlayerID
isValidPlayer(playerId: Int) Boolean = externalSource() IsValidPlayer
isValidPlayerID(playerId: Int) Boolean = externalSource() IsValidPlayerID
isValidTeamPlayer(playerId: Int) Boolean = externalSource() IsValidTeamPlayer
isValidTeamPlayerID(playerId: Int) Boolean = externalSource() IsValidTeamPlayerID
modifyGold(playerId: PlayerID, goldChange: Int, reliable: Boolean, reason: ModifyGoldReason,) Int = externalSource() ModifyGold
numPlayers() Int = externalSource() NumPlayers
numTeamPlayers() Int = externalSource() NumTeamPlayers
replaceHeroWith(playerId: PlayerID, heroClass: String, gold: Int, xp: Int,) BaseNPCHero = externalSource() ReplaceHeroWith Replaces the player's hero with a new one of the specified class, gold and XP.
replaceHeroWithNoTransfer(playerId: PlayerID, heroClass: String, gold: Int, xp: Int,) Any = externalSource() ReplaceHeroWithNoTransfer Replaces the player's hero with a new one of the specified class, gold and XP, without transferring items/abilities if same hero.
whoSelectedHero(heroFilename: String, ignoreUnrevealedPick: Boolean,) PlayerID = externalSource() WhoSelectedHero

ShopTrigger

Native name: CDOTA_ShopTrigger

Extends: CBaseTrigger

Properties

Property Type Native Name Description
shopType var DotaShopType GetShopType / SetShopType Get the DOTA_SHOP_TYPE.

SimpleObstruction

Native name: CDOTA_SimpleObstruction

Extends: CBaseEntity

Properties

Property Type Native Name Description
isEnabled val Boolean IsEnabled Returns whether the obstruction is currently active.

UnitCourier

Native name: CDOTA_Unit_Courier

Extends: BaseNPC


UnitCustomGameAnnouncer

Native name: CDOTA_Unit_CustomGameAnnouncer

Extends: BaseNPC


UnitCustomGameAnnouncerAghanim

Native name: CDOTA_Unit_CustomGameAnnouncerAghanim

Extends: BaseNPC


UnitNian

Native name: CDOTA_Unit_Nian

Extends: BaseNPCCreature

Properties

Property Type Native Name Description
horn val Any GetHorn Is the Nian horn?
tail val Any GetTail Is the Nian's tail broken?
isHornAlive val Boolean IsHornAlive Is the Nian's horn broken?
isTailAlive val Boolean IsTailAlive Is the Nian's tail broken?

UnitScout

Native name: CDOTA_Unit_Scout

Extends: BaseNPC


BaseAbility

Native name: CDOTABaseAbility

Extends: CBaseEntity

Properties

Property Type Native Name Description
canAbilityBeUpgraded val Boolean CanAbilityBeUpgraded
abilityDamage val Int GetAbilityDamage
abilityDamageType val DamageTypes GetAbilityDamageType
abilityIndex var Int GetAbilityIndex / SetAbilityIndex
abilityKeyValues val Any GetAbilityKeyValues Gets the key values definition for this ability.
abilityName val String GetAbilityName Returns the name of this ability.
abilityTargetFlags val DotaUnitTargetFlags GetAbilityTargetFlags
abilityTargetTeam val DotaUnitTargetTeam GetAbilityTargetTeam
abilityTargetType val DotaUnitTargetType GetAbilityTargetType
abilityType val Int GetAbilityType
animationIgnoresModelScale val Boolean GetAnimationIgnoresModelScale
aOERadius val Float GetAOERadius Controls the size of the AOE casting cursor.
associatedPrimaryAbilities val String GetAssociatedPrimaryAbilities Returns abilities that are stolen simultaneously, or otherwise related in functionality.
associatedSecondaryAbilities val String GetAssociatedSecondaryAbilities Returns other abilities that are stolen simultaneously, or otherwise related in functionality. Generally hidden abilities.
autoCastState val Boolean GetAutoCastState
backswingTime val Float GetBackswingTime
behavior val DotaAbilityBehavior GetBehavior Return cast behavior type of this ability.
behaviorInt val DotaAbilityBehavior GetBehaviorInt Get ability behavior flags as an int for compatability.
caster val BaseNPC GetCaster Get the owner of this ability.
castPoint val Float GetCastPoint Return cast point of this ability.
castPointModifier val Float GetCastPointModifier
channelStartTime val Float GetChannelStartTime Return the channel start time of this ability.
channelTime val Float GetChannelTime Return the channel time of this ability.
cloneSource val BaseNPC? GetCloneSource
conceptRecipientType val Int GetConceptRecipientType Return who hears speech when this spell is cast.
cooldownTime val Float GetCooldownTime
cooldownTimeRemaining val Float GetCooldownTimeRemaining
currentAbilityCharges var Int GetCurrentAbilityCharges / SetCurrentAbilityCharges The number of charges remaining on this ability.
cursorPosition val Vector GetCursorPosition
cursorTarget val BaseNPC? GetCursorTarget
cursorTargetingNothing val Boolean GetCursorTargetingNothing
duration val Float GetDuration
heroLevelRequiredToUpgrade val Int GetHeroLevelRequiredToUpgrade
intrinsicModifierName val String GetIntrinsicModifierName Returns the name of the modifier applied passively by this ability.
level var Int GetLevel / SetLevel Get the current level of the ability.
maxLevel val Int GetMaxLevel
modifierValue val Float GetModifierValue
modifierValueBonus val Float GetModifierValueBonus
playbackRateOverride val Float GetPlaybackRateOverride Return the animation rate of the cast animation.
sharedCooldownName val String GetSharedCooldownName
stolenActivityModifier val String GetStolenActivityModifier
toggleState val Boolean GetToggleState Whether or not this ability is toggled.
upgradeRecommended var Boolean GetUpgradeRecommended / SetUpgradeRecommended
isActivated var Boolean IsActivated / SetActivated
isAttributeBonus val Boolean IsAttributeBonus Is this ability an Attribute Bonus.
isChanneling var Boolean IsChanneling / SetChanneling Returns whether the ability is currently channeling.
isCooldownReady val Boolean IsCooldownReady
isFullyCastable val Boolean IsFullyCastable Returns whether the ability can be cast.
isHidden var Boolean IsHidden / SetHidden
isHiddenAsSecondaryAbility val Boolean IsHiddenAsSecondaryAbility
isHiddenWhenStolen val Boolean IsHiddenWhenStolen Returns true if this ability is hidden when stolen by Spell Steal.
isInAbilityPhase var Boolean IsInAbilityPhase / SetInAbilityPhase Returns whether the ability is currently casting.
isItem val Boolean IsItem Whether or not this ability is an item.
isOwnersGoldEnoughForUpgrade val Boolean IsOwnersGoldEnoughForUpgrade
isOwnersManaEnough val Boolean IsOwnersManaEnough
isPassive val Boolean IsPassive
isRefreshable val Boolean IsRefreshable Returns true if this ability is refreshed by Refresher Orb.
isSharedWithTeammates val Boolean IsSharedWithTeammates
isStealable var Boolean IsStealable / SetStealable Returns true if this ability can be stolen by Spell Steal.
isStolen var Boolean IsStolen / SetStolen
isToggle val Boolean IsToggle
isTrained val Boolean IsTrained
shouldUseResources val Boolean ShouldUseResources

Methods

Method Return Type Native Name Description
castAbility() Boolean = externalSource() CastAbility
continueCasting() Boolean = externalSource() ContinueCasting
getAbilityChargeRestoreTime(level: Int) Float = externalSource() GetAbilityChargeRestoreTime
getCastRange(location: Vector?, target: BaseNPC?,) Int = externalSource() GetCastRange Gets the cast range of the ability.
getChannelledHealthCostPerSecond(level: Int) Int = externalSource() GetChannelledHealthCostPerSecond Return health cost per second of channeling at the given level (-1 is current).
getChannelledManaCostPerSecond(level: Int) Int = externalSource() GetChannelledManaCostPerSecond Return mana cost at the given level per second while channeling (-1 is current).
getCooldown(level: Int) Float = externalSource() GetCooldown Get the cooldown duration for this ability at a given level, not the amount of cooldown actually left.
getEffectiveCastRange(location: Vector, target: Any,) Int = externalSource() GetEffectiveCastRange Gets the cast range of the ability, taking modifiers into account.
getEffectiveCooldown(level: Int) Float = externalSource() GetEffectiveCooldown
getEffectiveHealthCost(level: Int) Int = externalSource() GetEffectiveHealthCost
getEffectiveManaCost(level: Int) Int = externalSource() GetEffectiveManaCost
getGoldCost(level: Int) Int = externalSource() GetGoldCost Return gold cost at the given level (-1 is current).
getGoldCostForUpgrade(level: Int) Int = externalSource() GetGoldCostForUpgrade
getHealthCost(level: Int) Int = externalSource() GetHealthCost Return health cost at the given level (-1 is current).
getInitialAbilityCharges(level: Int) Int = externalSource() GetInitialAbilityCharges
getLevelSpecialValueFor(name: String, level: Int,) Float = externalSource() GetLevelSpecialValueFor Gets a value from this ability's special value block for passed level.
getLevelSpecialValueNoOverride(name: String, level: Int,) Float = externalSource() GetLevelSpecialValueNoOverride Gets a value from this ability's special value block for passed level, ignoring MODIFIER_PROPERTY_OVERRIDE_ABILITY_SPECIAL.
getManaCost(level: Int) Int = externalSource() GetManaCost Return mana cost at the given level (-1 is current).
getMaxAbilityCharges(level: Int) Int = externalSource() GetMaxAbilityCharges
getSpecialValueFor(name: String) Float = externalSource() GetSpecialValueFor Gets a value from this ability's special value block for its current level.
heroXPChange(xp: Float) Boolean = externalSource() HeroXPChange
isCosmetic(entity: CBaseEntity) Boolean = externalSource() IsCosmetic Is this a cosmetic only ability?
isOwnersGoldEnough(issuerPlayerId: PlayerID) Boolean = externalSource() IsOwnersGoldEnough
numModifiersUsingAbility() Int = externalSource() NumModifiersUsingAbility
onAbilityPhaseStart() Boolean = externalSource() OnAbilityPhaseStart Cast time begins (return true for successful cast).
playsDefaultAnimWhenStolen() Boolean = externalSource() PlaysDefaultAnimWhenStolen
procsMagicStick() Boolean = externalSource() ProcsMagicStick Returns true if this ability will generate magic stick charges for nearby enemies.
refCountsModifiers() Boolean = externalSource() RefCountsModifiers
requiresFacing() Boolean = externalSource() RequiresFacing Does this ability need the caster to face the target before executing?
resetToggleOnRespawn() Boolean = externalSource() ResetToggleOnRespawn Returns true if this ability should return to the default toggle state when its parent respawns.
speakTrigger() Any = externalSource() SpeakTrigger Return the type of speech used.

BaseGameMode

Native name: CDOTABaseGameMode

Extends: CBaseEntity

Properties

Property Type Native Name Description
areWeatherEffectsDisabled var Boolean AreWeatherEffectsDisabled / SetWeatherEffectsDisabled Get if weather effects are disabled on the client.
alwaysShowPlayerInventory var Boolean GetAlwaysShowPlayerInventory / SetAlwaysShowPlayerInventory Show the player hero's inventory in the HUD, regardless of what unit is selected.
alwaysShowPlayerNames var Boolean GetAlwaysShowPlayerNames / SetAlwaysShowPlayerNames Get whether player names are always shown, regardless of client setting.
announcerDisabled var Boolean GetAnnouncerDisabled / SetAnnouncerDisabled Are in-game announcers disabled?
announcerGameModeAnnounceDisabled var Boolean GetAnnouncerGameModeAnnounceDisabled / SetAnnouncerGameModeAnnounceDisabled Is the announcer announcing the mode / saying Choose Your Hero on start of custom games disabled?
cameraDistanceOverride var Float GetCameraDistanceOverride / SetCameraDistanceOverride Set a different camera distance; dota default is 1134.
customBackpackCooldownPercent var Float GetCustomBackpackCooldownPercent / SetCustomBackpackCooldownPercent Get the current rate cooldown ticks down for items in the backpack.
customBackpackSwapCooldown var Float GetCustomBackpackSwapCooldown / SetCustomBackpackSwapCooldown Get the current custom backpack swap cooldown.
customBuybackCooldownEnabled var Boolean GetCustomBuybackCooldownEnabled / SetCustomBuybackCooldownEnabled Turns on capability to define custom buyback cooldowns.
customBuybackCostEnabled var Boolean GetCustomBuybackCostEnabled / SetCustomBuybackCostEnabled Turns on capability to define custom buyback costs.
customDireScore var Int GetCustomDireScore / SetCustomDireScore Get the topbar score display value for dire.
customGlyphCooldown var Float GetCustomGlyphCooldown / SetCustomGlyphCooldown Get the current custom glyph cooldown.
customHeroMaxLevel var Int GetCustomHeroMaxLevel / SetCustomHeroMaxLevel Allows definition of the max level heroes can achieve (default is 25).
customRadiantScore var Int GetCustomRadiantScore / SetCustomRadiantScore Get the topbar score display value for radiant.
customScanCooldown var Float GetCustomScanCooldown / SetCustomScanCooldown Get the current custom scan cooldown.
daynightCycleAdvanceRate var Float GetDaynightCycleAdvanceRate / SetDaynightCycleAdvanceRate Get the rate at which the day/night cycle advances (1.0 = default).
eventGameSeed val Int GetEventGameSeed Get the Game Seed passed from the GC.
eventWindowStartTime val UInt GetEventWindowStartTime Get the Event Window Start Time passed from the GC.
fixedRespawnTime var Float GetFixedRespawnTime / SetFixedRespawnTime Gets the fixed respawn time.
fogOfWarDisabled var Boolean GetFogOfWarDisabled / SetFogOfWarDisabled Turn the fog of war on or off.
goldSoundDisabled var Boolean GetGoldSoundDisabled / SetGoldSoundDisabled Turn the sound when gold is acquired off/on.
maximumAttackSpeed var Int GetMaximumAttackSpeed / SetMaximumAttackSpeed Get the maximum attack speed for units.
minimumAttackSpeed var Int GetMinimumAttackSpeed / SetMinimumAttackSpeed Get the minimum attack speed for units.
recommendedItemsDisabled var Boolean GetRecommendedItemsDisabled / SetRecommendedItemsDisabled Turn the panel for showing recommended items at the shop off/on.
respawnTimeScale var Float GetRespawnTimeScale / SetRespawnTimeScale Returns the scale applied to non-fixed respawn times.
stashPurchasingDisabled var Boolean GetStashPurchasingDisabled / SetStashPurchasingDisabled Turn purchasing items to the stash off/on. If purchasing to the stash is off the player must be at a shop to purchase items.
stickyItemDisabled var Boolean GetStickyItemDisabled / SetStickyItemDisabled Hide the sticky item in the quickbuy.
topBarTeamValuesOverride var Boolean GetTopBarTeamValuesOverride / SetTopBarTeamValuesOverride Override the values of the team values on the top game bar.
topBarTeamValuesVisible var Boolean GetTopBarTeamValuesVisible / SetTopBarTeamValuesVisible Turning on/off the team values on the top game bar.
towerBackdoorProtectionEnabled var Boolean GetTowerBackdoorProtectionEnabled / SetTowerBackdoorProtectionEnabled Gets whether tower backdoor protection is enabled or not.
useCustomHeroLevels var Boolean GetUseCustomHeroLevels / SetUseCustomHeroLevels Are custom-defined XP values for hero level ups in use?
waterRuneLastSpawnTime var Float GetWaterRuneLastSpawnTime / SetWaterRuneLastSpawnTime Gets the time from game start during which water runes spawn.
isBuybackEnabled var Boolean IsBuybackEnabled / SetBuybackEnabled Enables or disables buyback completely.
isDaynightCycleDisabled var Boolean IsDaynightCycleDisabled / SetDaynightCycleDisabled Is the day/night cycle disabled?
shouldGiveFreeTPOnDeath var Boolean ShouldGiveFreeTPOnDeath / SetGiveFreeTPOnDeath Bool bGive.

Methods

Method Return Type Native Name Description
addRealTimeCombatAnalyzerQuery(queryTable: Any, player: PlayerController, queryName: String,) CombatAnalyzerQueryID = externalSource() AddRealTimeCombatAnalyzerQuery Begin tracking a sequence of events using the real time combat analyzer.
allocateFowBlockerRegion(minX: Float, minY: Float, maxX: Float, maxY: Float, gridSize: Float,) CFoWBlockerRegion = externalSource() AllocateFowBlockerRegion Allocates an entity which can be used by custom games to control FoW occlusion volumes.
getCustomAttributeDerivedStatValue(derivedStatType: AttributeDerivedStats) Float = externalSource() GetCustomAttributeDerivedStatValue Get current derived stat value constant.
getHUDVisible(element: Int) Boolean = externalSource() GetHUDVisible Returns the HUD element visibility.
isAbilityUpgradeWhitelisted(abilityName: String) Boolean = externalSource() IsAbilityUpgradeWhitelisted Const char* pszAbilityName.

GameManager

Native name: CDOTAGameManager

Methods

Method Return Type Native Name Description
getHeroDataByNameScript(heroName: String) Any = externalSource() GetHeroDataByName_Script Get the hero unit.
getHeroIDByName(heroName: String) Int = externalSource() GetHeroIDByName Get the hero ID given the hero name.
getHeroLocTokenByID(arg1: Int) String = externalSource() GetHeroLocTokenByID Get the localization token for the given hero ID.
getHeroNameByID(heroId: Int) String = externalSource() GetHeroNameByID Get the hero name given a hero ID.
getHeroNameForUnitName(unitName: String) String = externalSource() GetHeroNameForUnitName Get the hero name given a unit name.
getHeroUnitNameByID(heroId: Int) String = externalSource() GetHeroUnitNameByID Get the hero unit name given the hero ID.

GameRulesType

Native name: CDOTAGameRules

Properties

Property Type Native Name Description
didMatchSignoutTimeOut val Boolean DidMatchSignoutTimeOut True when we have waited some time after end of the game and not received signout.
bannedHeroes val List<String> GetBannedHeroes Returns the hero unit names banned in this game, if any.
bannedHeroIDs val Any GetBannedHeroIDs Returns the hero unit IDs banned in this game, if any.
customGameDifficulty var Int GetCustomGameDifficulty / SetCustomGameDifficulty Returns the difficulty level of the custom game mode.
difficulty val Int GetDifficulty Returns difficulty level of the custom game mode.
gameFrameTime val Float GetGameFrameTime Returns the number of seconds elapsed since the last frame was renderered. This time doesn't count up when the game is paused.
gameModeEntity val BaseGameMode GetGameModeEntity Get the game mode entity.
gameTime val Float GetGameTime Returns the number of seconds elapsed since map start. This time doesn't count up when the game is paused.
matchSignoutComplete val Boolean GetMatchSignoutComplete Have we received the post match signout message that includes reward information.
neutralInitialSpawnOffset var Float GetNeutralInitialSpawnOffset / SetNeutralInitialSpawnOffset Gets the extra offset to initial neutral creep spawn delay.
nextBountyRuneSpawnTime var Float GetNextBountyRuneSpawnTime / SetNextBountyRuneSpawnTime Gets next bounty rune spawn time.
nextRuneSpawnTime var Float GetNextRuneSpawnTime / SetNextRuneSpawnTime Gets next rune spawn time.
nianTotalDamageTaken val Int GetNianTotalDamageTaken For New Bloom, get total damage taken by the Nian / Year Beast.
stateTransitionTime val Float GetStateTransitionTime Get time remaining between state changes.
timeOfDay var Float GetTimeOfDay / SetTimeOfDay Get the time of day.
weatherWindDirection var Vector GetWeatherWindDirection / SetWeatherWindDirection Get Weather Wind Direction Vector.
isCheatMode val Boolean IsCheatMode Are cheats enabled on the server.
isDaytime val Boolean IsDaytime Is it day time?
isDev val Boolean IsDev
isGamePaused val Boolean IsGamePaused Returns whether the game is paused.
isHeroRespawnEnabled var Boolean IsHeroRespawnEnabled / SetHeroRespawnEnabled Returns whether hero respawn is enabled.
isInBanPhase val Boolean IsInBanPhase Are we in the ban phase of hero pick?
isNightstalkerNight val Boolean IsNightstalkerNight Is it night stalker night-time?
isSuggestAbilitiesEnabled var Boolean IsSuggestAbilitiesEnabled / SetSuggestAbilitiesEnabled Returns whether Dota Plus ability suggestions are enabled or disabled.
isSuggestItemsEnabled var Boolean IsSuggestItemsEnabled / SetSuggestItemsEnabled Returns whether Dota Plus item suggestions are enabled or disabled.
isTemporaryNight val Boolean IsTemporaryNight Is it temporarily night-time?
shouldHideBlacklistedHeroes var Boolean ShouldHideBlacklistedHeroes / SetHideBlacklistedHeroes Are blacklisted heroes hidden, or just dimmed, in hero picking?

Methods

Method Return Type Native Name Description
addBotPlayerWithEntityScript(heroName: String, playerName: String, team: DOTATeam, entityScript: String, arg5: Boolean,) BaseNPCHero? = externalSource() AddBotPlayerWithEntityScript Spawn a bot player of the passed hero name, player name, and team.
addEventMetadataLeaderboardEntry(nameSuffix: String, stars: UInt, maxStars: UInt, extraData1: UInt, extraData2: UInt, extraData3: UInt, extraData4: UInt, extraData5: UInt, extraData6: UInt,) Boolean = externalSource() AddEventMetadataLeaderboardEntry Event-only.
addEventMetadataLeaderboardEntryRawScore(nameSuffix: String, score: UInt, extraData1: UInt, extraData2: UInt, extraData3: UInt, extraData4: UInt, extraData5: UInt, extraData6: UInt,) Boolean = externalSource() AddEventMetadataLeaderboardEntryRawScore Event-only.
getAnnouncer(team: DOTATeam) BaseNPC? = externalSource() GetAnnouncer Get the announcer for a team.
getCustomGameTeamMaxPlayers(team: DOTATeam) Int = externalSource() GetCustomGameTeamMaxPlayers Get whether a team is selectable during game setup.
getDOTATime(includePreGame: Boolean, includeNegativeTime: Boolean,) Float = externalSource() GetDOTATime Returns the actual DOTA in-game clock time.
getDroppedItem(index: Int) ItemPhysical? = externalSource() GetDroppedItem Gets the Xth dropped item.
getGameSessionConfigValue(arg1: String, arg2: String,) String = externalSource() GetGameSessionConfigValue Get a string value from the game session config (map options).
getIetmStockDuration(arg1: Int, arg2: String, arg3: Int,) Float = externalSource() GetIetmStockDuration Get the time it takes to add a new item to stock.
getItemStockCount(team: DOTATeam, itemName: String, playerId: PlayerID,) Int = externalSource() GetItemStockCount Get the stock count of the item.
getItemStockTime(team: DOTATeam, itemName: String, playerId: PlayerID,) Float = externalSource() GetItemStockTime Get the time an item will be added to stock.
getPlayerCustomGameAccountRecord(playerId: PlayerID) Any = externalSource() GetPlayerCustomGameAccountRecord Gets the player's custom game account record, as it looked at the start of this session.
isHeroEnabledViaLists(arg1: String) Boolean = externalSource() IsHeroEnabledViaLists Is the hero not blacklisted, and is it either whitelisted or the whitelist is empty?
isItemInWhiteList(itemName: String) Boolean = externalSource() IsItemInWhiteList Query an item in the whitelist.
modifyGoldFiltered(playerId: PlayerID, goldChange: Int, reliable: Boolean, reason: ModifyGoldReason,) Int = externalSource() ModifyGoldFiltered Like ModifyGold, but will use the gold filter if SetFilterMoreGold has been set true.
numDroppedItems() Int = externalSource() NumDroppedItems Returns the number of items currently dropped on the ground.
playerHasCustomGameHostPrivileges(player: PlayerController) Boolean = externalSource() PlayerHasCustomGameHostPrivileges Whether a player has custom game host privileges (shuffle teams, etc.).
scriptGetMatchID() Uint64 = externalSource() Script_GetMatchID Get the MatchID for this game.
setEventMetadataCustomTable(metadataTable: Any) Boolean = externalSource() SetEventMetadataCustomTable Event-only.
setEventSignoutCustomTable(metadataTable: Any) Boolean = externalSource() SetEventSignoutCustomTable Event-only.
setPostGameColumns(arg1: Any) Boolean = externalSource() SetPostGameColumns Set columns to show in post game.
setPostGameTeamScores(arg1: Any) Boolean = externalSource() SetPostGameTeamScores Set score value for each team. First element is for DOTA_TEAM_GOODGUYS.
stateGet() DOTAGameState = externalSource() State_Get Get the current Gamerules state.

PlayerController

Native name: CDOTAPlayerController

Extends: CBaseAnimatingActivity

Properties

Property Type Native Name Description
activeAbility val Any GetActiveAbility
assignedHero val BaseNPCHero GetAssignedHero Get the player's hero.
clickBehaviors val Any GetClickBehaviors
playerID val PlayerID GetPlayerID Get the player's official PlayerID; notably is -1 when the player isn't yet on a team.
queryUnit val Any GetQueryUnit
shouldDisplayInWorldUIElements val Boolean ShouldDisplayInWorldUIElements

Methods

Method Return Type Native Name Description
checkForCourierSpawning(hero: BaseNPCHero) Any = externalSource() CheckForCourierSpawning Attempt to spawn the appropriate couriers for this mode.
spawnCourierAtPosition(location: Vector) UnitCourier = externalSource() SpawnCourierAtPosition Spawn a courier for this player at the given position.

CDotaQuest

Native name: CDotaQuest

Extends: CBaseEntity

Methods

Method Return Type Native Name Description
getSubquest(index: Int) Any = externalSource() GetSubquest Finds a subquest from this quest by index.
getSubquestByName(name: String) Any = externalSource() GetSubquestByName Finds a subquest from this quest by name.

CDotaSubquestBase

Native name: CDotaSubquestBase

Extends: CBaseEntity


TutorialType

Native name: CDOTATutorial

Methods

Method Return Type Native Name Description
addBot(heroName: String, arg2: String, arg3: String, arg4: Boolean,) Boolean = externalSource() AddBot Add a computer controlled bot.
isItemInWhiteList(itemName: String) Boolean = externalSource() IsItemInWhiteList Is this item currently in the white list.

CDotaTutorialNPCBlocker

Native name: CDotaTutorialNPCBlocker

Extends: CBaseAnimatingOverlay


VoteSystemType

Native name: CDOTAVoteSystem


CEntities

Native name: CEntities

Properties

Property Type Native Name Description
localPlayer val PlayerController GetLocalPlayer Get the local player controller (backcompat).
localPlayerController val Any GetLocalPlayerController Get the local player controller.
localPlayerPawn val Any GetLocalPlayerPawn Get the local player pawn.

Methods

Method Return Type Native Name Description
createByClassname(className: String) CBaseEntity = externalSource() CreateByClassname Creates an entity by classname.
findAllByClassname(className: String) List<CBaseEntity> = externalSource() FindAllByClassname Finds all entities by class name. Returns an array containing all the found entities.
findAllByClassnameWithin(arg1: String, location: Vector, arg3: Float,) Any = externalSource() FindAllByClassnameWithin Find entities by class name within a radius.
findAllByModel(modelName: String) List<CBaseEntity> = externalSource() FindAllByModel Find entities by model name.
findAllByName(name: String) List<CBaseEntity> = externalSource() FindAllByName Find all entities by name. Returns an array containing all the found entities in it.
findAllByNameWithin(arg1: String, location: Vector, arg3: Float,) Any = externalSource() FindAllByNameWithin Find entities by name within a radius.
findAllByTarget(target: String) List<CBaseEntity> = externalSource() FindAllByTarget Find entities by targetname.
findAllInSphere(location: Vector, arg2: Float,) Any = externalSource() FindAllInSphere Find entities within a radius.
findByClassname(previous: CBaseEntity?, className: String,) CBaseEntity? = externalSource() FindByClassname Find entities by class name. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search.
findByClassnameNearest(arg1: String, location: Vector, arg3: Float,) Any = externalSource() FindByClassnameNearest Find entities by class name nearest to a point.
findByClassnameWithin(arg1: Any, arg2: String, location: Vector, arg4: Float,) Any = externalSource() FindByClassnameWithin Find entities by class name within a radius. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search.
findByModel(previous: CBaseEntity?, modelName: String,) CBaseEntity? = externalSource() FindByModel Find entities by model name. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search.
findByModelWithin(arg1: Any, arg2: String, location: Vector, arg4: Float,) Any = externalSource() FindByModelWithin Find entities by model name within a radius. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search.
findByName(previous: CBaseEntity?, name: String,) CBaseEntity? = externalSource() FindByName Find entities by name. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search.
findByNameNearest(arg1: String, location: Vector, arg3: Float,) Any = externalSource() FindByNameNearest Find entities by name nearest to a point.
findByNameWithin(arg1: Any, arg2: String, location: Vector, arg4: Float,) Any = externalSource() FindByNameWithin Find entities by name within a radius. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search.
findByTarget(previous: CBaseEntity?, target: String,) CBaseEntity? = externalSource() FindByTarget Find entities by targetname. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search.
findInSphere(arg1: Any, location: Vector, arg3: Float,) Any = externalSource() FindInSphere Find entities within a radius. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search.
first() CBaseEntity = externalSource() First Begin an iteration over the list of entities.
next(previous: CBaseEntity?) CBaseEntity? = externalSource() Next Continue an iteration over the list of entities, providing reference to a previously found entity.

CEntityInstance

Native name: CEntityInstance

Properties

Property Type Native Name Description
classname val String GetClassname
debugName val String GetDebugName Get the entity name w/help if not defined (i.e. classname/etc).
entityHandle val Any GetEntityHandle Get the entity as an EHANDLE.
entityIndex val EntityIndex GetEntityIndex
name val String GetName Get the entity name.
orCreatePrivateScriptScope val Any GetOrCreatePrivateScriptScope Retrieve, creating if necessary, the private per-instance script-side data associated with an entity.
orCreatePublicScriptScope val Any GetOrCreatePublicScriptScope Retrieve, creating if necessary, the public script-side data associated with an entity.
privateScriptScope val Any GetPrivateScriptScope Retrieve the private per-instance script-side data associated with an entity.
publicScriptScope val Any GetPublicScriptScope Retrieve the public script-side data associated with an entity.
isNull val Boolean IsNull Has underlying C++ entity object been deleted?

Methods

Method Return Type Native Name Description
entindex() EntityIndex = externalSource()
getIntAttr(arg1: String) Int? = externalSource() GetIntAttr Get Integer Attribute.

CEntityScriptFramework

Native name: CEntityScriptFramework


CEnvEntityMaker

Native name: CEnvEntityMaker

Extends: CBaseEntity


CFoWBlockerRegion

Native name: CFoWBlockerRegion

Extends: CBaseEntity


CInfoData

Native name: CInfoData

Extends: CBaseEntity

Methods

Method Return Type Native Name Description
queryColor(tok: String, default: Vector,) Vector = externalSource() QueryColor Query color data for this key.
queryFloat(tok: String, default: Float,) Float = externalSource() QueryFloat Query float data for this key.
queryInt(tok: String, default: Int,) Int = externalSource() QueryInt Query int data for this key.
queryNumber(tok: String, default: Float,) Float = externalSource() QueryNumber Query number data for this key.
queryString(tok: String, default: String,) String = externalSource() QueryString Query string data for this key.
queryVector(tok: String, default: Vector,) Vector = externalSource() QueryVector Query vector data for this key.

CInfoPlayerStartDota

Native name: CInfoPlayerStartDota

Extends: CPointEntity

Properties

Property Type Native Name Description
isEnabled var Boolean IsEnabled / SetEnabled Returns whether the object is currently active.

CInfoWorldLayer

Native name: CInfoWorldLayer

Extends: CBaseEntity


CLogicRelay

Native name: CLogicRelay

Extends: CBaseEntity


CLogicScript

Native name: CLogicScript

Extends: CBaseEntity


CMarkupVolumeTagged

Native name: CMarkupVolumeTagged

Extends: CBaseEntity

Methods

Method Return Type Native Name Description
hasTag(tagName: Any) Boolean = externalSource() HasTag Does this volume have the given tag.

CNativeOutputs

Native name: CNativeOutputs


ConvarsType

Native name: Convars

Properties

Property Type Native Name Description
commandClient val PlayerController GetCommandClient Returns the player who issued this console command.
dOTACommandClient val PlayerController GetDOTACommandClient Returns the DOTA player who issued this console command.

Methods

Method Return Type Native Name Description
getBool(name: String) Boolean? = externalSource() GetBool Returns the convar as a boolean flag.
getFloat(name: String) Float? = externalSource() GetFloat Returns the convar as a float. May return null if no such convar.
getInt(name: String) Int? = externalSource() GetInt Returns the convar as an int. May return null if no such convar.
getStr(name: String) String? = externalSource() GetStr Returns the convar as a string. May return null if no such convar.

CParticleSystem

Native name: CParticleSystem

Extends: CBaseModelEntity


CPhysicsProp

Native name: CPhysicsProp

Extends: CBaseAnimatingActivity


CPointClientUIWorldPanel

Native name: CPointClientUIWorldPanel

Extends: CBaseModelEntity

Properties

Property Type Native Name Description
isGrabbable val Boolean IsGrabbable Returns whether this entity is grabbable.

CPointEntity

Native name: CPointEntity

Extends: CBaseEntity


CPointTemplate

Native name: CPointTemplate

Extends: CBaseEntity

Properties

Property Type Native Name Description
spawnedEntities val Any GetSpawnedEntities Get the list of the most recent spawned entities.

CPointWorldText

Native name: CPointWorldText

Extends: CBaseModelEntity


CSceneEntity

Native name: CSceneEntity

Extends: CBaseEntity

Properties

Property Type Native Name Description
isPaused val Boolean IsPaused If this scene is currently paused.
isPlayingBack val Boolean IsPlayingBack If this scene is currently playing.

Methods

Method Return Type Native Name Description
estimateLength() Float = externalSource() EstimateLength Returns length of this scene in seconds.
findNamedEntity(arg1: String) Any = externalSource() FindNamedEntity Given an entity reference, such as !target, get actual entity from scene object.

CScriptHeroList

Native name: CScriptHeroList

Properties

Property Type Native Name Description
allHeroes val List<BaseNPCHero> GetAllHeroes Returns all the heroes in the world.
heroCount val Int GetHeroCount Returns the number of heroes in the world.

Methods

Method Return Type Native Name Description
getHero(nth: Int) BaseNPCHero? = externalSource() GetHero Get the Nth hero in the Hero List.

CScriptHTTPRequest

Native name: CScriptHTTPRequest

Note: Actual CScriptHTTPRequest global exists only after CreateHTTPRequest is called.

Methods

Method Return Type Native Name Description
setHTTPRequestAbsoluteTimeoutMS(milliseconds: UInt) Boolean = externalSource() SetHTTPRequestAbsoluteTimeoutMS Set the total timeout on the request.
setHTTPRequestGetOrPostParameter(name: String, value: String,) Boolean = externalSource() SetHTTPRequestGetOrPostParameter Set a POST or GET parameter on the request.
setHTTPRequestHeaderValue(name: String, value: String,) Boolean = externalSource() SetHTTPRequestHeaderValue Set a header value on the request.
setHTTPRequestNetworkActivityTimeout(seconds: UInt) Boolean = externalSource() SetHTTPRequestNetworkActivityTimeout Set the network timeout on the request - this timer is reset when any data is received.
setHTTPRequestRawPostBody(contentType: String, body: String,) Boolean = externalSource() SetHTTPRequestRawPostBody Set the literal body of a post - invalid after setting a post parameter.

CScriptKeyValues

Native name: CScriptKeyValues

Methods

Method Return Type Native Name Description
getValue(arg1: String) Any = externalSource() GetValue Reads a spawn key.

CScriptParticleManager

Native name: CScriptParticleManager

Methods

Method Return Type Native Name Description
createParticle(particleName: String, particleAttach: ParticleAttachment, owner: CBaseEntity?,) ParticleID = externalSource() CreateParticle Creates a new particle effect.
createParticleForPlayer(particleName: String, particleAttach: ParticleAttachment, owner: CBaseEntity?, player: PlayerController,) ParticleID = externalSource() CreateParticleForPlayer Creates a new particle effect that only plays for the specified player.
createParticleForTeam(particleName: String, particleAttach: ParticleAttachment, owner: CBaseEntity?, team: DOTATeam,) ParticleID = externalSource() CreateParticleForTeam Creates a new particle effect that only plays for the specified team.
getParticleReplacement(particleName: String, hero: BaseNPCHero?,) String = externalSource() GetParticleReplacement
setParticleShouldCheckFoW(particle: ParticleID, checkFoW: Boolean,) Boolean = externalSource() SetParticleShouldCheckFoW

CScriptPrecacheContext

Native name: CScriptPrecacheContext

Methods

Method Return Type Native Name Description
getValue(key: String) Any = externalSource() GetValue Reads a spawn key.

CScriptUniformRandomStream

Native name: CScriptUniformRandomStream

Methods

Method Return Type Native Name Description
randomFloat(minVal: Float, maxVal: Float,) Float = externalSource() RandomFloat
randomFloatExp(minVal: Float, maxVal: Float, exponent: Float,) Float = externalSource() RandomFloatExp
randomInt(minVal: Int, maxVal: Int,) Int = externalSource() RandomInt
rollPercentage(percentage: Int) Boolean = externalSource() RollPercentage

CTakeDamageInfo

Native name: CTakeDamageInfo

Properties

Property Type Native Name Description
ammoType var Int GetAmmoType / SetAmmoType
attacker var Any GetAttacker / SetAttacker
damage var Float GetDamage / SetDamage
damageCustom var Int GetDamageCustom / SetDamageCustom
damageForce var Vector GetDamageForce / SetDamageForce
damagePosition var Vector GetDamagePosition / SetDamagePosition
damageType var DamageTypes GetDamageType / SetDamageType
inflictor val Any GetInflictor
originalDamage var Float GetOriginalDamage / SetOriginalDamage
reportedPosition var Vector GetReportedPosition / SetReportedPosition
totalledDamage val Float GetTotalledDamage

Methods

Method Return Type Native Name Description
hasDamageType(damageType: Int) Boolean = externalSource() HasDamageType

GlobalSysType

Native name: GlobalSys

Methods

Method Return Type Native Name Description
commandLineCheck(name: String) Any = externalSource() CommandLineCheck Returns true if the command line param was used, otherwise false.
commandLineFloat(arg1: String, arg2: Float,) Any = externalSource() CommandLineFloat Returns the command line param as a float.
commandLineInt(arg1: String, arg2: Int,) Any = externalSource() CommandLineInt Returns the command line param as an int.
commandLineStr(arg1: String, arg2: String,) Any = externalSource() CommandLineStr Returns the command line param as a string.

GridNavType

Native name: GridNav

Methods

Method Return Type Native Name Description
canFindPath(start: Vector, end: Vector,) Boolean = externalSource() CanFindPath Determine if it is possible to reach the specified end point from the specified start point. bool.
findPathLength(start: Vector, end: Vector,) Float = externalSource() FindPathLength Find a path between the two points an return the length of the path. If there is not a path between the points the returned value will be -1.
getAllTreesAroundPoint(position: Vector, radius: Float, fullCollision: Boolean,) List<MapTree> = externalSource() GetAllTreesAroundPoint Returns a table full of tree HSCRIPTS.
gridPosToWorldCenterX(arg1: Int) Float = externalSource() GridPosToWorldCenterX Get the X position of the center of a given X index.
gridPosToWorldCenterY(arg1: Int) Float = externalSource() GridPosToWorldCenterY Get the Y position of the center of a given Y index.
isBlocked(arg1: Vector) Boolean = externalSource() IsBlocked Checks whether the given position is blocked.
isNearbyTree(position: Vector, radius: Float, checkFullTreeRadius: Boolean,) Boolean = externalSource() IsNearbyTree Checks whether there are any trees overlapping the given point.
isTraversable(arg1: Vector) Boolean = externalSource() IsTraversable Checks whether the given position is traversable.
worldToGridPosX(arg1: Float) Int = externalSource() WorldToGridPosX Get the X index of a given world X position.
worldToGridPosY(arg1: Float) Int = externalSource() WorldToGridPosY Get the Y index of a given world Y position.

ProjectileManagerType

Native name: ProjectileManager

Methods

Method Return Type Native Name Description
createLinearProjectile(options: CreateLinearProjectileOptions) ProjectileID = externalSource() CreateLinearProjectile Creates a linear projectile and returns the projectile ID.
createTrackingProjectile(options: CreateTrackingProjectileOptions) ProjectileID = externalSource() CreateTrackingProjectile Creates a tracking projectile.
getLinearProjectileLocation(projectile: ProjectileID) Vector = externalSource() GetLinearProjectileLocation Returns current location of projectile.
getLinearProjectileRadius(projectile: ProjectileID) Float = externalSource() GetLinearProjectileRadius Returns current radius of projectile.
getLinearProjectileVelocity(projectile: ProjectileID) Vector = externalSource() GetLinearProjectileVelocity Returns a vector representing the current velocity of the projectile.
getTrackingProjectileLocation(projectile: ProjectileID) Vector = externalSource() GetTrackingProjectileLocation Returns current location of projectile.
isValidProjectile(value: Int) Boolean = externalSource() IsValidProjectile Is this a valid projectile?

Global

Global VScripts functions

Methods

Method Return Type Native Name Description
eq(b: QAngle) Boolean = externalSource() __eq Overloaded ==. Tests for Equality.
tostring() String = externalSource() __tostring Overloaded .. Converts the QAngles to strings.
forward() Vector = externalSource() Forward Returns the forward vector.
left() Vector = externalSource() Left Returns the left vector.
up() Vector = externalSource() Up Returns the up vector.
eq(b: Vector) Boolean = externalSource() __eq Overloaded ==. Tests for Equality.
len() Float = externalSource() __len Overloaded # returns the length of the vector.
tostring() String = externalSource() __tostring Overloaded .. Converts vectors to strings.
cross(b: Vector) Vector = externalSource() Cross Cross product of two vectors.
dot(b: Vector) Float = externalSource() Dot Dot product of two vectors.
length() Float = externalSource() Length Length of the Vector.
length2D() Float = externalSource() Length2D Length of the Vector in the XY plane.
normalized() Vector = externalSource() Normalized Returns the vector normalized.
anglesToVector(arg1: QAngle) Vector AnglesToVector Generate a vector given a QAngles.
applyDamage(options: ApplyDamageOptions) Float ApplyDamage Damage an npc.
cancelEntityIOEvents(arg1: Any) Unit CancelEntityIOEvents Create all I/O events for a particular entity.
clearTeamCustomHealthbarColor(team: DOTATeam) Unit ClearTeamCustomHealthbarColor
createEffect(arg1: Any) Boolean CreateEffect Pass table - Inputs: entity, effect.
createSceneEntity(arg1: String) CBaseAnimatingActivity CreateSceneEntity Create a scene entity to play the specified scene.
createUniformRandomStream(seed: Int) CScriptUniformRandomStream CreateUniformRandomStream Creates a separate random number stream.
cvarGetf(arg1: String) Float cvar_getf Gets the value of the given cvar, as a float.
debugBreak() Unit DebugBreak Breaks in the debugger.
debugChangeTeam(arg1: Any) Unit DebugChangeTeam Changes the team of the hero.
debugDrawClear() Unit DebugDrawClear Try to clear all the debug overlay info.
deepPrintTable(table: Any?) Unit DeepPrintTable Print out a table (and subtables) to the console.
destroyDamageInfo(damageInfo: CTakeDamageInfo) Unit DestroyDamageInfo Free a damageinfo object that was created with CreateDamageInfo().
doUniqueString(seed: String) String DoUniqueString Generate a string guaranteed to be unique across the life of the script VM, with an optional root string. Useful for adding data to tables when not sure what keys are already in use in that table.
emitAnnouncerSound(soundName: String) Unit EmitAnnouncerSound Emit an announcer sound for all players.
emitGlobalSound(soundName: String) Unit EmitGlobalSound Play named sound for all players.
entIndexToHScript(entityIndex: EntityIndex) CBaseEntity? EntIndexToHScript Turn an entity index integer to an HScript representing that entity's script instance.
executeOrderFromTable(order: ExecuteOrderOptions) Unit ExecuteOrderFromTable Issue an order from a script table.
findSpawnEntityForTeam(team: DOTATeam) CBaseEntity? FindSpawnEntityForTeam Find a spawn point for the given team.
frameTime() Float FrameTime Get the time spent on the server in the last frame.
getAbilityKeyValuesByName(arg1: String) Any GetAbilityKeyValuesByName Get ability data by ability name.
getAbilityTextureNameForAbility(abilityName: String) String GetAbilityTextureNameForAbility Gets the ability texture name for an ability.
getDedicatedServerKey(version: String) String GetDedicatedServerKey
getDedicatedServerKeyV2(version: String) String GetDedicatedServerKeyV2
getDedicatedServerKeyV3(version: String) String GetDedicatedServerKeyV3
getEntityIndexForTreeId(treeId: UInt) EntityIndex GetEntityIndexForTreeId Get the enity index for a tree id specified as the entindex_target of a DOTA_UNIT_ORDER_CAST_TARGET_TREE.
getItemCost(arg1: String) Int GetItemCost Get the cost of an item by name.
getLocalPlayerTeam(arg1: Int) DOTATeam GetLocalPlayerTeam Get the local player team.
getPhysAngularVelocity(arg1: Any) Vector GetPhysAngularVelocity Get Angular Velocity for VPHYS or normal object. Returns a vector of the axis of rotation, multiplied by the degrees of rotation per second.
getPhysVelocity(arg1: Any) Vector GetPhysVelocity Get Velocity for VPHYS or normal object.
getTeamHeroKills(team: DOTATeam) Int GetTeamHeroKills
getTeamName(team: DOTATeam) String GetTeamName
getTreeIdForEntityIndex(entityIndex: EntityIndex) Int GetTreeIdForEntityIndex Given and entity index of a tree, get the tree id for use for use with with unit orders.
getUnitKeyValuesByName(arg1: String) Any GetUnitKeyValuesByName Get unit data by ability name.
getXPNeededToReachNextLevel(level: Int) Int GetXPNeededToReachNextLevel Get amount of XP required to reach the next level.
heroMaxLevel(arg1: Any) Unit HeroMaxLevel Max out a hero's level and give them all appropriate abilities and talents.
isMangoTree(entity: CBaseEntity) Boolean IsMangoTree Is this entity a mango tree? (hEntity).
isMarkedForDeletion(entity: CBaseEntity) Boolean IsMarkedForDeletion Returns true if the entity is valid and marked for deletion.
isUnitInValidPosition(unit: CBaseEntity) Boolean IsUnitInValidPosition Returns true if the unit is in a valid position in the gridnav.
limitPathingSearchDepth(arg1: Float) Unit LimitPathingSearchDepth Set the limit on the pathfinding search space.
loadKeyValues(filePath: String) Any LoadKeyValues Creates a table from the specified keyvalues text file.
loadKeyValuesFromString(kvString: String) Any LoadKeyValuesFromString Creates a table from the specified keyvalues string.
localTime() LocalTime LocalTime Get the current local time.
makeStringToken(arg1: String) Int MakeStringToken Checks to see if the given hScript is a valid entity.
manuallyTriggerSpawnGroupCompletion(handle: SpawnGroupHandle) Unit ManuallyTriggerSpawnGroupCompletion Triggers the creation of entities in a manually-completed spawn group.
msg(message: String) Unit Msg Print a message.
pauseGame(paused: Boolean) Unit PauseGame Pause or unpause the game.
platFloatTime() Float Plat_FloatTime Get the current float time from the engine.
playerInstanceFromIndex(entityIndex: EntityIndex) PlayerController? PlayerInstanceFromIndex Get a script instance of a player by index.
randomVector(length: Float) Vector RandomVector Get a random 2D vector of the given length.
registerSpawnGroupFilterProxy(arg1: String) Unit RegisterSpawnGroupFilterProxy Create a C proxy for a script-based spawn group filter.
reloadMOTD() Unit ReloadMOTD Reloads the MotD file.
removeSpawnGroupFilterProxy(arg1: String) Unit RemoveSpawnGroupFilterProxy Remove the C proxy for a script-based spawn group filter.
rollPercentage(successPercentage: Int) Boolean RollPercentage Rolls a number from 1 to 100 and returns true if the roll is less than or equal to the number specified.
sendToConsole(arg1: String) Unit SendToConsole Send a string to the console as a client command.
sendToServerConsole(arg1: String) Unit SendToServerConsole Send a string to the console as a server command.
setQuestName(arg1: String) Unit SetQuestName Set the current quest name.
setQuestPhase(arg1: Int) Unit SetQuestPhase Set the current quest phase.
showMessage(arg1: String) Unit ShowMessage Print a hud message on all clients.
spawnEntityListFromTableSynchronous(arg1: Any) Any SpawnEntityListFromTableSynchronous Synchronously spawn an entity group from a list of spawn tables.
stopGlobalSound(arg1: String) Unit StopGlobalSound Stop named sound for all players.
stopListeningToAllGameEvents(arg1: Any) Unit StopListeningToAllGameEvents Stop listening to all game events within a specific context.
stopListeningToGameEvent(listenerId: EventListenerID) Boolean StopListeningToGameEvent Stop listening to a particular game event.
time() Float Time Get the current server time.
traceCollideable(query: TraceCollideableInputs) Boolean TraceCollideable
traceHull(query: TraceHullInputs) Boolean TraceHull
traceLine(query: TraceLineInputs) Boolean TraceLine
unloadSpawnGroup(arg1: String) Unit UnloadSpawnGroup Unload a spawn group by name.
unloadSpawnGroupByHandle(handle: SpawnGroupHandle) Unit UnloadSpawnGroupByHandle Unload a spawn group by handle.
updateEventPoints(eventPointData: Any) Unit UpdateEventPoints
userIDToControllerHScript(arg1: Int) Any UserIDToControllerHScript Turn a userid integer (typically, fields named 'userid' in game events) to an HScript representing the associated player controller's script instance.
utilRemove(entity: CBaseEntity?) Unit UTIL_Remove Removes the specified entity.
utilRemoveImmediate(entity: CBaseEntity?) Unit UTIL_RemoveImmediate Immediately removes the specified entity.
utilResetMessageText(arg1: Int) Unit UTIL_ResetMessageText Clear all message text on one client.
utilResetMessageTextAll() Unit UTIL_ResetMessageTextAll Clear all message text from all clients.
vectorAngles(arg1: Vector) QAngle VectorAngles
vectorToAngles(arg1: Vector) QAngle VectorToAngles Get Qangles (with no roll) for a Vector.
warning(message: String) Unit Warning Print a warning.

SteamInfoType

Native name: SteamInfo

Properties

Property Type Native Name Description
isPublicUniverse val Boolean IsPublicUniverse Is the script connected to the public Steam universe.

Uint64

Native name: Uint64

Integer with binary operations.

Methods

Method Return Type Native Name Description
eq(b: Uint64) Boolean = externalSource() __eq
tostring() String = externalSource() __tostring Overloaded .. Converts Uint64s to strings.
bitwiseAnd(operand: Uint64) Uint64 = externalSource() BitwiseAnd Performs bitwise AND between two integers.
bitwiseOr(operand: Uint64) Uint64 = externalSource() BitwiseOr Performs bitwise OR between two integers.
bitwiseXor(operand: Uint64) Uint64 = externalSource() BitwiseXor Performs bitwise XOR between two integers.
bitwiseNot() Uint64 = externalSource() BitwiseNot Performs bitwise NOT.
clearBit(bitvalue: Int) Int = externalSource() ClearBit Clears the specified bit.
isBitSet(bitvalue: Int) Int? = externalSource() IsBitSet Checks if bit is set.
toggleBit(bitvalue: Int) Int = externalSource() ToggleBit Toggles the specified bit.
toHexString() String = externalSource() ToHexString Returns a hexadecimal string representation of the integer.

Global

Global VScripts functions

Methods

Method Return Type Native Name Description
isValidEntity(entity: Any?) Boolean { IsValidEntity Checks to see if the given hScript is a valid entity.
linkAllModifiers() Unit = externalSource() ktox_link_all_modifiers Runs every @Dota2Class modifier file's LinkLuaModifier registration by loading the build-generated manifest (ktox_modifiers_manifest.lua — the same list the generated client entry loads). The build appends this to the server entry automatically; no addon code needs to call it. (ktox_link_all_modifiers, ktox_dota.lua runtime; a modifier-less build is a no-op.)

GameEvent


PanoramaEvent