Otclient  14/8/2020
effect.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2010-2020 OTClient <https://github.com/edubart/otclient>
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a copy
5  * of this software and associated documentation files (the "Software"), to deal
6  * in the Software without restriction, including without limitation the rights
7  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8  * copies of the Software, and to permit persons to whom the Software is
9  * furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20  * THE SOFTWARE.
21  */
22 
23 #ifndef EFFECT_H
24 #define EFFECT_H
25 
26 #include <framework/global.h>
27 #include <framework/core/timer.h>
28 #include "thing.h"
29 
30 // @bindclass
31 class Effect : public Thing
32 {
33  enum {
34  EFFECT_TICKS_PER_FRAME = 75
35  };
36 
37 public:
38  void drawEffect(const Point& dest, float scaleFactor, bool animate, int offsetX = 0, int offsetY = 0, LightView *lightView = nullptr);
39 
40  void setId(uint32 id);
41  uint32 getId() { return m_id; }
42 
43  EffectPtr asEffect() { return static_self_cast<Effect>(); }
44  bool isEffect() { return true; }
45 
46  const ThingTypePtr& getThingType();
48 
49 protected:
50  void onAppear();
51 
52 private:
53  Timer m_animationTimer;
54  uint16 m_id;
55 };
56 
57 #endif
Effect::getId
uint32 getId()
Definition: effect.h:41
Effect
Definition: effect.h:31
uint32
uint32_t uint32
Definition: types.h:35
Effect::isEffect
bool isEffect()
Definition: effect.h:44
Thing
Definition: thing.h:33
LightView
Definition: lightview.h:37
uint16
uint16_t uint16
Definition: types.h:36
Effect::onAppear
void onAppear()
Definition: effect.cpp:60
Effect::getThingType
const ThingTypePtr & getThingType()
Definition: effect.cpp:90
timer.h
Effect::drawEffect
void drawEffect(const Point &dest, float scaleFactor, bool animate, int offsetX=0, int offsetY=0, LightView *lightView=nullptr)
Definition: effect.cpp:28
Effect::rawGetThingType
ThingType * rawGetThingType()
Definition: effect.cpp:95
Effect::setId
void setId(uint32 id)
Definition: effect.cpp:83
ThingType
Definition: thingtype.h:123
stdext::shared_object_ptr
Definition: shared_object.h:39
Effect::asEffect
EffectPtr asEffect()
Definition: effect.h:43
Timer
Definition: timer.h:28
thing.h
TPoint< int >
global.h