Skip to content

DamageableComponent

DamageableComponent is a component which defines properties, events, and functions for objects which take damage. You can only apply this API to both a player and a non-player character (NPC). To convert an object to an NPC, attach a Character or Monster component to it. DamageableComponent can only function when the Damageable module (https://developer.yahaha.com/manual/yahaha-studio-manual/scripting/module/module-reference/Damageable/) is added to the same object.

Properties

number HitPoints

SERVER ONLY 
Current amount of hit points.

number MaxHitPoints

SERVER ONLY 
Maximum amount of hit points.

Functions

void ApplyDamage(number amount, [YaEntity enemy])

SERVER ONLY 
Damages the damageable object.
  • amount indicates the numeric amount of damage to inflict. If it is negative, the object will be healed.
  • enemy identifies the one who caused the damage or heal. It will be sent to YaDamage via DamagedEvent.

Events

DamagedEvent<YaDamage>

SERVER ONLY 
Fired when the damageable object takes damage.
  1. damageInfo Including information about damage/healing

ZeroHpEvent<void>

SERVER ONLY 
Fired when the hit points are decreased to zero.