API dell'unità
Come creatore, richiami metodi sulle unità mentre stai scrivendo la logica per le abilità che stai creando.
Metodi della Classe
Qui ci sono i vari metodi che sono a tua disposizione:
unit.heal(amount)
Aggiunge agli HP la quantità di salute indicata.
La salute non può superare la quantità di salute massima.
Parametri
amount (number): La quantità di HP da aggiungere.
unit.takeDamage(amount)
Sottrae la quantità di salute in HP.
Se l'unità è intrappolata, si libererà quando subisce danni.
La salute non può andare sotto zero. Se raggiunge lo zero, l'unità morirà e scomparirà dal piano.
Parametri
amount(number): La quantità di HP da sottrarre.
unit.damage(receiver, amount)
Danneggia un'altra unità.
Se l'altra unità muore, chi l'ha attaccata guadagnerà o perderà punti per un valore pari alla ricompensa dell'unità uccisa a seconda che quella unità fosse, rispettivamente, un nemico o un amico.
Parametri
receiver (Unit): L'unità alla quale far danno.
amount (number): Il danno da infliggere in HP.
unit.isAlive()
Determina se l'unità è viva.
Un'unità è viva se ha una posizione.
Restituisce
(boolean): Se l'unità è viva oppure no.
unit.release(unit)
Libera (slega) un'altra unità.
Se l'altra unità era un amico, chi l'ha liberata guadagnerà punti per un valore pari al compenso dell'unità rilasciata.
Parametri
receiver (Unit): L'unità da liberare.
unit.unbind()
Libera l'unità.
unit.bind()
Cattura l'unità.
unit.isBound()
Determina se l'unità è legata.
Restituisce
(boolean): Se l'unità è legata o meno.
unit.earnPoints(points)
Aggiunge i punti indicati al punteggio.
Parametri
points (number): I punti da guadagnare.
unit.losePoints(points)
Sottrae i punti indicati dal punteggio.
Parametri
points (number): I punti da perdere.
unit.triggerEffect(effect)
Attiva l'effetto indicato.
Parametri
effect (string): Il nome dell'effetto.
unit.isUnderEffect(effect)
Determina se l'unità è sotto l'effetto indicato o meno.
Parametri
effect (string): Il nome dell'effetto.
Restituisce
(boolean): Se l'unità è sotto l'effetto indicato o meno.
unit.getOtherUnits()
Restituisce le unità presenti sul piano meno quest'unità.
Restituisce
(Unit[]): Le altre unità sul piano.
unit.getSpace()
Restituisce lo spazio in cui si trova quest'unità.
Restituisce
(Space): Lo spazio in cui si trova questa unità.
unit.getSensedSpaceAt(direction, forward = 1, right = 0)
Restituisce lo spazio percepito situato nella direzione e il numero degli spazi.
Utilizza questa metodo quando restituisci spazi dai sensi. Restituisci sempre al giocatore gli spazi percepiti.
Parametri
direction (string): La direzione.
forward (number): Il numero di spazi presenti in avanti.
right (number): Il numero di spazi presenti alla destra.
Restituisce
(SensedSpace): Lo spazio percepito.
unit.getSpaceAt(direction, forward = 1, right = 0)
Restituisce lo spazio percepito situato nella direzione e il numero degli spazi.
Utilizza questo metodo internamente.** Non restituire mai uno spazio normale al giocatore.**
Parametri
direction (string): La direzione.
forward (number): Il numero di spazi presenti in avanti.
right (number): Il numero di spazi presenti alla destra.
Restituisce
(Space): Lo spazio.
unit.getDirectionOfStairs()
Restituisce la direzione delle scale rispetto a questa unità.
Restituisce
(string): La direzione relativa delle scale.
unit.getDirectionOf(space)
Restituisce la direzione dello spazio indicato rispetto a questa unità.
Parametri
space (SensedSpace): Lo spazio per il quale ottenere la direzione.
Restituisce
(string): La direzione relativa dello spazio.
unit.getDistanceOf(space)
Restituisce la distanza tra lo spazio indicato e questa unità.
Parametri
space (SensedSpace): Lo spazio per il quale calcolare la distanza.
Restituisce
(number): La distanza dello spazio.
unit.move(direction, forward = 1, right = 0)
Sposta l'unità nella direzione e per il numero di spazi indicati.
Parametri
direction (string): La direzione.
forward (number): Il numero di spazi presenti in avanti.
right (number): Il numero di spazi presenti alla destra.
unit.rotate(direction)
Ruota l'unità nella direzione indicata.
Parametri
direction (string): La direzione in cui ruotare.
unit.vanish()
Fa sparire l'unità dal piano.
unit.log(message)
Registra un messaggio nel log di gioco.
Parametri
message (string): Il messaggio da registrare.
Proprietà dell'istanza
name (string)
Il nome dell'unità.
character (string)
Il carattere che rappresenta l'unità nella mappa del piano.
health (number)
Il danno totale, in HP, che l'unità può ricevere prima di morire.
maxHealth (number)
Il valore massimo di health.
reward (number)
Il numero di punti per la ricompensa ricevuta quando si interagisce.
enemy (boolean)
Se l'unità appartiene ai nemici oppure no.
bound (boolean)
Se l'unità è catturata oppure no.