WaypointMovementGenerator< T > Class Template Reference

#include <WaypointMovementGenerator.h>

Inheritance diagram for WaypointMovementGenerator< T >:

Public Member Functions
	WaypointMovementGenerator (uint32 pathId, bool repeating, Optional< Milliseconds > duration={}, Optional< float > speed={}, MovementWalkRunSpeedSelectionMode speedSelectionMode=MovementWalkRunSpeedSelectionMode::Default, Optional< std::pair< Milliseconds, Milliseconds > > waitTimeRangeAtPathEnd={}, Optional< float > wanderDistanceAtPathEnds={}, Optional< bool > followPathBackwardsFromEndToStart={}, Optional< bool > exactSplinePath={}, bool generatePath=true, Optional< MovementFadeObject > fadeObject={}, Scripting::v2::ActionResultSetter< MovementStopReason > &&scriptResult={})
	WaypointMovementGenerator (WaypointPath const &path, bool repeating, Optional< Milliseconds > duration, Optional< float > speed, MovementWalkRunSpeedSelectionMode speedSelectionMode, Optional< std::pair< Milliseconds, Milliseconds > > waitTimeRangeAtPathEnd, Optional< float > wanderDistanceAtPathEnds, Optional< bool > followPathBackwardsFromEndToStart, Optional< bool > exactSplinePath, bool generatePath, Optional< MovementFadeObject > fadeObject, Scripting::v2::ActionResultSetter< MovementStopReason > &&scriptResult={})
	~WaypointMovementGenerator ()
MovementGeneratorType	GetMovementGeneratorType () const override
void	UnitSpeedChanged () override
void	Pause (uint32 timer) override
void	Resume (uint32 overrideTimer) override
bool	GetResetPosition (Unit *, float &x, float &y, float &z) override
bool	DoInitialize (T *owner)
bool	DoReset (T *owner)
bool	DoUpdate (T *owner, uint32 diff)
void	DoDeactivate (T *owner)
void	DoFinalize (T *owner, bool active, bool movementInform)
WaypointPath const *	GetPath () const
std::string	GetDebugInfo () const override
Public Member Functions inherited from MovementGeneratorMedium< T, WaypointMovementGenerator< T > >
bool	Initialize (Unit *owner) override
bool	Reset (Unit *owner) override
bool	Update (Unit *owner, uint32 diff) override
void	Deactivate (Unit *owner) override
void	Finalize (Unit *owner, bool active, bool movementInform) override
Public Member Functions inherited from MovementGenerator
	MovementGenerator ()
	MovementGenerator (MovementGenerator const &)=delete
	MovementGenerator (MovementGenerator &&)=delete
MovementGenerator &	operator= (MovementGenerator const &)=delete
MovementGenerator &	operator= (MovementGenerator &&)=delete
virtual	~MovementGenerator ()
void	AddFlag (uint16 const flag)
bool	HasFlag (uint16 const flag) const
void	RemoveFlag (uint16 const flag)
Public Member Functions inherited from PathMovementBase< BasePath >
	PathMovementBase ()
	PathMovementBase (PathType &&path)
virtual	~PathMovementBase ()=default
uint32	GetCurrentNode () const

Private Member Functions
void	MovementInform (T const *owner) const
void	OnArrived (T *owner)
void	StartMove (T *owner, bool relaunch=false)
bool	ComputeNextNode ()
bool	UpdateMoveTimer (uint32 diff)
bool	UpdateWaitTimer (uint32 diff)
bool	IsFollowingPathBackwardsFromEndToStart () const
bool	IsExactSplinePath () const
bool	IsCyclic () const
bool	IsLoadedFromDB () const
void	MovementInform (Creature const *owner) const

Static Private Member Functions
static bool	UpdateTimer (TimeTracker &timer, uint32 diff)

Private Attributes
Optional< TimeTracker >	_duration
Optional< float >	_speed
MovementWalkRunSpeedSelectionMode	_speedSelectionMode
Optional< std::pair< Milliseconds, Milliseconds > >	_waitTimeRangeAtPathEnd
Optional< float >	_wanderDistanceAtPathEnds
Optional< bool >	_followPathBackwardsFromEndToStart
Optional< bool >	_exactSplinePath
bool	_repeating
bool	_generatePath
Optional< MovementFadeObject >	_fadeObject
TimeTracker	_moveTimer
TimeTracker	_nextMoveTime
std::vector< int32 >	_waypointTransitionSplinePoints
uint32	_waypointTransitionSplinePointsIndex
bool	_isReturningToStart

