Melonity Docs

Hero ​

The Hero class extends NPC with hero-specific progression and attribute APIs.

NOTE

This page documents members declared directly on Hero. Inherited members are available from NPC.

Methods ​

GetTalentsMask()number ​

Retrieves the talents mask.

Returned:

  • number - The requested talents mask.

GetTalents()Array<Ability> ​

Retrieves the talents.

Returned:

  • Array<Ability> - An array with the matching values.

GetPlayerID()number ​

Retrieves the player id.

Returned:

  • number - The requested player id.

GetImageIcon()Image ​

Retrieves the image icon.

Returned:

  • Image - The result of the call.

GetCurrentXP()number ​

Retrieves the current xp.

Returned:

  • number - The requested current xp.

GetAbilityPoints()number ​

Retrieves the ability points.

Returned:

  • number - The requested ability points.

GetRespawnTime()number ​

Retrieves the respawn time.

Returned:

  • number - The requested respawn time.

GetRespawnTimePenalty()number ​

Retrieves the respawn time penalty.

Returned:

  • number - The requested respawn time penalty.

GetPrimaryAttribute()Enum.Attributes ​

Retrieves the primary attribute.

Returned:

GetStrength()number ​

Retrieves the strength.

Returned:

  • number - The requested strength.

GetAgility()number ​

Retrieves the agility.

Returned:

  • number - The requested agility.

GetIntellect()number ​

Retrieves the intellect.

Returned:

  • number - The requested intellect.

GetStrengthTotal()number ​

Retrieves the strength total.

Returned:

  • number - The requested strength total.

GetAgilityTotal()number ​

Retrieves the agility total.

Returned:

  • number - The requested agility total.

GetIntellectTotal()number ​

Retrieves the intellect total.

Returned:

  • number - The requested intellect total.

GetRecentDamage()number ​

Retrieves the recent damage.

Returned:

  • number - The requested recent damage.

GetPainFactor()number ​

Retrieves the pain factor.

Returned:

  • number - The requested pain factor.

GetTargetPainFactor()number ​

Retrieves the target pain factor.

Returned:

  • number - The requested target pain factor.

GetLifeState()boolean ​

Retrieves the life state.

Returned:

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

GetReplicatingOtherHeroModelIndex()number ​

Retrieves the replicating other hero model index.

Returned:

  • number - The requested replicating other hero model index.

GetReplicatingOtherHeroModel()Hero | null ​

Retrieves the replicating other hero model.

Returned:

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

IsReplicatingOtherHeroModel()boolean ​

Checks whether it is replicating other hero model.

Returned:

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

GetHeroFacetID()number ​

Retrieves the hero facet id.

Returned:

  • number - The requested hero facet id.