xoreos  0.0.5
trigger.h
Go to the documentation of this file.
1 /* xoreos - A reimplementation of BioWare's Aurora engine
2  *
3  * xoreos is the legal property of its developers, whose names
4  * can be found in the AUTHORS file distributed with this source
5  * distribution.
6  *
7  * xoreos is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 3
10  * of the License, or (at your option) any later version.
11  *
12  * xoreos is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with xoreos. If not, see <http://www.gnu.org/licenses/>.
19  */
20 
25 #ifndef ENGINES_JADE_TRIGGER_H
26 #define ENGINES_JADE_TRIGGER_H
27 
28 #include "src/common/types.h"
29 #include "src/common/ustring.h"
30 
31 #include "src/aurora/types.h"
32 
34 
35 #include "src/engines/jade/types.h"
37 
38 namespace Engines {
39 
40 namespace Jade {
41 
42 class Trigger : public Object {
43 public:
45  Trigger(const Aurora::GFF3Struct &trigger);
46  ~Trigger();
47 
48  // Basic properties
49 
51  bool isOneShot() const;
53  bool isTrap() const;
55  bool isDetectable() const;
57  bool isDisarmable() const;
59  bool isFlagged() const;
61  bool isAreaTrans() const;
63  bool isHenchmenData() const;
66 
67 private:
68  bool _isOneShot;
69  bool _isTrap;
72  bool _isFlagged;
73  bool _isAreaTrans;
77 
79 
81 
83 
85  void load(const Aurora::GFF3Struct &trigger);
87  void loadBlueprint(const Aurora::GFF3Struct &gff);
89  void loadInstance(const Aurora::GFF3Struct &gff);
90 };
91 
92 } // End of namespace Jade
93 
94 } // End of namespace Engines
95 
96 #endif // ENGINES_JADE_TRIGGER_H
An object within a Jade Empire area.
bool isAreaTrans() const
Does this trigger represent an area transition?
Definition: trigger.cpp:69
Graphics::VertexBuffer _vertexBuffer
Geometry outline vertex buffer.
Definition: trigger.h:82
A class holding an UTF-8 string.
Definition: ustring.h:48
bool isDetectable() const
Is this trigger detectable?
Definition: trigger.cpp:57
bool _isCombatActive
Does this trigger have henchmen data?
Definition: trigger.h:76
void load(const Aurora::GFF3Struct &trigger)
Load from a trigger instance.
Definition: trigger.cpp:81
void loadInstance(const Aurora::GFF3Struct &gff)
Load the trigger instance properties.
Definition: trigger.cpp:117
Basic Jade Empire type definitions.
bool _isFlagged
Is this trigger flagged?
Definition: trigger.h:72
Low-level type definitions to handle fixed width types portably.
bool isHenchmenData() const
Does this trigger have henchmen data?
Definition: trigger.cpp:73
Buffer containing vertex data.
Definition: vertexbuffer.h:68
bool _isHenchmenData
Does this trigger have henchmen data?
Definition: trigger.h:74
Common::UString getTransitionText() const
Return the trigger&#39;s transition text.
Definition: trigger.cpp:77
bool isOneShot() const
Does this trigger only fire once?
Definition: trigger.cpp:49
void loadBlueprint(const Aurora::GFF3Struct &gff)
Load the trigger blueprint properties.
Definition: trigger.cpp:100
An object within a Jade area.
Definition: object.h:53
bool _isDetectable
Is this trigger detectable?
Definition: trigger.h:70
Unicode string handling.
Basic type definitions to handle files used in BioWare&#39;s Aurora engine.
bool isTrap() const
Does this trigger represent a trap?
Definition: trigger.cpp:53
A struct within a GFF3.
Definition: gff3file.h:164
bool _isDisarmable
Is this trigger disarmable?
Definition: trigger.h:71
Common::UString _transitionText
The trigger&#39;s transition text.
Definition: trigger.h:80
bool _isOneShot
Does this trigger only fire once?
Definition: trigger.h:68
Trigger(const Aurora::GFF3Struct &trigger)
Load from a trigger instance.
Definition: trigger.cpp:41
bool _isTrap
Does this trigger represent a trap?
Definition: trigger.h:69
bool isDisarmable() const
Is this trigger disarmable?
Definition: trigger.cpp:61
bool isFlagged() const
Is this trigger flagged?
Definition: trigger.cpp:65
A vertex buffer.
int _loadScreen
The loading screen used.
Definition: trigger.h:78
bool _isCombatArea
Does this trigger lead to combat?
Definition: trigger.h:75
bool _isAreaTrans
Does this trigger represent an area transition?
Definition: trigger.h:73