NPC
Table to work with NPC.
NPC.NPC extands Entity
GetOwnerNPC(npc: NPC): NPC | nil
NPC): NPC | nilnpc
NPC
npc to get owner from
Returns owner of the NPC. Works for spirit bear.
GetItem(npc: NPC, name: string, isReal [?]: boolean): Item | nil
NPC, name: string, isReal [?]: boolean): Item | nilnpc
NPC
npc to get item from
name
string
name of the item
isReal [?]
boolean
if true, returns only 1-6 slots and neutral item, otherwise returns all items (including backpack and stash) (default: true)
Returns Item by name.
HasItem(npc: NPC, name: string, isReal [?]: boolean): boolean
NPC, name: string, isReal [?]: boolean): booleannpc
NPC
npc to check
name
string
name of the item
isReal [?]
boolean
if true, returns only 1-6 slots and neutral item, otherwise returns all items (including backpack and stash) (default: true)
Returns true if the NPC has item with specified name.
HasModifier(npc: NPC, name: string): boolean
NPC, name: string): booleannpc
NPC
npc to check
name
string
name of the modifier
Returns true if the NPC has modifier with specified name.
GetModifier(npc: NPC, name: string): Modifier | nil
NPC, name: string): Modifier | nilnpc
NPC
npc to get modifier from
name
string
name of the modifier
Returns Modifier by name.
GetModifiers(npc: NPC, poperty_filter [?]: Enum.ModifierFunction): table
NPC, poperty_filter [?]: Enum.ModifierFunction): tablenpc
NPC
npc to get modifiers from
poperty_filter [?]
Enum.ModifierFunction
Filter modifiers by specified property
Returns 1-based indexed table of all NPC's Modifiers.
HasInventorySlotFree(npc: NPC, isReal [?]: boolean): boolean
NPC, isReal [?]: boolean): booleannpc
NPC
npc to check
isReal [?]
boolean
if true, returns only 1-6 slots and neutral item, otherwise returns all items (including backpack and stash) (default: true)
Returns true if the NPC has free inventory slot.
HasState(npc: NPC, state: Enum.ModifierState): boolean
NPC, state: Enum.ModifierState): booleannpc
NPC
npc to check
state
Enum.ModifierState
state to check
Returns true if the NPC has state. The best way to check if the NPC is stunned, silenced, hexed, has BKB immune etc.
IsWaitingToSpawn(npc: NPC): boolean
NPC): booleannpc
NPC
npc to check
Returns true if waiting to spawn. For example, creeps are waiting to spawn under the ground near the barracks.
IsIllusion(npc: NPC): boolean
NPC): booleannpc
NPC
npc to check
Returns true if the NPC is illusion.
IsVisible(npc: NPC): boolean
NPC): booleannpc
NPC
npc to check
Returns true if the NPC is visible to local player.
IsCourier(npc: NPC): boolean
NPC): booleannpc
NPC
npc to check
Returns true if the NPC is a courier.
IsRanged(npc: NPC): boolean
NPC): booleannpc
NPC
npc to check
Returns true if the NPC is a ranged unit.
IsCreep(npc: NPC): boolean
NPC): booleannpc
NPC
npc to check
Returns true if the NPC is a creep.
IsLaneCreep(npc: NPC): boolean
NPC): booleannpc
NPC
npc to check
Returns true if the NPC is a lane creep.
IsStructure(npc: NPC): boolean
NPC): booleannpc
NPC
npc to check
Returns true if the NPC is a structure.
IsTower(npc: NPC): boolean
NPC): booleannpc
NPC
npc to check
Returns true if the NPC is a tower.
IsBarracks(npc: NPC): boolean
NPC): booleannpc
NPC
npc to check
Returns true if the NPC is a barracks.
IsAncient(npc: NPC): boolean
NPC): booleannpc
NPC
npc to check
Returns true if the NPC is an ancient creeps.
IsRoshan(npc: NPC): boolean
NPC): booleannpc
NPC
npc to check
Returns true if the NPC is a Roshan.
IsNeutral(npc: NPC): boolean
NPC): booleannpc
NPC
npc to check
Returns true if the NPC is a neutral. Neutral creeps, ancient creeps.
IsHero(npc: NPC): boolean
NPC): booleannpc
NPC
npc to check
Returns true if the NPC is a hero.
IsWard(npc: NPC): boolean
NPC): booleannpc
NPC
npc to check
Returns true if the NPC is a ward.
IsMeepoClone(npc: NPC): boolean
NPC): booleannpc
NPC
npc to check
Returns true if the NPC is a meepo clone.
IsEntityInRange(npc: NPC, npc2: NPC, range: number): boolean
NPC, npc2: NPC, range: number): booleannpc
NPC
npc to check
npc2
NPC
npc to check
range
number
range to check
Returns true if the NPC in range of other NPC.
IsPositionInRange(npc: NPC, pos: Vector3, range: number, hull: number): boolean
NPC, pos: Vector3, range: number, hull: number): booleannpc
NPC
npc to check
pos
Vector3
position to check
range
number
range to check
hull
number
hull just added to range
Returns true if the NPC in range of position.
IsLinkensProtected(npc: NPC): boolean
NPC): booleannpc
NPC
npc to check
Returns true if the NPC is protected by Linkens Sphere.
IsMirrorProtected(npc: NPC): boolean
NPC): booleannpc
NPC
npc to check
Returns true if the NPC is protected by Mirror Shield.
IsChannellingAbility(npc: NPC): boolean
NPC): booleannpc
NPC
npc to check
Returns true if the NPC is channeling ability. Black Hole, Life Drain, etc.
GetChannellingAbility(npc: NPC): Ability | nil
NPC): Ability | nilnpc
NPC
target npc
Returns the currently channelling Ability.
IsRunning(npc: NPC): boolean
NPC): booleannpc
NPC
target npc
Returns true if the NPC is running.
IsAttacking(npc: NPC): boolean
NPC): booleannpc
NPC
target npc
Returns true if the NPC is attacking.
IsSilenced(npc: NPC): boolean
NPC): booleannpc
NPC
target npc
Returns true if the NPC is silenced.
IsStunned(npc: NPC): boolean
NPC): booleannpc
NPC
target npc
Returns true if the NPC is stunned.
HasAegis(npc: NPC): boolean
NPC): booleannpc
NPC
target npc
Returns true if the NPC has aegis.
IsKillable(npc: NPC): boolean
NPC): booleannpc
NPC
target npc
Returns true if the NPC has killable. Example: false if affected by Eul.
GetActivity(npc: NPC): Enum.GameActivity
NPC): Enum.GameActivitynpc
NPC
target npc
Returns the NPC activity, such as running, attacking, casting, etc.
GetAnimationInfo(npc: NPC): table
NPC): tablenpc
NPC
target npc
Returns information about the current animation of the NPC.
GetAttackRange(npc: NPC): integer
NPC): integernpc
NPC
target npc
Returns the base attack range of the NPC.
GetAttackRangeBonus(npc: NPC): integer
NPC): integernpc
NPC
target npc
Returns the bonus attack range of the NPC.
GetCastRangeBonus(npc: NPC): integer
NPC): integernpc
NPC
target npc
Returns the bonus cast range of the NPC.
GetPhysicalArmorValue(npc: NPC): number
NPC): numbernpc
NPC
target npc
Returns the physical armor value of the NPC.
GetPhysicalDamageReduction(npc: NPC): number
NPC): numbernpc
NPC
target npc
Returns the physical damage reduction value of the NPC.
GetArmorDamageMultiplier(npc: NPC): number
NPC): numbernpc
NPC
target npc
Returns the physical damage multiplier value of the NPC.
GetMagicalArmorValue(npc: NPC): number
NPC): numbernpc
NPC
target npc
Returns the magical armor value of the NPC.
GetMagicalArmorDamageMultiplier(npc: NPC): number
NPC): numbernpc
NPC
target npc
Returns the magical damage multiplier value of the NPC.
GetIncreasedAttackSpeed(npc: NPC): number
NPC): numbernpc
NPC
target npc
Returns increased attack speed of the NPC.
GetAttacksPerSecond(npc: NPC): number
NPC): numbernpc
NPC
target npc
Returns the number of attacks per second that the NPC can deal.
GetAttackTime(npc: NPC): number
NPC): numbernpc
NPC
target npc
Returns the amount of time needed for the NPC to perform an attack.
GetAttackSpeed(npc: NPC): number
NPC): numbernpc
NPC
target npc
Returns the attack speed of the NPC.
GetBaseAttackSpeed(npc: NPC): number
NPC): numbernpc
NPC
target npc
Returns the base attack speed of the NPC.
GetHullRadius(npc: NPC): number
NPC): numbernpc
NPC
target npc
Returns the model interaction radius of the NPC.
GetProjectileCollisionSize(npc: NPC): number
NPC): numbernpc
NPC
target npc
Returns the collision size of the NPC. Collision size is the internal size that prevents other units from passing through.
GetTurnRate(npc: NPC): number
NPC): numbernpc
NPC
target npc
Returns the turn rate, which is the speed at which the NPC can turn.
GetAttackAnimPoint(npc: NPC): number
NPC): numbernpc
NPC
target npc
Returns the attack animation point, nil if not found.
GetAttackProjectileSpeed(npc: NPC): integer
NPC): integernpc
NPC
target npc
Returns the attack projectile speed, nil if not found.
IsTurning(npc: NPC): boolean
NPC): booleannpc
NPC
target npc
Returns true if the NPC is turning.
GetAngleDiff(npc: NPC): integer
NPC): integernpc
NPC
target npc
Returns the remaining degree angle needed to complete the turn of the NPC.
GetPhysicalArmorMainValue(npc: NPC): number
NPC): numbernpc
NPC
target npc
Returns the (main) white armor of the NPC.
GetTimeToFace(npc: NPC, npc: NPC): number
NPC, npc: NPC): numbernpc
NPC
source npc
npc
NPC
target npc
Returns the amount of time needed for the source NPC to face the target NPC.
FindRotationAngle(npc: NPC): number
NPC): numbernpc
NPC
source npc
Returns the rotation angle of the NPC.
GetTimeToFacePosition(npc: NPC, pos: Vector3): number
NPC, pos: Vector3): numbernpc
NPC
source npc
pos
Vector3
target position
Returns the amount of time needed for the source NPC to face a specific position.
FindFacingNPC(npc: NPC, npc: NPC, team_type [?]: Enum.TeamType): NPC | nil
NPC, npc: NPC, team_type [?]: Enum.TeamType): NPC | nilnpc
NPC
source npc
npc
NPC
ignore npc
team_type [?]
Enum.TeamType
team type (default: TEAM_BOTH)
Returns the NPC that the source NPC is currently facing.
GetBaseSpeed(npc: NPC): integer
NPC): integernpc
NPC
target npc
Returns the base move speed of the NPC.
GetMoveSpeed(npc: NPC): number
NPC): numbernpc
NPC
target npc
Returns the move speed of the NPC.
GetMinDamage(npc: NPC): number
NPC): numbernpc
NPC
target npc
Returns the minumum attack damage of the NPC.
GetBonusDamage(npc: NPC): number
NPC): numbernpc
NPC
target npc
Returns the bonus attack damage of the NPC.
GetTrueDamage(npc: NPC): number
NPC): numbernpc
NPC
target npc
Returns the minumum attack damage + bonus damage of the NPC.
GetTrueMaximumDamage(npc: NPC): number
NPC): numbernpc
NPC
target npc
Returns the maximum attack damage + bonus damage of the NPC.
GetItemByIndex(npc: NPC, index: integer): Item | nil
NPC, index: integer): Item | nilnpc
NPC
target npc
index
integer
item index
Returns the Item by index.
GetAbilityByIndex(npc: NPC, index: integer): Ability | nil
NPC, index: integer): Ability | nilnpc
NPC
target npc
index
integer
ability index
Returns the Ability by index.
GetAbilityByActivity(npc: NPC, activity: Enum.GameActivity): Ability | nil
NPC, activity: Enum.GameActivity): Ability | nilnpc
NPC
npc to get ability from
activity
Enum.GameActivity
game activity
Returns the Ability by game activity.
GetAbilityByIndex(npc: NPC, name: string): Ability | nil
NPC, name: string): Ability | nilnpc
NPC
target npc
name
string
ability name
Returns the Ability by name.
HasAbility(npc: NPC, name: string): boolean
NPC, name: string): booleannpc
NPC
target npc
name
string
ability name
Returns true if the NPC has this ability.
GetMana(npc: NPC): number
NPC): numbernpc
NPC
target npc
Returns the current mana of the NPC.
GetMaxMana(npc: NPC): number
NPC): numbernpc
NPC
target npc
Returns the maximum mana of the NPC.
GetManaRegen(npc: NPC): number
NPC): numbernpc
NPC
target npc
Returns the mana regeneration rate of the NPC.
GetHealthRegen(npc: NPC): number
NPC): numbernpc
NPC
target npc
Returns the health regeneration rate of the NPC.
GetCurrentLevel(npc: NPC): number
NPC): numbernpc
NPC
target npc
Returns the current level of the NPC.
GetDayTimeVisionRange(npc: NPC): integer
NPC): integernpc
NPC
target npc
Returns the day-time vision range of the NPC.
GetNightTimeVisionRange(npc: NPC): integer
NPC): integernpc
NPC
target npc
Returns the night-time vision range of the NPC.
GetUnitName(npc: NPC): string
NPC): stringnpc
NPC
target npc
Returns the unit-name of the NPC.
GetHealthBarOffset(npc: NPC): integer
NPC): integernpc
NPC
target npc
Returns the health bar offset of the NPC.
GetUnitNameIndex(npc: NPC): integer
NPC): integernpc
NPC
target npc
Returns unit-name index of the NPC.
GetAttachmentByIndex(npc: NPC): Vector3
NPC): Vector3npc
NPC
target npc
Returns the attachment position of the NPC by the specified index.
GetBountyXP(npc: NPC): integer
NPC): integernpc
NPC
target npc
Returns the amount of experience points (XP) you can earn for killing the NPC.
GetGoldBountyMin(npc: NPC): integer
NPC): integernpc
NPC
target npc
Returns the minimum amount gold you can earn for killing the NPC.
GetGoldBountyMax(npc: NPC): integer
NPC): integernpc
NPC
target npc
Returns the maximum amount gold you can earn for killing the NPC.
MoveTo(npc: NPC, position: Vector3, queue [?]: boolean, show [?]: boolean, callback [?]: boolean, executeFast [?]: boolean): void
NPC, position: Vector3, queue [?]: boolean, show [?]: boolean, callback [?]: boolean, executeFast [?]: boolean): voidnpc
NPC
The target NPC.
position
Vector3
The destination position.
queue [?]
boolean
= false] Add the order to the Dota queue.
show [?]
boolean
= false] Show the order position.
callback [?]
boolean
= false] Push the order to the OnPrepareUnitOrders callback.
executeFast [?]
boolean
= false] Place the order at the top of the queue.
Initiates an order for the NPC to move to a specified position.
MoveTo(npc: NPC, z: number): void
NPC, z: number): voidnpc
NPC
The target NPC.
z
number
Z pos
Sets the Z position of the NPC model.
HasScepter(npc: NPC): boolean
NPC): booleannpc
NPC
The target NPC.
Returns true if the NPC has or consumed Aghanim Scepter.
HasShard(npc: NPC): boolean
NPC): booleannpc
NPC
The target NPC.
Returns true if the NPC has or consumed Aghanim Shard.
GetBarriers(npc: NPC): table
NPC): tablenpc
NPC
The target NPC.
Returns a table with information about the barriers of the NPC.
GetGlow(npc: NPC): table
NPC): tablenpc
NPC
The target NPC.
Returns a table with information about the current glow effect of the NPC.
SetGlow(npc: NPC, suppress_glow: boolean, flashing: boolean, glowing: boolean, glow_type: integer, r: integer, g: integer, b: integer): void
NPC, suppress_glow: boolean, flashing: boolean, glowing: boolean, glow_type: integer, r: integer, g: integer, b: integer): voidnpc
NPC
The target NPC.
suppress_glow
boolean
suppress_glow
flashing
boolean
flashing
glowing
boolean
glowing
glow_type
integer
glow type
r
integer
r factor
g
integer
g factor
b
integer
b factor
Sets the NPC glow effect.
SetColor(npc: NPC, r: integer, g: integer, b: integer): void
NPC, r: integer, g: integer, b: integer): voidnpc
NPC
The target NPC.
r
integer
r factor
g
integer
g factor
b
integer
b factor
Sets the NPC model color.
IsInRangeOfShop(npc: NPC): boolean
NPC): booleannpc
NPC
The target NPC.
Checks if the NPC is in range of a shop.
GetBaseSpellAmp(npc: NPC): number
NPC): numbernpc
NPC
The target NPC.
Returns the base spell amplification of the NPC.
GetModifierProperty(npc: NPC, property: Enum.ModifierFunction): number
NPC, property: Enum.ModifierFunction): numbernpc
NPC
The target NPC.
property
Enum.ModifierFunction
Property enum.
Returns the property value for the NPC.
GetModifierPropertyHighest(npc: NPC, property: Enum.ModifierFunction): number
NPC, property: Enum.ModifierFunction): numbernpc
NPC
The target NPC.
property
Enum.ModifierFunction
Property enum.
Returns the hieghest property value for the NPC.
Last updated