API de la Unidad
Como creador, llamas métodos sobre unidades al escribir la lógica de las habilidades que tu creas.
Métodos de Clase
Estos son los métodos que tienes disponibles:
unit.heal(amount)
Añade la cantidad indicada de salud en HP.
La salud no puede superar la salud máxima.
Parámetros
amount
(number): La cantidad de HP a añadir.
unit.takeDamage(amount)
Resta la cantidad indicada de salud en HP.
Si la unidad esta atrapada, esta será liberada al recibir daño.
La salud no puede disminuir más allá de cero. Si esta llega a cero, la unidad morirá y se desvanecerá del piso.
Parámetros
amount
(number): La cantidad de HP a restar.
unit.damage(receiver, amount)
Daña a otra unidad.
Si la otra unidad muere, la unidad infligiendo el daño ganará o perderá puntos según la recompensa de la unidad muerta dependiendo si esta unidad era enemiga o amiga, respectivamente.
Parámetros
receiver
(Unit): La unidad a dañar.
amount
(number): La cantidad de HP a infligir.
unit.isAlive()
Determina si la unidad esta con vida.
Una unidad esta con vida si tiene una posición.
Devuelve
(boolean): Si la unidad esta con vida o no.
unit.release(unit)
Libera (suelta) a otra unidad.
Si la otra unidad era amiga, la unidad que la liberó ganará puntos según la recompensa de la unidad liberada.
Parámetros
receiver
(Unit): La unidad a liberar.
unit.unbind()
Suelta la unidad.
unit.bind()
Atrapa la unidad.
unit.isBound()
Determina si la unidad esta atrapada.
Devuelve
(boolean): Si la unidad esta atrapada o no.
unit.earnPoints(points)
Añade la cantidad indicada de puntos al puntaje.
Parámetros
points
(number): Los puntos a añadir.
unit.losePoints(points)
Resta la cantidad indicada de puntos del puntaje.
Parámetros
points
(number): La cantidad de puntos a restar.
unit.triggerEffect(effect)
Desencadena el efecto indicado.
Parámetros
effect
(string): El nombre del efecto.
unit.isUnderEffect(effect)
Determina si la unidad esta bajo el efecto dado.
Parámetros
effect
(string): El nombre del efecto.
Devuelve
(boolean): Si la unidad esta bajo el efecto dado o no.
unit.getOtherUnits()
Devuelve las unidades en el piso menos esta unidad.
Devuelve
(Unit[]): Las otras unidades en el piso.
unit.getSpace()
Devuelve el espacio donde esta unidad se encuentra.
Devuelve
(Space): El espacio donde esta unidad se encuentra.
unit.getSensedSpaceAt(direction, forward = 1, right = 0)
Devuelve el espacio percibido que se encuentra en la dirección y número de espacios indicados.
Utiliza este método cuando devuelvas espacios desde sentidos. Devuelve siempre espacios percibidos al jugador.
Parámetros
direction
(string): La dirección.
forward
(number): El número de espacios hacia adelante.
right
(number): El número de espacios hacia la derecha.
Devuelve
(SensedSpace): El espacio percibido.
unit.getSpaceAt(direction, forward = 1, right = 0)
Devuelve el espacio que se encuentra en la dirección y número de espacios indicados.
Utiliza este método internamente. Nunca devuelvas un espacio normal al jugador.
Parámetros
direction
(string): La dirección.
forward
(number): El número de espacios hacia adelante.
right
(number): El número de espacios hacia la derecha.
Devuelve
(Space): El espacio.
unit.getDirectionOfStairs()
Devuelve la dirección de las escaleras con referencia a esta unidad.
Devuelve
(string): La dirección relativa de las escaleras.
unit.getDirectionOf(space)
Devuelve la dirección del espacio indicado con referencia a esta unidad.
Parámetros
space
(SensedSpace): El espacio para el cual obtener la dirección.
Devuelve
(string): La dirección relativa del espacio.
unit.getDistanceOf(space)
Devuelve la distancia entre el espacio indicado y esta unidad.
Parámetros
space
(SensedSpace): El espacio para el cual calcular la distancia.
Devuelve
(number): La distancia al espacio.
unit.move(direction, forward = 1, right = 0)
Mueve la unidad en la dirección y número de espacios indicados.
Parámetros
direction
(string): La dirección.
forward
(number): El número de espacios hacia adelante.
right
(number): El número de espacios hacia la derecha.
unit.rotate(direction)
Rota la unidad en la dirección indicada.
Parámetros
direction
(string): La dirección en la cual rotar.
unit.vanish()
Desvanece la unidad del piso.
unit.log(message)
Anota un mensaje en el log de la jugada.
Parámetros
message
(string): El mensaje a anotar.
Propiedades de Instancia
name
(string)
El nombre de la unidad.
character
(string)
El caracter que representa a la unidad en el mapa del piso.
health
(number)
La cantidad total de daño que la unidad puede recibir antes de morir.
maxHealth
(number)
El máximo valor de la salud (health
).
reward
(number)
El número de puntos a recompensar al interactuar.
enemy
(boolean)
Si la unidad pertenece al bando enemigo o no.
bound
(boolean)
Si la unidad esta atrapada o no.