RandomMovementGenerator.cpp

Go to the documentation of this file.

/*
 * This file is part of the TrinityCore Project. See AUTHORS file for Copyright information
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program. If not, see <http://www.gnu.org/licenses/>.
 */
 
#include "RandomMovementGenerator.h"
#include "Creature.h"
#include "CreatureAI.h"
#include "MovementDefines.h"
#include "MoveSpline.h"
#include "MoveSplineInit.h"
#include "PathGenerator.h"
#include "Random.h"
 
template<class T>
RandomMovementGenerator<T>::RandomMovementGenerator(float distance, Optional<Milliseconds> duration) : _timer(0), _reference(), _wanderDistance(distance), _wanderSteps(0)
{
 this->Mode = MOTION_MODE_DEFAULT;
 this->Priority = MOTION_PRIORITY_NORMAL;
 this->Flags = MOVEMENTGENERATOR_FLAG_INITIALIZATION_PENDING;
 this->BaseUnitState = UNIT_STATE_ROAMING;
 if (duration)
 _duration.emplace(*duration);
}
 
template RandomMovementGenerator<Creature>::RandomMovementGenerator(float distance, Optional<Milliseconds> duration);
 
template<class T>
MovementGeneratorType RandomMovementGenerator<T>::GetMovementGeneratorType() const
{
 return RANDOM_MOTION_TYPE;
}
 
template<class T>
void RandomMovementGenerator<T>::Pause(uint32 timer)
{
 if (timer)
 {
 this->AddFlag(MOVEMENTGENERATOR_FLAG_TIMED_PAUSED);
 _timer.Reset(timer);
 this->RemoveFlag(MOVEMENTGENERATOR_FLAG_PAUSED);
 }
 else
 {
 this->AddFlag(MOVEMENTGENERATOR_FLAG_PAUSED);
 this->RemoveFlag(MOVEMENTGENERATOR_FLAG_TIMED_PAUSED);
 }
}
 
template<class T>
void RandomMovementGenerator<T>::Resume(uint32 overrideTimer)
{
 if (overrideTimer)
 _timer.Reset(overrideTimer);
 
 this->RemoveFlag(MOVEMENTGENERATOR_FLAG_PAUSED);
}
 
template MovementGeneratorType RandomMovementGenerator<Creature>::GetMovementGeneratorType() const;
 
template<class T>
void RandomMovementGenerator<T>::DoInitialize(T*) { }
 
template<>
void RandomMovementGenerator<Creature>::DoInitialize(Creature* owner)
{
 RemoveFlag(MOVEMENTGENERATOR_FLAG_INITIALIZATION_PENDING | MOVEMENTGENERATOR_FLAG_TRANSITORY | MOVEMENTGENERATOR_FLAG_DEACTIVATED | MOVEMENTGENERATOR_FLAG_TIMED_PAUSED);
 AddFlag(MOVEMENTGENERATOR_FLAG_INITIALIZED);
 
 if (!owner || !owner->IsAlive())
 return;
 
 _reference = owner->GetPosition();
 owner->StopMoving();
 
 if (_wanderDistance == 0.f)
 _wanderDistance = owner->GetWanderDistance();
 
 // Retail seems to let a creature walk 2 up to 10 splines before triggering a pause
 _wanderSteps = urand(2, 10);
 
 _timer.Reset(0);
 _path = nullptr;
}
 
template<class T>
void RandomMovementGenerator<T>::DoReset(T*) { }
 
template<>
void RandomMovementGenerator<Creature>::DoReset(Creature* owner)
{
 RemoveFlag(MOVEMENTGENERATOR_FLAG_TRANSITORY | MOVEMENTGENERATOR_FLAG_DEACTIVATED);
 
 DoInitialize(owner);
}
 
template<class T>
void RandomMovementGenerator<T>::SetRandomLocation(T*) { }
 
