AI Package to have an NPC lead the player to a specific point. More...

#include <aiescort.hpp>

Inheritance diagram for MWMechanics::AiEscort:

Collaboration diagram for MWMechanics::AiEscort:

Public Member Functions
	AiEscort (const std::string &actorId, int duration, float x, float y, float z)
	Implementation of AiEscort. More...

	AiEscort (const std::string &actorId, const std::string &cellId, int duration, float x, float y, float z)
	Implementation of AiEscortCell. More...

	AiEscort (const ESM::AiSequence::AiEscort *escort)

virtual AiEscort *	clone () const
	Clones the package. More...

virtual bool	execute (const MWWorld::Ptr &actor, CharacterController &characterController, AiState &state, float duration)

virtual int	getTypeId () const

MWWorld::Ptr	getTarget () const
	Get the target actor the AI is targeted at (not applicable to all AI packages, default return empty Ptr) More...

virtual bool	sideWithTarget () const
	Return true if having this AiPackage makes the actor side with the target in fights (default false) More...

void	writeState (ESM::AiSequence::AiSequence &sequence) const

void	fastForward (const MWWorld::Ptr &actor, AiState &state)
	Simulates the passing of time. More...

Public Member Functions inherited from MWMechanics::AiPackage
	AiPackage ()
	Default constructor. More...

virtual	~AiPackage ()
	Default Deconstructor. More...

virtual unsigned int	getPriority () const
	Higher number is higher priority (0 being the lowest) More...

virtual bool	followTargetThroughDoors () const
	Return true if the actor should follow the target through teleport doors (default false) More...

virtual bool	canCancel () const
	Can this Ai package be canceled? (default true) More...

virtual bool	shouldCancelPreviousAi () const
	Upon adding this Ai package, should the Ai Sequence attempt to cancel previous Ai packages (default true)? More...

virtual bool	getRepeat () const
	Return true if this package should repeat. Currently only used for Wander packages. More...

void	reset ()
	Reset pathfinding state. More...

bool	isTargetMagicallyHidden (const MWWorld::Ptr &target)

Private Attributes
std::string	mActorId

std::string	mCellId

float	mX

float	mY

float	mZ

float	mMaxDist

float	mDuration

float	mRemainingDuration

int	mCellX

int	mCellY

Additional Inherited Members
Public Types inherited from MWMechanics::AiPackage
enum	TypeId { TypeIdNone = -1, TypeIdWander = 0, TypeIdTravel = 1, TypeIdEscort = 2, TypeIdFollow = 3, TypeIdActivate = 4, TypeIdCombat = 5, TypeIdPursue = 6, TypeIdAvoidDoor = 7, TypeIdFace = 8 }
	Enumerates the various AITypes available. More...

Static Public Member Functions inherited from MWMechanics::AiPackage
static bool	isReachableRotatingOnTheRun (const MWWorld::Ptr &actor, const ESM::Pathgrid::Point &dest)
	Return if actor's rotation speed is sufficient to rotate to the destination pathpoint on the run. Otherwise actor should rotate while standing. More...

Protected Member Functions inherited from MWMechanics::AiPackage
bool	pathTo (const MWWorld::Ptr &actor, const ESM::Pathgrid::Point &dest, float duration, float destTolerance=0.0f)
	Handles path building and shortcutting with obstacles avoiding. More...

bool	shortcutPath (const ESM::Pathgrid::Point &startPoint, const ESM::Pathgrid::Point &endPoint, const MWWorld::Ptr &actor, bool *destInLOS)

bool	checkWayIsClearForActor (const ESM::Pathgrid::Point &startPoint, const ESM::Pathgrid::Point &endPoint, const MWWorld::Ptr &actor)
	Check if the way to the destination is clear, taking into account actor speed. More...

virtual bool	doesPathNeedRecalc (const ESM::Pathgrid::Point &newDest, const MWWorld::CellStore *currentCell)

void	evadeObstacles (const MWWorld::Ptr &actor, float duration, const ESM::Position &pos)

Protected Attributes inherited from MWMechanics::AiPackage
PathFinder	mPathFinder

ObstacleCheck	mObstacleCheck

float	mTimer

osg::Vec3f	mLastActorPos

short	mRotateOnTheRunChecks

bool	mIsShortcutting

bool	mShortcutProhibited

ESM::Pathgrid::Point	mShortcutFailPos

Detailed Description

AI Package to have an NPC lead the player to a specific point.

Constructor & Destructor Documentation

MWMechanics::AiEscort::AiEscort	(	const std::string &	actorId,
		int	duration,
		float	x,
		float	y,
		float	z
	)

Implementation of AiEscort.

The Actor will escort the specified actor to the world position x, y, z until they reach their position, or they run out of time AiEscort

MWMechanics::AiEscort::AiEscort	(	const std::string &	actorId,
		const std::string &	cellId,
		int	duration,
		float	x,
		float	y,
		float	z
	)

Implementation of AiEscortCell.

The Actor will escort the specified actor to the cell position x, y, z until they reach their position, or they run out of time AiEscortCell

MWMechanics::AiEscort::AiEscort ( const ESM::AiSequence::AiEscort * escort )

Member Function Documentation

AiEscort * MWMechanics::AiEscort::clone ( ) const

virtual

Clones the package.

Implements MWMechanics::AiPackage.

bool MWMechanics::AiEscort::execute	(	const MWWorld::Ptr &	actor,
		CharacterController &	characterController,
		AiState &	state,
		float	duration
	)

virtual

Updates and runs the package (Should run every frame)

Returns: Package completed?

Implements MWMechanics::AiPackage.

Here is the call graph for this function:

void MWMechanics::AiEscort::fastForward	(	const MWWorld::Ptr &	actor,
		AiState &	state
	)

virtual

Simulates the passing of time.

Reimplemented from MWMechanics::AiPackage.

MWWorld::Ptr MWMechanics::AiEscort::getTarget ( ) const

virtual

Get the target actor the AI is targeted at (not applicable to all AI packages, default return empty Ptr)

Reimplemented from MWMechanics::AiPackage.

Here is the call graph for this function:

int MWMechanics::AiEscort::getTypeId ( ) const

virtual

Returns the TypeID of the AiPackage

See Also: enum TypeId

Implements MWMechanics::AiPackage.

virtual bool MWMechanics::AiEscort::sideWithTarget ( ) const

inlinevirtual

Return true if having this AiPackage makes the actor side with the target in fights (default false)

Reimplemented from MWMechanics::AiPackage.

void MWMechanics::AiEscort::writeState ( ESM::AiSequence::AiSequence & sequence ) const

virtual

Reimplemented from MWMechanics::AiPackage.

Member Data Documentation

std::string MWMechanics::AiEscort::mActorId

private

std::string MWMechanics::AiEscort::mCellId

private

int MWMechanics::AiEscort::mCellX

private

int MWMechanics::AiEscort::mCellY

private

float MWMechanics::AiEscort::mDuration

private

float MWMechanics::AiEscort::mMaxDist

private

float MWMechanics::AiEscort::mRemainingDuration

private

float MWMechanics::AiEscort::mX

private

float MWMechanics::AiEscort::mY

private

float MWMechanics::AiEscort::mZ

private

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

/home/travis/build/OpenMW/openmw/apps/openmw/mwmechanics/aiescort.hpp
/home/travis/build/OpenMW/openmw/apps/openmw/mwmechanics/aiescort.cpp

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation