Otclient 1.0  14/8/2020
Player Class Reference

#include <player.h>

Inheritance diagram for Player:
Collaboration diagram for Player:

Public Member Functions

 Player ()
 
virtual ~Player ()
 
PlayerPtr asPlayer ()
 
bool isPlayer () override
 
- Public Member Functions inherited from Creature
 Creature ()
 
virtual void draw (const Point &dest, float scaleFactor, int reDrawFlags, LightView *lightView=nullptr)
 
void internalDrawOutfit (Point dest, float scaleFactor, bool animateWalk, Otc::Direction direction)
 
void drawOutfit (const Rect &destRect, bool resize)
 
void drawInformation (const Point &point, bool useGray, const Rect &parentRect, int drawFlags)
 
void setId (uint32 id) override
 
void setName (const std::string &name)
 
void setHealthPercent (uint8 healthPercent)
 
void setDirection (Otc::Direction direction)
 
void setOutfit (const Outfit &outfit)
 
void setOutfitColor (const Color &color, int duration)
 
void setLight (const Light &light)
 
void setSpeed (uint16 speed)
 
void setBaseSpeed (double baseSpeed)
 
void setSkull (uint8 skull)
 
void setShield (uint8 shield)
 
void setEmblem (uint8 emblem)
 
void setType (uint8 type)
 
void setIcon (uint8 icon)
 
void setSkullTexture (const std::string &filename)
 
void setShieldTexture (const std::string &filename, bool blink)
 
void setEmblemTexture (const std::string &filename)
 
void setTypeTexture (const std::string &filename)
 
void setIconTexture (const std::string &filename)
 
void setPassable (bool passable)
 
void addTimedSquare (uint8 color)
 
void removeTimedSquare ()
 
void showStaticSquare (const Color &color)
 
void hideStaticSquare ()
 
uint32 getId () override
 
std::string getName ()
 
uint8 getHealthPercent ()
 
Otc::Direction getDirection ()
 
Outfit getOutfit ()
 
Light getLight () override
 
bool hasLight () override
 
uint16 getSpeed ()
 
double getBaseSpeed ()
 
uint8 getSkull ()
 
uint8 getShield ()
 
uint8 getEmblem ()
 
uint8 getType ()
 
uint8 getIcon ()
 
bool isPassable ()
 
int getStepDuration (bool ignoreDiagonal=false, Otc::Direction dir=Otc::InvalidDirection)
 
Point getDrawOffset ()
 
Point getWalkOffset ()
 
PointF getJumpOffset ()
 
Position getLastStepFromPosition ()
 
Position getLastStepToPosition ()
 
float getStepProgress ()
 
float getStepTicksLeft ()
 
ticks_t getWalkTicksElapsed ()
 
std::array< double, Otc::LastSpeedFormulagetSpeedFormulaArray ()
 
Point getDisplacement () override
 
int getDisplacementX () override
 
int getDisplacementY () override
 
int getExactSize (int layer=0, int xPattern=0, int yPattern=0, int zPattern=0, int animationPhase=0) override
 
int getTotalAnimationPhase ()
 
int getCurrentAnimationPhase (bool mount=false)
 
void updateShield ()
 
void turn (Otc::Direction direction)
 
void jump (int height, int duration)
 
void allowAppearWalk ()
 
virtual void walk (const Position &oldPos, const Position &newPos)
 
virtual void stopWalk ()
 
bool isWalking ()
 
bool isRemoved ()
 
bool isInvisible ()
 
bool isDead ()
 
bool canBeSeen ()
 
bool isCreature () override
 
bool isParalyzed () const
 
void updateDynamicInformation (bool update)
 
bool updateDynamicInformation () const
 
const ThingTypePtrgetThingType () override
 
ThingTyperawGetThingType () override
 
ThingTyperawGetMountThingType ()
 
void onPositionChange (const Position &newPos, const Position &oldPos) override
 
void onAppear () override
 
void onDisappear () override
 
virtual void onDeath ()
 
- Public Member Functions inherited from Thing
 Thing ()
 
virtual ~Thing ()
 
