Emergency 20 Dokumentation  4.2.0
UsePepperSprayAction.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/audio/AudioProxy.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 State
43  {
48  STATE_DONE
49  };
50 
51 
52  //[-------------------------------------------------------]
53  //[ Public methods ]
54  //[-------------------------------------------------------]
55  public:
61 
66  virtual ~UsePepperSprayAction();
67 
72  void init(const qsf::Entity& targetEntity);
73 
78  uint64 getTargetEntityId() const;
79 
80 
81  //[-------------------------------------------------------]
82  //[ Public virtual qsf::Actions methods ]
83  //[-------------------------------------------------------]
84  public:
85  virtual void serialize(qsf::BinarySerializer& serializer) override;
86 
87 
88  //[-------------------------------------------------------]
89  //[ Protected virtual qsf::Action methods ]
90  //[-------------------------------------------------------]
91  protected:
92  virtual bool onStartup() override;
93  virtual void onShutdown() override;
94  virtual void onPause() override;
95  virtual qsf::action::Result updateAction(const qsf::Clock& clock) override;
96 
97 
98  //[-------------------------------------------------------]
99  //[ Private methods ]
100  //[-------------------------------------------------------]
101  private:
102  qsf::Entity* createPepperSprayEffect();
103  void linkEffectEntity();
104  bool validateUserAndTarget() const;
105  void setTargetStunned();
106 
107 
108  //[-------------------------------------------------------]
109  //[ Private data ]
110  //[-------------------------------------------------------]
111  private:
112  // Configuration
113  uint64 mTargetEntityId;
114  State mCurrentState;
115  qsf::Time mTimePepperSprayIsInUse;
116  qsf::Time mTimeAnimationBlending;
117  qsf::WeakPtr<qsf::Entity> mEffectEntity;
118  float mTargetYaw;
119  AudioProxy mAudioProxy;
120 
121 
122  //[-------------------------------------------------------]
123  //[ CAMP reflection system ]
124  //[-------------------------------------------------------]
125  QSF_CAMP_RTTI() // Only adds the virtual method "campClassId()", nothing more
126 
127 
128  };
129 
130 
131 //[-------------------------------------------------------]
132 //[ Namespace ]
133 //[-------------------------------------------------------]
134 } // em5
135 
136 
137 //[-------------------------------------------------------]
138 //[ CAMP reflection system ]
139 //[-------------------------------------------------------]
static const qsf::NamedIdentifier ACTION_ID
"em5::UsePepperSprayAction" unique action identifier
Definition: UsePepperSprayAction.h:40
Definition: UsePepperSprayAction.h:44
Definition: ActionPriority.h:13
Entity class.
Definition: Entity.h:46
Definition: UsePepperSprayAction.h:46
State
Definition: UsePepperSprayAction.h:42
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
EMERGENCY 5 use pepper spray action.
Definition: UsePepperSprayAction.h:32
State
Definition: ProcessState.h:20
#define QSF_CAMP_RTTI()
Only adds the virtual method "campClassId()", nothing more.
Definition: CampClass.h:75
Extended audio proxy for easier multiplay usage.
Definition: AudioProxy.h:47
#define QSF_CAMP_TYPE_NONCOPYABLE(type)
See "CAMP_TYPE_NONCOPYABLE" for details.
Definition: CampClass.h:112
Definition: UsePepperSprayAction.h:47
Abstract action base class.
Definition: Action.h:59
Class combining strings with their hashes.
Definition: NamedIdentifier.h:34
Binary serializer class.
Definition: BinarySerializer.h:35
Result
Definition: ActionResult.h:20
Data type for encapsulating time information. It might represents points in time and time spans...
Definition: Time.h:32