template<>
void RandomMovementGenerator<Creature>::SetRandomLocation(Creature* owner)
{
 if (!owner)
 return;
 
 if (owner->HasUnitState(UNIT_STATE_NOT_MOVE | UNIT_STATE_LOST_CONTROL) || owner->IsMovementPreventedByCasting())
 {
 AddFlag(MOVEMENTGENERATOR_FLAG_INTERRUPTED);
 owner->StopMoving();
 _path = nullptr;
 return;
 }
 
 Position position(_reference);
 float distance = _wanderDistance > 0.1f ? frand(0.1f, _wanderDistance) : _wanderDistance;
 float angle = frand(0.f, static_cast<float>(M_PI * 2));
 owner->MovePositionToFirstCollision(position, distance, angle);
 
 // Check if the destination is in LOS
 if (!owner->IsWithinLOS(position.GetPositionX(), position.GetPositionY(), position.GetPositionZ()))
 {
 // Retry later on
 _timer.Reset(200);
 return;
 }
 
 if (!_path)
 {
 _path = std::make_unique<PathGenerator>(owner);
 _path->SetPathLengthLimit(30.0f);
 }
 
 bool result = _path->CalculatePath(position.GetPositionX(), position.GetPositionY(), position.GetPositionZ());
 // PATHFIND_FARFROMPOLY shouldn't be checked as creatures in water are most likely far from poly
 if (!result || (_path->GetPathType() & PATHFIND_NOPATH)
 || (_path->GetPathType() & PATHFIND_SHORTCUT)
 /*|| (_path->GetPathType() & PATHFIND_FARFROMPOLY)*/)
 {
 _timer.Reset(100);
 return;
 }
 
 if (_path->GetPathLength() < 0.1f)
 {
 // the path is too short for the spline system to be accepted. Let's try again soon.
 _timer.Reset(500);
 return;
 }
 
 RemoveFlag(MOVEMENTGENERATOR_FLAG_TRANSITORY | MOVEMENTGENERATOR_FLAG_TIMED_PAUSED);
 
 owner->AddUnitState(UNIT_STATE_ROAMING_MOVE);
 
 bool walk = true;
 switch (owner->GetMovementTemplate().GetRandom())
 {
 case CreatureRandomMovementType::CanRun:
 walk = owner->IsWalking();
 break;
 case CreatureRandomMovementType::AlwaysRun:
 walk = false;
 break;
 default:
 break;
 }
 
 Movement::MoveSplineInit init(owner);
 init.MovebyPath(_path->GetPath());
 init.SetWalk(walk);
 int32 splineDuration = init.Launch();
 
 --_wanderSteps;
 if (_wanderSteps) // Creature has yet to do steps before pausing
 _timer.Reset(splineDuration);
 else
 {
 // Creature has made all its steps, time for a little break
 _timer.Reset(splineDuration + urand(4, 10) * IN_MILLISECONDS); // Retails seems to use rounded numbers so we do as well
 _wanderSteps = urand(2, 10);
 }
 
 // Call for creature group update
 owner->SignalFormationMovement();
}
 
template<class T>
bool RandomMovementGenerator<T>::DoUpdate(T*, uint32)
{
 return false;
}
 
template<>
bool RandomMovementGenerator<Creature>::DoUpdate(Creature* owner, uint32 diff)
{
 if (!owner || !owner->IsAlive())
 return true;
 
 if (HasFlag(MOVEMENTGENERATOR_FLAG_FINALIZED | MOVEMENTGENERATOR_FLAG_PAUSED))
 return true;
 
 if (_duration)
 {
 _duration->Update(diff);
 if (_duration->Passed())
 {
 RemoveFlag(MOVEMENTGENERATOR_FLAG_TRANSITORY);
 AddFlag(MOVEMENTGENERATOR_FLAG_INFORM_ENABLED);
 return false;
 }
 }
 
 if (owner->HasUnitState(UNIT_STATE_NOT_MOVE) || owner->IsMovementPreventedByCasting())
 {
 AddFlag(MOVEMENTGENERATOR_FLAG_INTERRUPTED);
 owner->StopMoving();
 _path = nullptr;
 return true;
 }
 else
 RemoveFlag(MOVEMENTGENERATOR_FLAG_INTERRUPTED);
 
 _timer.Update(diff);
 if ((HasFlag(MOVEMENTGENERATOR_FLAG_SPEED_UPDATE_PENDING) && !owner->movespline->Finalized()) || (_timer.Passed() && owner->movespline->Finalized()))
 SetRandomLocation(owner);
 
 return true;
}
 
template<class T>
void RandomMovementGenerator<T>::DoDeactivate(T*) { }
 
template<>
void RandomMovementGenerator<Creature>::DoDeactivate(Creature* owner)
{
 AddFlag(MOVEMENTGENERATOR_FLAG_DEACTIVATED);
 owner->ClearUnitState(UNIT_STATE_ROAMING_MOVE);
}
 
template<class T>
void RandomMovementGenerator<T>::DoFinalize(T*, bool, bool) { }
 
template<>
void RandomMovementGenerator<Creature>::DoFinalize(Creature* owner, bool active, bool movementInform)
{
 AddFlag(MOVEMENTGENERATOR_FLAG_FINALIZED);
 if (active)
 {
 owner->ClearUnitState(UNIT_STATE_ROAMING_MOVE);
 owner->StopMoving();
 
 // TODO: Research if this modification is needed, which most likely isnt
 owner->SetWalk(false);
 }
 
 if (movementInform && HasFlag(MOVEMENTGENERATOR_FLAG_INFORM_ENABLED))
 if (owner->IsAIEnabled())
 owner->AI()->MovementInform(RANDOM_MOTION_TYPE, 0);
}