API des unités
En tant que créateur, vous appelez des méthodes sur les unités quand vous écrivez la logique des capacités que vous créez.
Méthodes de classe
Voici les méthodes à votre disposition :
unit.heal(amount)
Ajoute une quantité de points de santé donnée.
Les points de santé sont limités.
Arguments
amount(nombre) : La quantité de points de santé à ajouter.
unit.takeDamage(amount)
Soustraie une quantité de points de santé donnée.
Si l'unité est associée, elle sera dissociée quand elle subira des dégâts.
Si les points de santé atteignent zéro, l'unité est détruite et retirée du sol.
Arguments
amount(nombre) : La quantité de points de santé à soustraire.
unit.damage(receiver, amount)
Endommage une autre unité.
Si vous détruisez une autre unité, vous gagnez des points correspondant à sa récompense s'il s'agit d'une unité ennemie, ou vous en perdez s'il s'agit d'une unité alliée.
Arguments
receiver(Unité) : L'unité à endommager.
amount(nombre) : La quantité de points de santé à infliger.
unit.isAlive()
Détermine si une unité est vivante.
Une unité est vivante si elle bénéficie d'une position.
Retours
(booléen) : Si l'unité est vivante ou non.
unit.release(unit)
Libère (dissocie) une autre unité.
Si vous libérez une unité alliée, vous gagnez des points correspondant à sa récompense.
Arguments
receiver(Unité) : L'unité à libérer.
unit.unbind()
Dissocie l'unité.
unit.bind()
Associe l'unité.
unit.isBound()
Détermine si l'unité est associée ou non.
Retours
(booléen) : Si l'unité est associée ou non.
unit.earnPoints(points)
Ajoute au score une quantité de points donnée.
Arguments
points (nombre) : Les points à gagner.
unit.losePoints(points)
Soustrait du score une quantité de points donnée.
Arguments
points (nombre) : Les points à perdre.
unit.triggerEffect(effect)
Déclenche l'effet donné.
Arguments
effect (string) : Le nom de l'effet.
unit.isUnderEffect(effect)
Détermine si l'unité est sous l'effet donné.
Arguments
effect (string) : Le nom de l'effet.
Retours
(booléen) : Si l'unité est sous l'effet ou non.
unit.getOtherUnits()
Renvoie les unités au sol, à l'exception de celle-ci.
Retours
(Unit[]) : Les autres unités au sol.
unit.getSpace()
Renvoie l'espace où se trouve cette unité.
Retours
(Espace) : L'espace où se trouve cette unité.
unit.getSensedSpaceAt(direction, forward = 1, right = 0)
Renvoie l'espace à sens correspondant à la direction et au nombre d'espaces.
Faites appel à cette méthode quand vous renvoyez des espaces depuis des sens. Renvoyez toujours les espaces à sens au jour.
Arguments
direction (chaîne) : la direction.
forward (nombre) : le nombre d'espaces vers l'avant.
right (number): The number of spaces to the right.
Retours
(SensedSpace): The sensed space.
unit.getSpaceAt(direction, forward = 1, right = 0)
Returns the space located at the direction and number of spaces.
Use this method internally. Never return a regular space to the player.
Arguments
direction (chaîne) : la direction.
forward (nombre) : le nombre d'espaces vers l'avant.
right (number): The number of spaces to the right.
Retours
(Space): The space.
unit.getDirectionOfStairs()
Returns the direction of the stairs with reference to this unit.
Retours
(string): The relative direction of the stairs.
unit.getDirectionOf(space)
Returns the direction of the given space with reference to this unit.
Arguments
space (SensedSpace): The space to get the direction of.
Retours
(string): The relative direction of the space.
unit.getDistanceOf(space)
Returns the distance between the given space and this unit.
Arguments
space (SensedSpace): The space to calculate the distance of.
Retours
(number): The distance of the space.
unit.move(direction, forward = 1, right = 0)
Moves the unit in the given direction and number of spaces.
Arguments
direction (chaîne) : la direction.
forward (nombre) : le nombre d'espaces vers l'avant.
right (number): The number of spaces to the right.
unit.rotate(direction)
Rotates the unit in a given direction.
Arguments
direction (string): The direction in which to rotate.
unit.vanish()
Vanishes the unit from the floor.
unit.log(message)
Logs a message to the play log.
Arguments
message (string): The message to log.
Propriétés d'instance
name (string)
The name of the unit.
character (string)
The character that represents the unit in the floor map.
health (number)
The total damage the unit may take before dying, in HP.
maxHealth (number)
The maximum health value.
reward (number)
The number of points to reward when interacting.
enemy (boolean)
Whether the unit belongs to the enemy side or not.
bound (boolean)
Whether the unit is bound or not.