#include "Action.h" #include #include #include "Framework.h" #include "Script/ScriptMgr.h" #include #include "Actor/Player.h" #include "Actor/BNpc.h" #include "Territory/Zone.h" #include #include "Network/PacketWrappers/ActorControlPacket142.h" #include "Network/PacketWrappers/ActorControlPacket143.h" #include "Network/PacketWrappers/ActorControlPacket144.h" #include #include #include using namespace Sapphire::Common; using namespace Sapphire::Network; using namespace Sapphire::Network::Packets; using namespace Sapphire::Network::Packets::Server; using namespace Sapphire::Network::ActorControl; Sapphire::Action::Action::Action() = default; Sapphire::Action::Action::~Action() = default; Sapphire::Action::Action::Action( Entity::CharaPtr caster, uint32_t actionId, FrameworkPtr fw ) : Action( std::move( caster ), actionId, nullptr, std::move( fw ) ) { } Sapphire::Action::Action::Action( Entity::CharaPtr caster, uint32_t actionId, Data::ActionPtr actionData, FrameworkPtr fw ) : m_pSource( std::move( caster ) ), m_pFw( std::move( fw ) ), m_actionData( std::move( actionData ) ), m_id( actionId ), m_targetId( 0 ), m_startTime( 0 ), m_interruptType( Common::ActionInterruptType::None ) { } uint32_t Sapphire::Action::Action::getId() const { return m_id; } bool Sapphire::Action::Action::init() { if( !m_actionData ) { // need to get actionData auto exdData = m_pFw->get< Data::ExdDataGenerated >(); assert( exdData ); auto actionData = exdData->get< Data::Action >( m_id ); assert( actionData ); m_actionData = actionData; } m_castTimeMs = static_cast< uint32_t >( m_actionData->cast100ms * 100 ); m_recastTimeMs = static_cast< uint32_t >( m_actionData->recast100ms * 100 ); m_cooldownGroup = m_actionData->cooldownGroup; m_range = m_actionData->range; m_effectRange = m_actionData->effectRange; m_castType = static_cast< Common::CastType >( m_actionData->castType ); m_aspect = static_cast< Common::ActionAspect >( m_actionData->aspect ); // todo: move this to bitset m_canTargetSelf = m_actionData->canTargetSelf; m_canTargetParty = m_actionData->canTargetParty; m_canTargetFriendly = m_actionData->canTargetFriendly; m_canTargetHostile = m_actionData->canTargetHostile; // todo: this one doesn't look right based on whats in that col, probably has shifted m_canTargetDead = m_actionData->canTargetDead; // a default range is set by the game for the class/job if( m_range == -1 ) { switch( static_cast< Common::ClassJob >( m_actionData->classJob ) ) { case Common::ClassJob::Bard: case Common::ClassJob::Archer: m_range = 25; // anything that isnt ranged default: m_range = 3; } } m_primaryCostType = static_cast< Common::ActionPrimaryCostType >( m_actionData->costType ); m_primaryCost = m_actionData->cost; if( !m_actionData->targetArea ) { // override pos to target position // todo: this is kinda dirty for( auto& actor : m_pSource->getInRangeActors() ) { if( actor->getId() == m_targetId ) { m_pos = actor->getPos(); break; } } } // todo: add missing rows for secondaryCostType/secondaryCostType and rename the current rows to primaryCostX addDefaultActorFilters(); return true; } void Sapphire::Action::Action::setPos( Sapphire::Common::FFXIVARR_POSITION3 pos ) { m_pos = pos; } Sapphire::Common::FFXIVARR_POSITION3 Sapphire::Action::Action::getPos() const { return m_pos; } void Sapphire::Action::Action::setTargetId( uint64_t targetId ) { m_targetId = targetId; } uint64_t Sapphire::Action::Action::getTargetId() const { return m_targetId; } bool Sapphire::Action::Action::hasClientsideTarget() const { return m_targetId > 0xFFFFFFFF; } bool Sapphire::Action::Action::isInterrupted() const { return m_interruptType != Common::ActionInterruptType::None; } void Sapphire::Action::Action::setInterrupted( Common::ActionInterruptType type ) { m_interruptType = type; } uint32_t Sapphire::Action::Action::getCastTime() const { return m_castTimeMs; } void Sapphire::Action::Action::setCastTime( uint32_t castTime ) { m_castTimeMs = castTime; } bool Sapphire::Action::Action::hasCastTime() const { return m_castTimeMs > 0; } Sapphire::Entity::CharaPtr Sapphire::Action::Action::getSourceChara() const { return m_pSource; } bool Sapphire::Action::Action::update() { // action has not been started yet if( m_startTime == 0 ) return false; if( isInterrupted() ) { interrupt(); return true; } if( !hasClientsideTarget() ) { // todo: check if the target is still in range } uint64_t tickCount = Util::getTimeMs(); if( !hasCastTime() || std::difftime( tickCount, m_startTime ) > m_castTimeMs ) { execute(); return true; } return false; } void Sapphire::Action::Action::start() { assert( m_pSource ); m_startTime = Util::getTimeMs(); auto player = m_pSource->getAsPlayer(); if( hasCastTime() ) { auto castPacket = makeZonePacket< Server::FFXIVIpcActorCast >( getId() ); castPacket->data().action_id = static_cast< uint16_t >( m_id ); castPacket->data().skillType = Common::SkillType::Normal; castPacket->data().unknown_1 = m_id; // This is used for the cast bar above the target bar of the caster. castPacket->data().cast_time = m_castTimeMs / 1000.f; castPacket->data().target_id = static_cast< uint32_t >( m_targetId ); m_pSource->sendToInRangeSet( castPacket, true ); if( player ) { player->setStateFlag( PlayerStateFlag::Casting ); } } // todo: m_recastTimeMs needs to be adjusted for player sks/sps auto actionStartPkt = makeActorControl143( m_pSource->getId(), ActorControlType::ActionStart, 1, getId(), m_recastTimeMs / 10 ); player->queuePacket( actionStartPkt ); auto pScriptMgr = m_pFw->get< Scripting::ScriptMgr >(); if( !pScriptMgr->onStart( *this ) ) { // script not implemented interrupt(); if( player ) { player->sendUrgent( "Action not implemented, missing script for action#{0}", getId() ); player->setCurrentAction( nullptr ); } return; } // instantly finish cast if there's no cast time if( !hasCastTime() ) execute(); } void Sapphire::Action::Action::interrupt() { assert( m_pSource ); // things that aren't players don't care about cooldowns and state flags if( m_pSource->isPlayer() ) { auto player = m_pSource->getAsPlayer(); // todo: reset cooldown for actual player // reset state flag //player->unsetStateFlag( PlayerStateFlag::Occupied1 ); player->unsetStateFlag( PlayerStateFlag::Casting ); } if( hasCastTime() ) { uint8_t interruptEffect = 0; if( m_interruptType == ActionInterruptType::DamageInterrupt ) interruptEffect = 1; // Note: When cast interrupt from taking too much damage, set the last value to 1. // This enables the cast interrupt effect. auto control = makeActorControl142( m_pSource->getId(), ActorControlType::CastInterrupt, 0x219, 1, m_id, interruptEffect ); m_pSource->sendToInRangeSet( control, true ); } auto pScriptMgr = m_pFw->get< Scripting::ScriptMgr >(); pScriptMgr->onInterrupt( *this ); } void Sapphire::Action::Action::execute() { assert( m_pSource ); // subtract costs first, if somehow the caster stops meeting those requirements cancel the cast if( !consumeResources() ) { interrupt(); return; } auto pScriptMgr = m_pFw->get< Scripting::ScriptMgr >(); if( hasCastTime() ) { // todo: what's this? /*auto control = ActorControlPacket143( m_pTarget->getId(), ActorControlType::Unk7, 0x219, m_id, m_id, m_id, m_id ); m_pSource->sendToInRangeSet( control, true );*/ if( auto player = m_pSource->getAsPlayer() ) { player->unsetStateFlag( PlayerStateFlag::Casting ); } } if( isComboAction() ) { auto player = m_pSource->getAsPlayer(); player->sendDebug( "action combo success from action#{0}", player->getLastComboActionId() ); } if( !hasClientsideTarget() ) { snapshotAffectedActors( m_hitActors ); if( !m_hitActors.empty() ) { // only call script if actors are hit pScriptMgr->onExecute( *this ); } } else if( auto player = m_pSource->getAsPlayer() ) { pScriptMgr->onEObjHit( *player, m_targetId, getId() ); return; } // set currently casted action as the combo action if it interrupts a combo // ignore it otherwise (ogcds, etc.) if( !m_actionData->preservesCombo ) { m_pSource->setLastComboActionId( getId() ); } } bool Sapphire::Action::Action::precheck() { if( auto player = m_pSource->getAsPlayer() ) { if( !playerPrecheck( *player ) ) return false; } return true; } bool Sapphire::Action::Action::playerPrecheck( Entity::Player& player ) { // lol if( !player.isAlive() ) return false; // npc actions/non player actions if( m_actionData->classJob == -1 ) return false; if( player.getLevel() < m_actionData->classJobLevel ) return false; auto currentClass = player.getClass(); auto actionClass = static_cast< Common::ClassJob >( m_actionData->classJob ); if( actionClass != Common::ClassJob::Adventurer && currentClass != actionClass ) { // check if not a base class action auto exdData = m_pFw->get< Data::ExdDataGenerated >(); assert( exdData ); auto classJob = exdData->get< Data::ClassJob >( static_cast< uint8_t >( currentClass ) ); if( !classJob ) return false; if( classJob->classJobParent != m_actionData->classJob ) return false; } // reset target on actions that can only be casted on yourself while having a target set // todo: check what actions send when targeting an enemy // if( m_actionData->canTargetSelf && // !m_actionData->canTargetFriendly && // !m_actionData->canTargetHostile && // !m_actionData->canTargetParty ) // { // setTargetId( getSourceChara() ); // } // todo: party/enemy validation // validate range if( !hasResources() ) return false; return true; } uint32_t Sapphire::Action::Action::getAdditionalData() const { return m_additionalData; } void Sapphire::Action::Action::setAdditionalData( uint32_t data ) { m_additionalData = data; } bool Sapphire::Action::Action::isComboAction() const { auto lastActionId = m_pSource->getLastComboActionId(); if( lastActionId == 0 ) { return false; } return m_actionData->actionCombo == lastActionId; } bool Sapphire::Action::Action::primaryCostCheck( bool subtractCosts ) { switch( m_primaryCostType ) { case Common::ActionPrimaryCostType::TacticsPoints: { auto curTp = m_pSource->getTp(); if( curTp < m_primaryCost ) return false; if( subtractCosts ) m_pSource->setTp( curTp - m_primaryCost ); return true; } case Common::ActionPrimaryCostType::MagicPoints: { auto curMp = m_pSource->getMp(); auto cost = Math::CalcStats::calculateMpCost( *m_pSource, m_primaryCost ); if( curMp < cost ) return false; if( subtractCosts ) m_pSource->setMp( curMp - cost ); return true; } // free casts, likely just pure ogcds case Common::ActionPrimaryCostType::None: { return true; } default: return false; } } bool Sapphire::Action::Action::secondaryCostCheck( bool subtractCosts ) { // todo: these need to be mapped return true; } bool Sapphire::Action::Action::hasResources() { return primaryCostCheck( false ) && secondaryCostCheck( false ); } bool Sapphire::Action::Action::consumeResources() { return primaryCostCheck( true ) && secondaryCostCheck( true ); } bool Sapphire::Action::Action::snapshotAffectedActors( std::vector< Entity::CharaPtr >& actors ) { for( const auto& actor : m_pSource->getInRangeActors() ) { // check for initial target validity based on flags in action exd (pc/enemy/etc.) if( !preFilterActor( *actor ) ) continue; for( const auto& filter : m_actorFilters ) { if( filter->conditionApplies( *actor ) ) { actors.push_back( actor->getAsChara() ); break; } } } if( auto player = m_pSource->getAsPlayer() ) { player->sendDebug( "Hit {} actors with {} filters", actors.size(), m_actorFilters.size() ); for( const auto& actor : actors ) { player->sendDebug( "hit actor#{}", actor->getId() ); } } if( actors.empty() ) return false; return true; } void Sapphire::Action::Action::addActorFilter( World::Util::ActorFilterPtr filter ) { m_actorFilters.push_back( std::move( filter ) ); } void Sapphire::Action::Action::addDefaultActorFilters() { switch( m_castType ) { case Common::CastType::SingleTarget: { auto filter = std::make_shared< World::Util::ActorFilterSingleTarget >( static_cast< uint32_t >( m_targetId ) ); addActorFilter( filter ); break; } case Common::CastType::CircularAOE: { auto filter = std::make_shared< World::Util::ActorFilterInRange >( m_pos, m_effectRange ); addActorFilter( filter ); break; } // case Common::CastType::RectangularAOE: // { // break; // } default: { Logger::error( "[{}] Action#{} has CastType#{} but that cast type is unhandled. Cancelling cast.", m_pSource->getId(), getId(), m_castType ); interrupt(); } } } bool Sapphire::Action::Action::preFilterActor( Sapphire::Entity::Actor& actor ) const { auto kind = actor.getObjKind(); // todo: are there any server side eobjs that players can hit? if( kind != ObjKind::BattleNpc && kind != ObjKind::Player ) return false; // todo: handle things such based on canTargetX return true; } std::vector< Sapphire::Entity::CharaPtr >& Sapphire::Action::Action::getHitCharas() { return m_hitActors; } Sapphire::Entity::CharaPtr Sapphire::Action::Action::getHitChara() { if( !m_hitActors.empty() ) { return m_hitActors.at( 0 ); } return nullptr; }