Emergency 20 Dokumentation  4.2.0
PullObjectAction.h
Go to the documentation of this file.
1 // Copyright (C) 2012-2018 Promotion Software GmbH
2 
3 
4 //[-------------------------------------------------------]
5 //[ Header guard ]
6 //[-------------------------------------------------------]
7 #pragma once
8 
9 
10 //[-------------------------------------------------------]
11 //[ Includes ]
12 //[-------------------------------------------------------]
13 #include "em5/Export.h"
14 
16 
17 
18 //[-------------------------------------------------------]
19 //[ Namespace ]
20 //[-------------------------------------------------------]
21 namespace em5
22 {
23 
24 
25  //[-------------------------------------------------------]
26  //[ Classes ]
27  //[-------------------------------------------------------]
33  {
34 
35 
36  //[-------------------------------------------------------]
37  //[ Public definitions ]
38  //[-------------------------------------------------------]
39  public:
41 
42  enum Pull
43  {
45  STOP
46  };
47 
48 
49  //[-------------------------------------------------------]
50  //[ Public methods ]
51  //[-------------------------------------------------------]
52  public:
58 
63  virtual ~PullObjectAction();
64 
69  void init(qsf::Entity& targetEntity, Pull pull, bool clearActionsOnFail);
70 
71  uint64 getTargetEntityId() const;
72 
73 
74  //[-------------------------------------------------------]
75  //[ Public virtual qsf::Actions methods ]
76  //[-------------------------------------------------------]
77  public:
78  virtual void serialize(qsf::BinarySerializer& serializer) override;
79 
80 
81  //[-------------------------------------------------------]
82  //[ Protected virtual qsf::Action methods ]
83  //[-------------------------------------------------------]
84  protected:
85  virtual bool onStartup() override;
86  virtual qsf::action::Result updateAction(const qsf::Clock& clock) override;
87  virtual void onShutdown() override;
88 
89 
90  //[-------------------------------------------------------]
91  //[ Private definitions ]
92  //[-------------------------------------------------------]
93  private:
94  enum TargetState
95  {
96  ON_FLOOR,
97  GRABBED
98  };
99 
100 
101  //[-------------------------------------------------------]
102  //[ Private data ]
103  //[-------------------------------------------------------]
104  private:
105  uint64 mTargetEntityId;
106  Pull mPull;
107  TargetState mTargetState;
108  bool mClearActionsOnFail;
109 
110 
111  //[-------------------------------------------------------]
112  //[ CAMP reflection system ]
113  //[-------------------------------------------------------]
114  QSF_CAMP_RTTI() // Only adds the virtual method "campClassId()", nothing more
115 
116 
117  };
118 
119 
120 //[-------------------------------------------------------]
121 //[ Namespace ]
122 //[-------------------------------------------------------]
123 } // em5
124 
125 
126 //[-------------------------------------------------------]
127 //[ CAMP reflection system ]
128 //[-------------------------------------------------------]
Definition: ActionPriority.h:13
Entity class.
Definition: Entity.h:46
Clock class.
Definition: Clock.h:33
#define EM5_API_EXPORT
Definition: Export.h:28
uint64_t uint64
Definition: PlatformTypes.h:184
void serialize(BinarySerializer &serializer, BitFlagSet< STORAGE, ENUM > &bitFlagSet)
Definition: BitFlagSet.h:359
#define QSF_CAMP_RTTI()
Only adds the virtual method "campClassId()", nothing more.
Definition: CampClass.h:75
#define QSF_CAMP_TYPE_NONCOPYABLE(type)
See "CAMP_TYPE_NONCOPYABLE" for details.
Definition: CampClass.h:112
static const qsf::NamedIdentifier ACTION_ID
"em5::PullObjectAction" unique action identifier
Definition: PullObjectAction.h:40
EMERGENCY 5 pull object action.
Definition: PullObjectAction.h:32
Pull
Definition: PullObjectAction.h:42
Abstract action base class.
Definition: Action.h:59
Class combining strings with their hashes.
Definition: NamedIdentifier.h:34
Definition: PullObjectAction.h:44
Binary serializer class.
Definition: BinarySerializer.h:35
Result
Definition: ActionResult.h:20