Additional Inherited Members
Public Types inherited from PathMovementBase< BasePath >
using	PathType = BasePath
Public Attributes inherited from MovementGenerator
uint8	Priority
uint16	Flags
uint32	BaseUnitState
Scripting::v2::ActionResultSetter< MovementStopReason >	ScriptResult
Protected Member Functions inherited from MovementGenerator
void	SetScriptResult (MovementStopReason reason)
Protected Attributes inherited from PathMovementBase< BasePath >
PathType	_path
uint32	_currentNode

Detailed Description

template<typename T>
class WaypointMovementGenerator< T >

Definition at line 30 of file WaypointMovementGenerator.h.

Constructor & Destructor Documentation

WaypointMovementGenerator() [1/2]

template<typename T >

WaypointMovementGenerator< T >::WaypointMovementGenerator ( uint32  pathId, bool  repeating, Optional< Milliseconds >  duration = {}, Optional< float >  speed = {}, MovementWalkRunSpeedSelectionMode  speedSelectionMode = MovementWalkRunSpeedSelectionMode::Default, Optional< std::pair< Milliseconds, Milliseconds > >  waitTimeRangeAtPathEnd = {}, Optional< float >  wanderDistanceAtPathEnds = {}, Optional< bool >  followPathBackwardsFromEndToStart = {}, Optional< bool >  exactSplinePath = {}, bool  generatePath = true, Optional< MovementFadeObject >  fadeObject = {}, Scripting::v2::ActionResultSetter< MovementStopReason > &&  scriptResult = {}  )

explicit

Definition at line 39 of file WaypointMovementGenerator.cpp.

References WaypointMovementGenerator< T >::_duration, MovementGenerator::BaseUnitState, MovementGenerator::Flags, MOTION_PRIORITY_NORMAL, MOVEMENTGENERATOR_FLAG_INITIALIZATION_PENDING, MovementGenerator::Priority, MovementGenerator::ScriptResult, and UNIT_STATE_ROAMING.

WaypointMovementGenerator() [2/2]

template<typename T >

WaypointMovementGenerator< T >::WaypointMovementGenerator ( WaypointPath const &  path, bool  repeating, Optional< Milliseconds >  duration, Optional< float >  speed, MovementWalkRunSpeedSelectionMode  speedSelectionMode, Optional< std::pair< Milliseconds, Milliseconds > >  waitTimeRangeAtPathEnd, Optional< float >  wanderDistanceAtPathEnds, Optional< bool >  followPathBackwardsFromEndToStart, Optional< bool >  exactSplinePath, bool  generatePath, Optional< MovementFadeObject >  fadeObject, Scripting::v2::ActionResultSetter< MovementStopReason > &&  scriptResult = {}  )

explicit

Definition at line 58 of file WaypointMovementGenerator.cpp.

References WaypointMovementGenerator< T >::_duration, PathMovementBase< BasePath >::_path, MovementGenerator::BaseUnitState, MovementGenerator::Flags, MOTION_PRIORITY_NORMAL, MOVEMENTGENERATOR_FLAG_INITIALIZATION_PENDING, MovementGenerator::Priority, MovementGenerator::ScriptResult, and UNIT_STATE_ROAMING.

~WaypointMovementGenerator()

template<typename T >

WaypointMovementGenerator< T >::~WaypointMovementGenerator ( )

default

Member Function Documentation

ComputeNextNode()

template<typename T >

bool WaypointMovementGenerator< T >::ComputeNextNode ( )

private

Definition at line 677 of file WaypointMovementGenerator.cpp.

References WaypointPath::Nodes, and WAYPOINT_PATH_FLAG_FOLLOW_PATH_BACKWARDS_MINIMUM_NODES.

DoDeactivate()

template<typename T >

void WaypointMovementGenerator< T >::DoDeactivate

(

T *

owner

)

Definition at line 290 of file WaypointMovementGenerator.cpp.

References MOVEMENTGENERATOR_FLAG_DEACTIVATED, and UNIT_STATE_ROAMING_MOVE.

DoFinalize()

template<typename T >

