WaypointMovementGenerator< Creature > Class Template Reference

#include <WaypointMovementGenerator.h>

Public Member Functions
	WaypointMovementGenerator (uint32 _path_id=0, bool _repeating=true)
	~WaypointMovementGenerator ()
void	DoInitialize (Creature *)
void	DoFinalize (Creature *)
void	DoReset (Creature *)
bool	DoUpdate (Creature *, uint32 diff)
void	MovementInform (Creature *)
MovementGeneratorType	GetMovementGeneratorType () const override
void	LoadPath (Creature *)
bool	GetResetPos (Creature *, float &x, float &y, float &z)
Public Member Functions inherited from MovementGeneratorMedium< Creature, WaypointMovementGenerator< Creature > >
void	Initialize (Unit *u) override
void	Finalize (Unit *u) override
void	Reset (Unit *u) override
bool	Update (Unit *u, uint32 time_diff) override
Public Member Functions inherited from MovementGenerator
virtual	~MovementGenerator ()
virtual void	unitSpeedChanged ()
virtual bool	GetResetPosition (Unit *, float &, float &, float &)
Public Member Functions inherited from PathMovementBase< Creature, WaypointPath const * >
	PathMovementBase ()
virtual	~PathMovementBase ()
uint32	GetCurrentNode () const

Private Member Functions
void	Stop (int32 time)
bool	Stopped ()
bool	CanMove (int32 diff)
void	OnArrived (Creature *)
bool	StartMove (Creature *)
void	StartMoveNow (Creature *creature)

Private Attributes
TimeTrackerSmall	i_nextMoveTime
bool	m_isArrivalDone
uint32	path_id
bool	repeating

Additional Inherited Members
Protected Attributes inherited from PathMovementBase< Creature, WaypointPath const * >
WaypointPath const *	i_path
uint32	i_currentNode

Constructor & Destructor Documentation

WaypointMovementGenerator< Creature >::WaypointMovementGenerator ( uint32  _path_id = 0, bool  _repeating = true  )

inline

 : i_nextMoveTime(0), m_isArrivalDone(false), path_id(_path_id), repeating(_repeating) { }

WaypointMovementGenerator< Creature >::~WaypointMovementGenerator ( )

inline

{ i_path = NULL; }

Member Function Documentation

bool WaypointMovementGenerator< Creature >::CanMove ( int32  diff )

inlineprivate

 {
 i_nextMoveTime.Update(diff);
 return i_nextMoveTime.Passed();
 }

void WaypointMovementGenerator< Creature >::DoFinalize

(

Creature *

creature

)

{
 creature->ClearUnitState(UNIT_STATE_ROAMING|UNIT_STATE_ROAMING_MOVE);
 creature->SetWalk(false);
}

Here is the call graph for this function:

void WaypointMovementGenerator< Creature >::DoInitialize

(

Creature *

creature

)

{
 LoadPath(creature);
 creature->AddUnitState(UNIT_STATE_ROAMING|UNIT_STATE_ROAMING_MOVE);
}

Here is the call graph for this function:

void WaypointMovementGenerator< Creature >::DoReset

(

Creature *

creature

)

{
 creature->AddUnitState(UNIT_STATE_ROAMING|UNIT_STATE_ROAMING_MOVE);
 StartMoveNow(creature);
}

Here is the call graph for this function:

bool WaypointMovementGenerator< Creature >::DoUpdate	(	Creature *	creature,
		uint32	diff
	)

{
 // Waypoint movement can be switched on/off
 // This is quite handy for escort quests and other stuff
 if (creature->HasUnitState(UNIT_STATE_NOT_MOVE))
 {
 creature->ClearUnitState(UNIT_STATE_ROAMING_MOVE);
 return true;
 }
 // prevent a crash at empty waypoint path.
 if (!i_path || i_path->empty())
 return false;

 if (Stopped())
 {
 if (CanMove(diff))
 return StartMove(creature);
 }
 else
 {
 // Set home position at place on waypoint movement.
 if (!creature->GetTransGUID())
 creature->SetHomePosition(creature->GetPosition());

 if (creature->IsStopped())
 Stop(STOP_TIME_FOR_PLAYER);
 else if (creature->movespline->Finalized())
 {
 OnArrived(creature);
 return StartMove(creature);
 }
 }
 return true;
 }

Here is the call graph for this function:

MovementGeneratorType WaypointMovementGenerator< Creature >::GetMovementGeneratorType ( ) const

inlineoverridevirtual

Implements MovementGenerator.

{ return WAYPOINT_MOTION_TYPE; }

bool WaypointMovementGenerator< Creature >::GetResetPos	(	Creature *	,
		float &	x,
		float &	y,
		float &	z
	)

{
 // prevent a crash at empty waypoint path.
 if (!i_path || i_path->empty())
 return false;

 const WaypointData* node = i_path->at(i_currentNode);
 x = node->x; y = node->y; z = node->z;
 return true;
}

void WaypointMovementGenerator< Creature >::LoadPath

(

Creature *

creature

)

{
 if (!path_id)
 path_id = creature->GetWaypointPath();

 i_path = sWaypointMgr->GetPath(path_id);

 if (!i_path)
 {
 // No path id found for entry
 TC_LOG_ERROR("sql.sql", "WaypointMovementGenerator::LoadPath: creature %s (%s DB GUID: " UI64FMTD ") doesn't have waypoint path id: %u", creature->GetName().c_str(), creature->GetGUID().ToString().c_str(), creature->GetSpawnId(), path_id);
 return;
 }

 StartMoveNow(creature);
}

