summaryrefslogtreecommitdiff
path: root/scripts/actors/actions/Action.cs
diff options
context:
space:
mode:
Diffstat (limited to 'scripts/actors/actions/Action.cs')
-rw-r--r--scripts/actors/actions/Action.cs24
1 files changed, 22 insertions, 2 deletions
diff --git a/scripts/actors/actions/Action.cs b/scripts/actors/actions/Action.cs
index bb5f6f1..0320dd8 100644
--- a/scripts/actors/actions/Action.cs
+++ b/scripts/actors/actions/Action.cs
@@ -1,16 +1,36 @@
using Godot;
-using System;
-using System.Data;
+
+/// <summary>
+/// <c>Action</c> representa uma ação no jogo efetuada por um ator.
+/// Ações são geradas pelo jogador e pela IA, elas regem os atores do jogo.
+/// </summary>
public abstract partial class Action : RefCounted {
+ /// <summary>
+ /// O ator que realiza a ação.
+ /// </summary>
protected Actor actor;
public Action(Actor actor) {
this.actor = actor;
}
+ /// <summary>
+ /// Método que executa a ação. Subclasses da ação devem implementar este método.
+ /// <example>
+ /// Exemplo:
+ /// <code>
+ /// Action action = new Action(actor);
+ /// /* . . . */
+ /// action.Perform();
+ /// </code>
+ /// </example>
+ /// </summary>
public abstract void Perform();
+ /// <summary>
+ /// É conveniente ter acesso ao mapa dentro de uma ação.
+ /// </summary>
protected MapData Map_Data {
get => actor.Map_Data;
}