void WaypointMovementGenerator< T >::DoFinalize	(	T *	owner,
		bool	active,
		bool	movementInform
	)

Definition at line 297 of file WaypointMovementGenerator.cpp.

References Finished, MOVEMENTGENERATOR_FLAG_FINALIZED, and UNIT_STATE_ROAMING_MOVE.

DoInitialize()

template<typename T >

bool WaypointMovementGenerator< T >::DoInitialize

(

T *

owner

)

Definition at line 138 of file WaypointMovementGenerator.cpp.

References MOVEMENTGENERATOR_FLAG_DEACTIVATED, MOVEMENTGENERATOR_FLAG_INITIALIZATION_PENDING, MOVEMENTGENERATOR_FLAG_TRANSITORY, WaypointPath::Nodes, and TC_LOG_ERROR.

DoReset()

template<typename T >

bool WaypointMovementGenerator< T >::DoReset

(

T *

owner

)

Definition at line 159 of file WaypointMovementGenerator.cpp.

References MOVEMENTGENERATOR_FLAG_DEACTIVATED, MOVEMENTGENERATOR_FLAG_FINALIZED, and MOVEMENTGENERATOR_FLAG_TRANSITORY.

DoUpdate()

template<typename T >

bool WaypointMovementGenerator< T >::DoUpdate	(	T *	owner,
		uint32	diff
	)

Definition at line 171 of file WaypointMovementGenerator.cpp.

References Finished, WaypointPath::Id, MOVEMENTGENERATOR_FLAG_FINALIZED, MOVEMENTGENERATOR_FLAG_INFORM_ENABLED, MOVEMENTGENERATOR_FLAG_INITIALIZED, MOVEMENTGENERATOR_FLAG_INTERRUPTED, MOVEMENTGENERATOR_FLAG_PAUSED, MOVEMENTGENERATOR_FLAG_SPEED_UPDATE_PENDING, MOVEMENTGENERATOR_FLAG_TRANSITORY, WaypointPath::Nodes, UNIT_STATE_LOST_CONTROL, and UNIT_STATE_NOT_MOVE.

GetDebugInfo()

template<typename T >

std::string WaypointMovementGenerator< T >::GetDebugInfo ( ) const

overridevirtual

Reimplemented from MovementGenerator.

Definition at line 736 of file WaypointMovementGenerator.cpp.

References PathMovementBase< BasePath >::GetDebugInfo(), and Trinity::StringFormat().

GetMovementGeneratorType()

template<typename T >

MovementGeneratorType WaypointMovementGenerator< T >::GetMovementGeneratorType ( ) const

overridevirtual

Implements MovementGenerator.

Definition at line 82 of file WaypointMovementGenerator.cpp.

References WAYPOINT_MOTION_TYPE.

GetPath()

template<typename T >

WaypointPath const * WaypointMovementGenerator< T >::GetPath ( ) const

inline

Definition at line 61 of file WaypointMovementGenerator.h.

References PathMovementBase< BasePath >::_path.

GetResetPosition()

template<typename T >

bool WaypointMovementGenerator< T >::GetResetPosition ( Unit *  , float &  x, float &  y, float &  z  )

overridevirtual

Reimplemented from MovementGenerator.

Definition at line 121 of file WaypointMovementGenerator.cpp.

References ASSERT, WaypointPath::Id, WaypointPath::Nodes, Nodes, WaypointNode::X, WaypointNode::Y, and WaypointNode::Z.

IsCyclic()

template<typename T >

bool WaypointMovementGenerator< T >::IsCyclic ( ) const

private

Definition at line 727 of file WaypointMovementGenerator.cpp.

IsExactSplinePath()

template<typename T >

bool WaypointMovementGenerator< T >::IsExactSplinePath ( ) const

private

Definition at line 718 of file WaypointMovementGenerator.cpp.

References ExactSplinePath.

IsFollowingPathBackwardsFromEndToStart()

template<typename T >

bool WaypointMovementGenerator< T >::IsFollowingPathBackwardsFromEndToStart ( ) const

private

Definition at line 709 of file WaypointMovementGenerator.cpp.

References FollowPathBackwardsFromEndToStart.

IsLoadedFromDB()

template<typename T >

bool WaypointMovementGenerator< T >::IsLoadedFromDB ( ) const