virtual void draw (const Point &, float, bool, int=Otc::ReDrawThing, LightView *=nullptr)
 
void setPosition (const Position &position)
 
void requestDrawing (const bool force=false)
 
Position getPosition ()
 
int getStackPriority ()
 
const TilePtrgetTile ()
 
ContainerPtr getParentContainer ()
 
int getStackPos ()
 
virtual bool isItem ()
 
virtual bool isEffect ()
 
virtual bool isMissile ()
 
virtual bool isNpc ()
 
virtual bool isMonster ()
 
virtual bool isLocalPlayer ()
 
virtual bool isAnimatedText ()
 
virtual bool isStaticText ()
 
Size getSize ()
 
int getWidth ()
 
int getHeight ()
 
int getRealSize ()
 
int getLayers ()
 
int getNumPatternX ()
 
int getNumPatternY ()
 
int getNumPatternZ ()
 
int getAnimationPhases ()
 
bool hasAnimationPhases ()
 
AnimatorPtr getAnimator ()
 
AnimatorPtr getIdleAnimator ()
 
int getGroundSpeed ()
 
int getMaxTextLength ()
 
int getMinimapColor ()
 
int getLensHelp ()
 
int getClothSlot ()
 
int getElevation ()
 
bool isGround ()
 
bool isGroundBorder ()
 
bool isOnBottom ()
 
bool isOnTop ()
 
virtual bool isContainer ()
 
bool isStackable ()
 
bool isForceUse ()
 
bool isMultiUse ()
 
bool isWritable ()
 
bool isChargeable ()
 
bool isWritableOnce ()
 
bool isFluidContainer ()
 
bool isSplash ()
 
bool isNotWalkable ()
 
bool isNotMoveable ()
 
bool isMoveable ()
 
bool blockProjectile ()
 
bool isNotPathable ()
 
bool isPickupable ()
 
bool isHangable ()
 
bool isHookSouth ()
 
bool isHookEast ()
 
bool isRotateable ()
 
bool isDontHide ()
 
bool isTranslucent ()
 
bool hasDisplacement ()
 
bool hasElevation ()
 
bool isLyingCorpse ()
 
bool isAnimateAlways ()
 
bool hasMiniMapColor ()
 
bool hasLensHelp ()
 
bool isFullGround ()
 
bool isIgnoreLook ()
 
bool isCloth ()
 
bool isMarketable ()
 
bool isUsable ()
 
bool isWrapable ()
 
bool isUnwrapable ()
 
bool isTopEffect ()
 
bool isOpaque ()
 
bool isTopGround ()
 
MarketData getMarketData ()
 
void startListenerPainter (const float duration)
 
bool cancelListenerPainter ()
 
- Public Member Functions inherited from LuaObject
 LuaObject ()
 
virtual ~LuaObject ()
 
template<typename T >
void connectLuaField (const std::string &field, const std::function< T > &f, bool pushFront=false)
 
template<typename... T>
int luaCallLuaField (const std::string &field, const T &... args)
 
template<typename R , typename... T>
callLuaField (const std::string &field, const T &... args)
 
template<typename... T>
void callLuaField (const std::string &field, const T &... args)
 
bool hasLuaField (const std::string &field)
 Returns true if the lua field exists. More...
 
template<typename T >
void setLuaField (const std::string &key, const T &value)
 Sets a field in this lua object. More...
 
template<typename T >
getLuaField (const std::string &key)
 Gets a field from this lua object. More...
 
void releaseLuaFieldsTable ()
 Release fields table reference. More...
 
void luaSetField (const std::string &key)
 Sets a field from this lua object, the value must be on the stack. More...
 
void luaGetField (const std::string &key)
 Gets a field from this lua object, the result is pushed onto the stack. More...
 
void luaGetMetatable ()
 Get object's metatable. More...
 
void luaGetFieldsTable ()
 Gets the table containing all stored fields of this lua object, the result is pushed onto the stack. More...
 
int getUseCount ()
 
std::string getClassName ()
 Returns the derived class name, its the same name used in Lua. More...
 
LuaObjectPtr asLuaObject ()
 
void operator= (const LuaObject &)
 
