mirror of
https://github.com/SapphireServer/Sapphire.git
synced 2025-04-28 15:17:46 +00:00
139 lines
3.4 KiB
C++
139 lines
3.4 KiB
C++
#ifndef _ACTION_H_
|
|
#define _ACTION_H_
|
|
|
|
#include <Common.h>
|
|
#include "ForwardsZone.h"
|
|
#include <array>
|
|
|
|
namespace Sapphire::Data
|
|
{
|
|
struct Action;
|
|
using ActionPtr = std::shared_ptr< Action >;
|
|
}
|
|
|
|
namespace Sapphire::Action
|
|
{
|
|
|
|
class Action
|
|
{
|
|
|
|
public:
|
|
|
|
Action();
|
|
Action( Entity::CharaPtr caster, uint32_t actionId, FrameworkPtr fw );
|
|
Action( Entity::CharaPtr caster, uint32_t actionId, Data::ActionPtr actionData, FrameworkPtr fw );
|
|
|
|
virtual ~Action();
|
|
|
|
uint32_t getId() const;
|
|
|
|
bool init();
|
|
|
|
void setPos( Common::FFXIVARR_POSITION3 pos );
|
|
Common::FFXIVARR_POSITION3 getPos() const;
|
|
|
|
void setTargetId( uint64_t targetId );
|
|
uint64_t getTargetId() const;
|
|
Entity::CharaPtr getSourceChara() const;
|
|
|
|
bool isInterrupted() const;
|
|
void setInterrupted( Common::ActionInterruptType type );
|
|
|
|
uint32_t getCastTime() const;
|
|
void setCastTime( uint32_t castTime );
|
|
|
|
uint32_t getAdditionalData() const;
|
|
void setAdditionalData( uint32_t data );
|
|
|
|
bool isComboAction() const;
|
|
|
|
/*!
|
|
* @brief Checks whether the source chara has the required stats/debuffs/etc to cast an action.
|
|
* @param subtractCosts Whether we should subtract the costs (eg, mp/tp) from the player or to just check them
|
|
* @return whether the requirements are met by the caster
|
|
*/
|
|
bool costCheck( bool subtractCosts = false );
|
|
|
|
bool hasResources();
|
|
|
|
bool consumeResources();
|
|
|
|
/*!
|
|
* @brief Checks if the action *may* target a resident instead of an actor
|
|
* @return true if the target *may* be a resident and not an actor, otherwise false.
|
|
*/
|
|
bool hasClientsideTarget() const;
|
|
|
|
/*!
|
|
* @brief Tests whether the action is instantly usable or has a cast assoc'd with it
|
|
* @return true if action has a cast time
|
|
*/
|
|
bool hasCastTime() const;
|
|
|
|
/*!
|
|
* @brief Tests if an action is castable by the current source chara
|
|
* @return true if castable, false if the caster doesn't meet the requirements
|
|
*/
|
|
bool precheck();
|
|
|
|
/*!
|
|
* @brief Starts the cast. Finishes it immediately if there is no cast time (weaponskills).
|
|
*/
|
|
virtual void start();
|
|
|
|
/*!
|
|
* @brief Finishes the cast, effected targets are calculated here.
|
|
*/
|
|
virtual void execute();
|
|
|
|
/*!
|
|
* @brief Called when a cast is interrupted for any reason
|
|
*
|
|
* m_interruptType will have the reason why the action was interrupted (eg. damage, movement, ...)
|
|
*/
|
|
virtual void interrupt();
|
|
|
|
/*!
|
|
* @brief Called on each player update tick
|
|
* @return true if a cast has finished and should be removed from the owning chara
|
|
*/
|
|
virtual bool update();
|
|
|
|
protected:
|
|
|
|
void calculateActionCost();
|
|
|
|
bool primaryCostCheck( bool subtractCosts );
|
|
bool secondaryCostCheck( bool subtractCosts );
|
|
|
|
bool playerPrecheck( Entity::Player& player );
|
|
|
|
uint32_t m_id;
|
|
|
|
Common::ActionPrimaryCostType m_primaryCostType;
|
|
uint16_t m_primaryCost;
|
|
|
|
uint64_t m_startTime;
|
|
uint32_t m_castTimeMs;
|
|
uint32_t m_recastTimeMs;
|
|
uint8_t m_cooldownGroup;
|
|
int8_t m_range;
|
|
uint8_t m_effectRange;
|
|
Common::ActionAspect m_aspect;
|
|
|
|
uint32_t m_additionalData;
|
|
|
|
Entity::CharaPtr m_pSource;
|
|
Entity::CharaPtr m_pTarget;
|
|
uint64_t m_targetId;
|
|
|
|
Common::ActionInterruptType m_interruptType;
|
|
|
|
FrameworkPtr m_pFw;
|
|
Data::ActionPtr m_actionData;
|
|
|
|
Common::FFXIVARR_POSITION3 m_pos;
|
|
};
|
|
}
|
|
|
|
#endif
|