inlineprivate

Definition at line 87 of file WaypointMovementGenerator.h.

References PathMovementBase< BasePath >::_path.

MovementInform() [1/2]

void WaypointMovementGenerator< Creature >::MovementInform ( Creature const *  owner ) const

private

Definition at line 319 of file WaypointMovementGenerator.cpp.

References Creature::AI(), WaypointNode::Id, WaypointPath::Id, WaypointPath::Nodes, and WAYPOINT_MOTION_TYPE.

MovementInform() [2/2]

template<typename T >

void WaypointMovementGenerator< T >::MovementInform ( T const *  owner ) const

private

Definition at line 314 of file WaypointMovementGenerator.cpp.

OnArrived()

template<typename T >

void WaypointMovementGenerator< T >::OnArrived ( T *  owner )

private

Definition at line 331 of file WaypointMovementGenerator.cpp.

References ASSERT, WaypointNode::Delay, WaypointNode::Id, WaypointPath::Id, MOTION_SLOT_ACTIVE, WaypointPath::Nodes, Nodes, randtime(), and UNIT_STATE_ROAMING_MOVE.

Pause()

template<typename T >

void WaypointMovementGenerator< T >::Pause ( uint32  timer )

overridevirtual

Reimplemented from MovementGenerator.

Definition at line 88 of file WaypointMovementGenerator.cpp.

References MOVEMENTGENERATOR_FLAG_PAUSED, and MOVEMENTGENERATOR_FLAG_TIMED_PAUSED.

Resume()

template<typename T >

void WaypointMovementGenerator< T >::Resume ( uint32  overrideTimer )

overridevirtual

Reimplemented from MovementGenerator.

Definition at line 109 of file WaypointMovementGenerator.cpp.

References MOVEMENTGENERATOR_FLAG_PAUSED.

StartMove()

template<typename T >

void WaypointMovementGenerator< T >::StartMove ( T *  owner, bool  relaunch = false  )

private

If creature is on transport, we assume waypoints set in DB are already transport offsets

Definition at line 467 of file WaypointMovementGenerator.cpp.

References ASSERT, WaypointPath::ContinuousSegments, Default, WaypointNode::Delay, Movement::MoveSplineInit::DisableTransportPathTransformations(), Finished, Fly, ForceRun, ForceWalk, Ground, WaypointNode::Id, WaypointPath::Id, Land, Movement::MoveSplineInit::Launch(), Movement::MoveSplineInit::MovebyPath(), MOVEMENTGENERATOR_FLAG_FINALIZED, MOVEMENTGENERATOR_FLAG_INFORM_ENABLED, MOVEMENTGENERATOR_FLAG_INITIALIZED, MOVEMENTGENERATOR_FLAG_TIMED_PAUSED, MOVEMENTGENERATOR_FLAG_TRANSITORY, WaypointNode::MoveType, WaypointPath::MoveType, WaypointPath::Nodes, Nodes, WaypointNode::Orientation, Run, Movement::MoveSplineInit::SetAnimation(), Movement::MoveSplineInit::SetCyclic(), Movement::MoveSplineInit::SetFacing(), Movement::MoveSplineInit::SetFadeObject(), Movement::MoveSplineInit::SetFly(), Movement::MoveSplineInit::SetSmooth(), Movement::MoveSplineInit::SetVelocity(), Movement::MoveSplineInit::SetWalk(), TakeOff, UNIT_STATE_NOT_MOVE, UNIT_STATE_ROAMING_MOVE, WaypointPath::Velocity, Walk, WaypointNode::X, WaypointNode::Y, and WaypointNode::Z.

UnitSpeedChanged()

template<typename T >

void WaypointMovementGenerator< T >::UnitSpeedChanged ( )

inlineoverridevirtual

Reimplemented from MovementGenerator.

Definition at line 50 of file WaypointMovementGenerator.h.

References MovementGenerator::AddFlag(), and MOVEMENTGENERATOR_FLAG_SPEED_UPDATE_PENDING.

UpdateMoveTimer()

template<typename T >

bool WaypointMovementGenerator< T >::UpdateMoveTimer ( uint32  diff )

inlineprivate

Definition at line 70 of file WaypointMovementGenerator.h.

References WaypointMovementGenerator< T >::_moveTimer, and WaypointMovementGenerator< T >::UpdateTimer().

