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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
/* Copyright (C) 2021 Wildfire Games.
* This file is part of 0 A.D.
*
* 0 A.D. is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* 0 A.D. is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with 0 A.D. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef INCLUDED_UNIT
#define INCLUDED_UNIT
#include <map>
#include <set>
#include "ps/CStr.h"
#include "simulation2/system/Entity.h" // entity_id_t
class CActorDef;
class CModelAbstract;
class CObjectEntry;
class CObjectManager;
class CUnitAnimation;
/////////////////////////////////////////////////////////////////////////////////////////////
// CUnit: simple "actor" definition - defines a sole object within the world
class CUnit
{
NONCOPYABLE(CUnit);
private:
// Private constructor. Needs complete list of selections for the variation.
CUnit(CObjectManager& objectManager, const CActorDef& actor, uint32_t seed);
public:
// Attempt to create a unit with the given actor.
// If specific selections are wanted, call SetEntitySelection or SetActorSelections after creation.
// Returns NULL on failure.
static CUnit* Create(const CStrW& actorName, uint32_t seed, CObjectManager& objectManager);
// destructor
~CUnit();
// get unit's template object
const CObjectEntry& GetObject() const { return *m_Object; }
// get unit's model data
CModelAbstract& GetModel() const { return *m_Model; }
CUnitAnimation* GetAnimation() { return m_Animation; }
/**
* Update the model's animation.
* @param frameTime time in seconds
*/
void UpdateModel(float frameTime);
// Sets the entity-selection, and updates the unit to use the new
// actor variation. Either set one key at a time, or a complete map.
void SetEntitySelection(const CStr& key, const CStr& selection);
void SetEntitySelection(const std::map<CStr, CStr>& selections);
// Most units have a hopefully-unique ID number, so they can be referred to
// persistently despite saving/loading maps. Default for new units is -1; should
// usually be set to CUnitManager::GetNewID() after creation.
entity_id_t GetID() const { return m_ID; }
void SetID(entity_id_t id);
const std::set<CStr>& GetActorSelections() const { return m_ActorSelections; }
/**
* Overwrite the seed-selected actor selections. Likely only useful for Atlas or debugging.
*/
void SetActorSelections(const std::set<CStr>& selections);
private:
// Actor for the unit
const CActorDef& m_Actor;
// object from which unit was created; never NULL once fully created.
CObjectEntry* m_Object = nullptr;
// object model representation; never NULL once fully created.
CModelAbstract* m_Model = nullptr;
CUnitAnimation* m_Animation = nullptr;
// unique (per map) ID number for units created in the editor, as a
// permanent way of referencing them.
entity_id_t m_ID;
// seed used when creating unit
uint32_t m_Seed;
// Actor-level selections for this unit. This is normally set at init time,
// so that we always re-use the same aesthetic variants.
// These have lower priority than entity-level selections.
std::set<CStr> m_ActorSelections;
// Entity-level selections for this unit (used for e.g. animation variants).
std::map<CStr, CStr> m_EntitySelections;
// object manager which looks after this unit's objectentry
CObjectManager& m_ObjectManager;
void ReloadObject();
friend class CUnitAnimation;
};
#endif
|