- Public Member Functions inherited from stdext::shared_object
 shared_object ()
 
virtual ~shared_object ()
 
void add_ref ()
 
void dec_ref ()
 
refcount_t ref_count ()
 
template<typename T >
stdext::shared_object_ptr< T > static_self_cast ()
 
template<typename T >
stdext::shared_object_ptr< T > dynamic_self_cast ()
 
template<typename T >
stdext::shared_object_ptr< T > const_self_cast ()
 

Additional Inherited Members

- Public Types inherited from Creature
enum  { SHIELD_BLINK_TICKS = 500, VOLATILE_SQUARE_DURATION = 1000 }
 
- Static Public Attributes inherited from Creature
static double speedA = 0
 
static double speedB = 0
 
static double speedC = 0
 
- Protected Member Functions inherited from Creature
void updateWalkingTile ()
 
virtual void updateWalkAnimation ()
 
virtual void updateWalkOffset (int totalPixelsWalked)
 
virtual void updateWalk ()
 
virtual void nextWalkUpdate ()
 
virtual void terminateWalk ()
 
void updateOutfitColor (Color color, Color finalColor, Color delta, int duration)
 
void updateJump ()
 
- Protected Attributes inherited from Creature
uint32 m_id
 
std::string m_name
 
Otc::Direction m_direction
 
Outfit m_outfit
 
Light m_light
 
int m_speed
 
int m_calculatedStepSpeed
 
double m_baseSpeed
 
uint8 m_healthPercent
 
uint8 m_skull
 
uint8 m_shield
 
uint8 m_emblem
 
uint8 m_type
 
uint8 m_icon
 
TexturePtr m_skullTexture
 
TexturePtr m_shieldTexture
 
TexturePtr m_emblemTexture
 
TexturePtr m_typeTexture
 
TexturePtr m_iconTexture
 
stdext::boolean< true > m_showShieldTexture
 
stdext::boolean< false > m_shieldBlink
 
stdext::boolean< false > m_passable
 
stdext::boolean< false > m_showTimedSquare
 
stdext::boolean< false > m_showStaticSquare
 
stdext::boolean< true > m_removed
 
Color m_timedSquareColor
 
Color m_staticSquareColor
 
Color m_informationColor
 
Color m_outfitColor
 
CachedText m_nameCache
 
ScheduledEventPtr m_outfitColorUpdateEvent
 
Timer m_outfitColorTimer
 
std::array< double, Otc::LastSpeedFormulam_speedFormula
 
int m_walkAnimationPhase
 
int m_walkedPixels
 
uint m_footStep
 
Timer m_walkTimer
 
Timer m_footTimer
 
TilePtr m_walkingTile
 
stdext::boolean< false > m_walking
 
stdext::boolean< false > m_allowAppearWalk
 
stdext::boolean< false > m_updateDynamicInformation
 
ScheduledEventPtr m_walkUpdateEvent
 
ScheduledEventPtr m_walkFinishAnimEvent
 
EventPtr m_disappearEvent
 
Point m_walkOffset
 
Otc::Direction m_walkTurnDirection
 
Otc::Direction m_lastStepDirection
 
Position m_lastStepFromPosition
 
Position m_lastStepToPosition
 
Position m_oldPosition
 
float m_jumpHeight
 
float m_jumpDuration
 
PointF m_jumpOffset
 
Timer m_jumpTimer
 
- Protected Attributes inherited from Thing
Position m_position
 
uint16 m_datId
 

Detailed Description

Definition at line 29 of file player.h.

Constructor & Destructor Documentation

◆ Player()

Player::Player ( )
inline

Definition at line 32 of file player.h.

◆ ~Player()

virtual Player::~Player ( )
inlinevirtual

Definition at line 33 of file player.h.

Member Function Documentation

◆ asPlayer()

PlayerPtr Player::asPlayer ( )
inline

Definition at line 35 of file player.h.

◆ isPlayer()

bool Player::isPlayer ( )
inlineoverridevirtual

Reimplemented from Thing.

Definition at line 36 of file player.h.


The documentation for this class was generated from the following file: