Melonity Docs

Ability ​

The Ability class extends Entity with ability state, metadata, and casting APIs.

NOTE

This page documents members declared directly on Ability. Inherited members are available from Entity.

Methods ​

GetAbilityDefinition()DataView | null ​

Retrieves the ability definition.

Returned:

  • DataView | null - The matching object, or null if it is not available.

GetAbilityDefinitionProperty(propertyName: string)string | number | boolean | null ​

Retrieves the ability definition property.

  • propertyNamestring - The property name.

Returned:

  • string | number | boolean | null - The matching object, or null if it is not available.

GetName()string ​

Retrieves the name.

Returned:

  • string - The requested name.

GetAbilityChargeRestoreTimeRemaining()number ​

Retrieves the ability charge restore time remaining.

Returned:

  • number - The requested ability charge restore time remaining.

GetAbilityChargeRestoreTime()number ​

Retrieves the ability charge restore time.

Returned:

  • number - The requested ability charge restore time.

GetAbilityCurrentCharges()number ​

Retrieves the ability current charges.

Returned:

  • number - The requested ability current charges.

GetCandyCount()number ​

Retrieves the candy count.

Returned:

  • number - The requested candy count.

GetAbilityIndex()number ​

Retrieves the ability index.

Returned:

  • number - The requested ability index.

IsHidden()boolean ​

Checks whether it is hidden.

Returned:

  • boolean - True if the condition is met, false otherwise.

IsDisplayed()boolean ​

Checks whether it is displayed.

Returned:

  • boolean - True if the condition is met, false otherwise.

GetAOERadius()number ​

Retrieves the aoeradius.

Returned:

  • number - The requested aoeradius.

GetMaxLevel()number ​

Retrieves the maximum level.

Returned:

  • number - The requested maximum level.

GetImagePath()string ​

Retrieves the image path.

Returned:

  • string - The requested image path.

IsStealable()boolean ​

Checks whether it is stealable.

Returned:

  • boolean - True if the condition is met, false otherwise.

GetKeyBind()string ​

Retrieves the key bind.

Returned:

  • string - The requested key bind.

GetChannelStartTime()number ​

Retrieves the channel start time.

Returned:

  • number - The requested channel start time.

GetKeyValues()KeyValue | null ​

Retrieves the key values.

Returned:

  • KeyValue | null - The matching object, or null if it is not available.

FindKey(key: string)KeyValue | null ​

Finds the key.

  • keystring - The key.

Returned:

  • KeyValue | null - The matching object, or null if it is not available.

IsTalent()boolean ​

Checks whether it is talent.

Returned:

  • boolean - True if the condition is met, false otherwise.

GetImage()Image ​

Retrieves the image.

Returned:

  • Image - The result of the call.

GetCooldown()number ​

Retrieves the cooldown.

Returned:

  • number - The requested cooldown.

GetCooldownLength()number ​

Retrieves the cooldown length.

Returned:

  • number - The requested cooldown length.

GetManaCost()number ​

Retrieves the mana cost.

Returned:

  • number - The requested mana cost.

GetLevel()number ​

Retrieves the level.

Returned:

  • number - The requested level.

GetType()Enum.AbilityTypes ​

Retrieves the type.

Returned:

GetBehavior()Enum.AbilityBehavior ​

Retrieves the behavior.

Returned:

GetTargetTeam()Enum.TargetTeam ​

Retrieves the target team.

Returned:

GetTargetType()Enum.TargetType ​

Retrieves the target type.

Returned:

GetTargetFlags()Enum.TargetFlags ​

Retrieves the target flags.

Returned:

GetDamageType()Enum.DamageTypes ​

Retrieves the damage type.

Returned:

GetImmunityType()Enum.ImmunityTypes ​

Retrieves the immunity type.

Returned:

GetDispellableType()Enum.DispellableTypes ​

Retrieves the dispellable type.

Returned:

IsPassive()boolean ​

Checks whether it is passive.

Returned:

  • boolean - True if the condition is met, false otherwise.

IsBasic()boolean ​

Checks whether it is basic.

Returned:

  • boolean - True if the condition is met, false otherwise.

IsUltimate()boolean ​

Checks whether it is ultimate.

Returned:

  • boolean - True if the condition is met, false otherwise.

IsAttributes()boolean ​

Checks whether it is attributes.

Returned:

  • boolean - True if the condition is met, false otherwise.

GetLevelSpecialValueFor(key: string)number ​

Retrieves the level special value for.

  • keystring - The key.

Returned:

  • number - The requested level special value for.

GetLevelSpecialValueForFloat(key: string)number ​

Retrieves the level special value for float.

  • keystring - The key.

Returned:

  • number - The requested level special value for float.

SecondsSinceLastUse()number ​

Retrieves the elapsed time since the last use.

Returned:

  • number - The requested seconds since last use.

GetDamage()number ​

Retrieves the damage.

Returned:

  • number - The requested damage.

GetCastPoint()number ​

Retrieves the cast point.

Returned:

  • number - The requested cast point.

GetCastRange()number ​

Retrieves the cast range.

Returned:

  • number - The requested cast range.

IsCastable(mana: number, passiveOk?: boolean)boolean ​

Checks whether the ability is castable for the provided mana value.

  • mananumber - The mana.
  • passiveOkboolean (optional) - The passive ok.

Returned:

  • boolean - True if the condition is met, false otherwise.

IsChannelling()boolean ​

Checks whether it is channelling.

Returned:

  • boolean - True if the condition is met, false otherwise.

IsActivated()boolean ​

Checks whether it is activated.

Returned:

  • boolean - True if the condition is met, false otherwise.

GetDirtyButtons()number ​

Retrieves the dirty buttons.

Returned:

  • number - The requested dirty buttons.

GetToggleState()boolean ​

Retrieves the toggle state.

Returned:

  • boolean - True if the condition is met, false otherwise.

GetCastStartTime()number ​

Retrieves the cast start time.

Returned:

  • number - The requested cast start time.

IsInAbilityPhase()boolean ​

Checks whether it is in ability phase.

Returned:

  • boolean - True if the condition is met, false otherwise.

GetAutoCastState()boolean ​

Retrieves the auto cast state.

Returned:

  • boolean - True if the condition is met, false otherwise.

IsInIndefinateCooldown()boolean ​

Checks whether it is in indefinate cooldown.

Returned:

  • boolean - True if the condition is met, false otherwise.

GetOverrideCastPoint()number ​

Retrieves the override cast point.

Returned:

  • number - The requested override cast point.

IsStolen()boolean ​

Checks whether it is stolen.

Returned:

  • boolean - True if the condition is met, false otherwise.

CastTarget(target: Entity, queue?: boolean)void ​

Casts the ability using the target.

  • targetEntity - The target entity.
  • queueboolean (optional) - Whether to queue the action.

CastNoTarget(queue?: boolean)void ​

Casts the ability using the no target.

  • queueboolean (optional) - Whether to queue the action.

CastPosition(position: Vector, queue?: boolean)void ​

Casts the ability using the position.

  • positionVector - The position to use.
  • queueboolean (optional) - Whether to queue the action.

Toggle(queue?: boolean)void ​

Toggles the current item or ability state.

  • queueboolean (optional) - Whether to queue the action.

ToggleMod(queue?: boolean)void ​

Toggles the alternate item or ability state.

  • queueboolean (optional) - Whether to queue the action.