UpdateTimer()

template<typename T >

static bool WaypointMovementGenerator< T >::UpdateTimer ( TimeTracker &  timer, uint32  diff  )

inlinestaticprivate

Definition at line 72 of file WaypointMovementGenerator.h.

References TimeTracker::Passed(), TimeTracker::Reset(), and TimeTracker::Update().

Referenced by WaypointMovementGenerator< T >::UpdateMoveTimer(), and WaypointMovementGenerator< T >::UpdateWaitTimer().

UpdateWaitTimer()

template<typename T >

bool WaypointMovementGenerator< T >::UpdateWaitTimer ( uint32  diff )

inlineprivate

Definition at line 71 of file WaypointMovementGenerator.h.

References WaypointMovementGenerator< T >::_nextMoveTime, and WaypointMovementGenerator< T >::UpdateTimer().

Member Data Documentation

_duration

template<typename T >

Optional<TimeTracker> WaypointMovementGenerator< T >::_duration

private

Definition at line 89 of file WaypointMovementGenerator.h.

Referenced by WaypointMovementGenerator< T >::WaypointMovementGenerator(), and WaypointMovementGenerator< T >::WaypointMovementGenerator().

_exactSplinePath

template<typename T >

Optional<bool> WaypointMovementGenerator< T >::_exactSplinePath

private

Definition at line 95 of file WaypointMovementGenerator.h.

_fadeObject

template<typename T >

Optional<MovementFadeObject> WaypointMovementGenerator< T >::_fadeObject

private

Definition at line 98 of file WaypointMovementGenerator.h.

_followPathBackwardsFromEndToStart

template<typename T >

Optional<bool> WaypointMovementGenerator< T >::_followPathBackwardsFromEndToStart

private

Definition at line 94 of file WaypointMovementGenerator.h.

_generatePath

template<typename T >

bool WaypointMovementGenerator< T >::_generatePath

private

Definition at line 97 of file WaypointMovementGenerator.h.

_isReturningToStart

template<typename T >

bool WaypointMovementGenerator< T >::_isReturningToStart

private

Definition at line 104 of file WaypointMovementGenerator.h.

_moveTimer

template<typename T >

TimeTracker WaypointMovementGenerator< T >::_moveTimer

private

Definition at line 100 of file WaypointMovementGenerator.h.

Referenced by WaypointMovementGenerator< T >::UpdateMoveTimer().

_nextMoveTime

template<typename T >

TimeTracker WaypointMovementGenerator< T >::_nextMoveTime

private

Definition at line 101 of file WaypointMovementGenerator.h.

Referenced by WaypointMovementGenerator< T >::UpdateWaitTimer().

_repeating

template<typename T >

bool WaypointMovementGenerator< T >::_repeating

private

Definition at line 96 of file WaypointMovementGenerator.h.

_speed

template<typename T >

Optional<float> WaypointMovementGenerator< T >::_speed

private

Definition at line 90 of file WaypointMovementGenerator.h.

_speedSelectionMode

template<typename T >

MovementWalkRunSpeedSelectionMode WaypointMovementGenerator< T >::_speedSelectionMode

private

Definition at line 91 of file WaypointMovementGenerator.h.

_waitTimeRangeAtPathEnd

template<typename T >

Optional<std::pair<Milliseconds, Milliseconds> > WaypointMovementGenerator< T >::_waitTimeRangeAtPathEnd

private

Definition at line 92 of file WaypointMovementGenerator.h.

_wanderDistanceAtPathEnds

template<typename T >

Optional<float> WaypointMovementGenerator< T >::_wanderDistanceAtPathEnds

private

Definition at line 93 of file WaypointMovementGenerator.h.

_waypointTransitionSplinePoints

template<typename T >

std::vector<int32> WaypointMovementGenerator< T >::_waypointTransitionSplinePoints

private

Definition at line 102 of file WaypointMovementGenerator.h.

_waypointTransitionSplinePointsIndex

template<typename T >

uint32 WaypointMovementGenerator< T >::_waypointTransitionSplinePointsIndex

private

Definition at line 103 of file WaypointMovementGenerator.h.

---

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

• server/game/Movement/MovementGenerators/WaypointMovementGenerator.h
• server/game/Movement/MovementGenerators/WaypointMovementGenerator.cpp