Here is the call graph for this function:

void WaypointMovementGenerator< Creature >::MovementInform

(

Creature *

creature

)

{
 if (creature->AI())
 creature->AI()->MovementInform(WAYPOINT_MOTION_TYPE, i_currentNode);
}

Here is the call graph for this function:

void WaypointMovementGenerator< Creature >::OnArrived ( Creature *  creature )

private

{
 if (!i_path || i_path->empty())
 return;
 if (m_isArrivalDone)
 return;

 m_isArrivalDone = true;

 if (i_path->at(i_currentNode)->event_id && urand(0, 99) < i_path->at(i_currentNode)->event_chance)
 {
 TC_LOG_DEBUG("maps.script", "Creature movement start script %u at point %u for %s.", i_path->at(i_currentNode)->event_id, i_currentNode, creature->GetGUID().ToString().c_str());
 creature->ClearUnitState(UNIT_STATE_ROAMING_MOVE);
 creature->GetMap()->ScriptsStart(sWaypointScripts, i_path->at(i_currentNode)->event_id, creature, NULL);
 }

 // Inform script
 MovementInform(creature);
 creature->UpdateWaypointID(i_currentNode);

 if (i_path->at(i_currentNode)->delay)
 {
 creature->ClearUnitState(UNIT_STATE_ROAMING_MOVE);
 Stop(i_path->at(i_currentNode)->delay);
 }
}

Here is the call graph for this function:

bool WaypointMovementGenerator< Creature >::StartMove ( Creature *  creature )

private

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

Do not use formationDest here, MoveTo requires transport offsets due to DisableTransportPathTransformations() call but formationDest contains global coordinates

Accepts angles such as 0.00001 and -0.00001, 0 must be ignored, default value in waypoint table

{
 if (!i_path || i_path->empty())
 return false;

 if (Stopped())
 return true;

 bool transportPath = creature->GetTransport() != NULL;

 if (m_isArrivalDone)
 {
 if ((i_currentNode == i_path->size() - 1) && !repeating) // If that's our last waypoint
 {
 float x = i_path->at(i_currentNode)->x;
 float y = i_path->at(i_currentNode)->y;
 float z = i_path->at(i_currentNode)->z;
 float o = creature->GetOrientation();

 if (!transportPath)
 creature->SetHomePosition(x, y, z, o);
 else
 {
 if (Transport* trans = creature->GetTransport())
 {
 o -= trans->GetOrientation();
 creature->SetTransportHomePosition(x, y, z, o);
 trans->CalculatePassengerPosition(x, y, z, &o);
 creature->SetHomePosition(x, y, z, o);
 }
 else
 transportPath = false;
 // else if (vehicle) - this should never happen, vehicle offsets are const
 }

 creature->GetMotionMaster()->Initialize();
 return false;
 }

 i_currentNode = (i_currentNode+1) % i_path->size();
 }

 WaypointData const* node = i_path->at(i_currentNode);

 m_isArrivalDone = false;

 creature->AddUnitState(UNIT_STATE_ROAMING_MOVE);

 Movement::Location formationDest(node->x, node->y, node->z, 0.0f);
 Movement::MoveSplineInit init(creature);

 if (transportPath)
 {
 init.DisableTransportPathTransformations();
 if (TransportBase* trans = creature->GetDirectTransport())
 trans->CalculatePassengerPosition(formationDest.x, formationDest.y, formationDest.z, &formationDest.orientation);
 }

 init.MoveTo(node->x, node->y, node->z);

 if (node->orientation && node->delay)
 init.SetFacing(node->orientation);

 switch (node->move_type)
 {
 case WAYPOINT_MOVE_TYPE_LAND:
 init.SetAnimation(Movement::ToGround);
 break;
 case WAYPOINT_MOVE_TYPE_TAKEOFF:
 init.SetAnimation(Movement::ToFly);
 break;
 case WAYPOINT_MOVE_TYPE_RUN:
 init.SetWalk(false);
 break;
 case WAYPOINT_MOVE_TYPE_WALK:
 init.SetWalk(true);
 break;
 }

 init.Launch();

 //Call for creature group update
 if (creature->GetFormation() && creature->GetFormation()->getLeader() == creature)
 {
 creature->SetWalk(node->move_type != WAYPOINT_MOVE_TYPE_RUN);
 creature->GetFormation()->LeaderMoveTo(formationDest.x, formationDest.y, formationDest.z);
 }

 return true;
}

Here is the call graph for this function:

void WaypointMovementGenerator< Creature >::StartMoveNow ( Creature *  creature )

inlineprivate

 {
 i_nextMoveTime.Reset(0);
 StartMove(creature);
 }

void WaypointMovementGenerator< Creature >::Stop ( int32  time )

inlineprivate

{ i_nextMoveTime.Reset(time);}

bool WaypointMovementGenerator< Creature >::Stopped ( )

inlineprivate

{ return !i_nextMoveTime.Passed();}

Member Data Documentation

TimeTrackerSmall WaypointMovementGenerator< Creature >::i_nextMoveTime

private

bool WaypointMovementGenerator< Creature >::m_isArrivalDone

private

uint32 WaypointMovementGenerator< Creature >::path_id

private

bool WaypointMovementGenerator< Creature >::repeating

private

---

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

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