AbilityHolder extends Unit

The Unit that holds the Ability.

Used in script callbacks to have access to extra methods and properties.

Summary

Properties

Inherited Properties from Unit

• position Read only vector

  The current position of the unit. […]

• family Read only Family?

  The Family of the unit. […]

• team Read only Team

  The Team this unit belongs to. […]

• source Read only Entity?

  The Entity that spawned this unit. […]

• corpse_on_die boolean

  Whether the unit should leave a corpse when it dies. […]

Methods

• play_animation (animation: string)

  Plays an animation on the unit that overrides the unit's current animation. […]

Inherited Methods from Unit

• find_targets_in_range (find_targets: FindTargets) → { Unit }

  Find targets within a given radius of this unit. […]

• add_excluded (excluded: Unit)

  Excludes the excluded unit from this unit's UnitInRange and find_targets_in_range results. […]

• remove_excluded (excluded: Unit)

  Allows the excluded unit to be included in this unit's UnitInRange and find_targets_in_range results again. […]

• get_stat (stat: Stat, ...: Adjective) → number

  Get the current value of a Stat for this unit, after applying any active buffs. […]

• buff (buff: StatBuffDefinition)

  Applies a buff to this unit. […]

• buff_health (buff: HealthBuffDefinition)

  Applies a buff to the health of this unit. […]

• remove_buffs_from (owner: Entity)

  Removes all buffs from this unit that were granted by the given owner. […]

• damage (damage: number, adjectives: Adjective | { Adjective }, source: Entity?, cause: Entity?)

  Damages this unit. […]

• die (source: Entity?, cause: Entity?)

  Instantly kills this unit. […]

• heal (amount: number, source: Entity?, cause: Entity?)

  Heals this unit. […]

• get_ability (ability: string) → Ability?

  Gets a unique ability from this unit by an ability ID. […]

• insert_ability (ability: string, source: Entity?) → Ability

  Adds a unique ability to this unit, by ID. […]

• add_ability (ability: string, source: Entity?) → Ability

  Unconditionally adds an ability to this unit. […]

• get_or_insert_ability (ability: string, source: Entity?) → Ability

  Gets a unique ability from this unit by an ability ID, if present. […]

• stack_ability (ability: string, stack: number, source: Entity?) → Ability

  Convenience method that gets or inserts an ability to this unit, and automatically sets (if newly added) or increments (if already inserted) its [Ability. […]

• remove_abilities_from (owner: Entity)

  Removes all abilities from this unit that were granted by the given owner. […]

• set_steering (...: SteeringBehavior)

Inherited Methods from Entity

• despawn ()

  Despawns this entity. […]

• is_ability () → boolean

  Whether this entity is an Ability. […]

• as_ability () → Ability?

  Typecasts this entity to an Ability, if possible. […]

• to_ability () → Ability

  Forces this entity into an Ability type. […]

• is_unit () → boolean

  Whether this entity is a Unit. […]

• as_unit () → Unit?

  Typecasts this entity to a Unit, if possible. […]

• to_unit () → Unit

  Forces this entity into a Unit type. […]

Methods

play_animation

AbilityHolder:play_animation(animation: string)

Plays an animation on the unit that overrides the unit's current animation.

Plays an animation on the unit that overrides the unit's current animation.

Parameters

• animation Required string

  The name of the animation to play, as defined in the unit's definition.