summaryrefslogtreecommitdiff
path: root/scripts/Entities/Actions/Action.cs
blob: 0bbcc247fdc2d6b9f04173f555de63def1c67da8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
using Godot;
using TheLegendOfGustav.Entities.Actors;
using TheLegendOfGustav.Map;

namespace TheLegendOfGustav.Entities.Actions;

/// <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 custo da ação.
	/// </summary>
	protected int cost;

	public Action(Actor actor)
	{
		Actor = actor;
		// Custo base, subclasses podem sobreescrever isto se quiserem.
		cost = 10;
	}

	/// <summary>
	/// O ator que realiza a ação.
	/// </summary>
	public Actor Actor { get; private set; }

	/// <summary>
	/// É conveniente ter acesso ao mapa dentro de uma ação.
	/// </summary>
	protected MapData MapData
	{
		get => Actor.MapData;
	}

	/// <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>
	/// <returns>Se a ação foi executada ou não.</returns>
	public abstract bool Perform();
}