Causes the Actor to wander within a specified range. More...

#include <aiwander.hpp>

Inheritance diagram for MWMechanics::AiWander:

Collaboration diagram for MWMechanics::AiWander:

Public Types
enum	GreetingState { Greet_None, Greet_InProgress, Greet_Done }

enum	WanderState { Wander_ChooseAction, Wander_IdleNow, Wander_MoveNow, Wander_Walking }

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...

Public Member Functions
	AiWander (int distance, int duration, int timeOfDay, const std::vector< unsigned char > &idle, bool repeat)
	Constructor. More...

	AiWander (const ESM::AiSequence::AiWander *wander)

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

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

virtual int	getTypeId () const

void	setReturnPosition (const osg::Vec3f &position)
	Set the position to return to for a stationary (non-wandering) actor. More...

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

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

bool	getRepeat () const
	Return true if this package should repeat. Currently only used for Wander packages. 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 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...

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...

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

bool	isTargetMagicallyHidden (const MWWorld::Ptr &target)

Private Types
enum	GroupIndex { GroupIndex_MinIdle = 2, GroupIndex_MaxIdle = 9 }

Private Member Functions
void	init ()

void	stopWalking (const MWWorld::Ptr &actor, AiWanderStorage &storage)

bool	playIdle (const MWWorld::Ptr &actor, unsigned short idleSelect)

bool	checkIdle (const MWWorld::Ptr &actor, unsigned short idleSelect)

short unsigned	getRandomIdle ()

void	setPathToAnAllowedNode (const MWWorld::Ptr &actor, AiWanderStorage &storage, const ESM::Position &actorPos)

void	playGreetingIfPlayerGetsTooClose (const MWWorld::Ptr &actor, AiWanderStorage &storage)

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

void	playIdleDialogueRandomly (const MWWorld::Ptr &actor)

void	turnActorToFacePlayer (const osg::Vec3f &actorPosition, const osg::Vec3f &playerPosition, AiWanderStorage &storage)

void	doPerFrameActionsForState (const MWWorld::Ptr &actor, float duration, AiWanderStorage &storage, ESM::Position &pos)

void	onIdleStatePerFrameActions (const MWWorld::Ptr &actor, float duration, AiWanderStorage &storage)

void	onWalkingStatePerFrameActions (const MWWorld::Ptr &actor, float duration, AiWanderStorage &storage, ESM::Position &pos)

void	onChooseActionStatePerFrameActions (const MWWorld::Ptr &actor, AiWanderStorage &storage)

bool	reactionTimeActions (const MWWorld::Ptr &actor, AiWanderStorage &storage, const MWWorld::CellStore *&currentCell, bool cellChange, ESM::Position &pos, float duration)

bool	isPackageCompleted (const MWWorld::Ptr &actor, AiWanderStorage &storage)

void	returnToStartLocation (const MWWorld::Ptr &actor, AiWanderStorage &storage, ESM::Position &pos)

void	wanderNearStart (const MWWorld::Ptr &actor, AiWanderStorage &storage, int wanderDistance)

bool	destinationIsAtWater (const MWWorld::Ptr &actor, const osg::Vec3f &destination)

bool	destinationThroughGround (const osg::Vec3f &startPoint, const osg::Vec3f &destination)

void	completeManualWalking (const MWWorld::Ptr &actor, AiWanderStorage &storage)

void	getAllowedNodes (const MWWorld::Ptr &actor, const ESM::Cell *cell, AiWanderStorage &storage)

void	trimAllowedNodes (std::vector< ESM::Pathgrid::Point > &nodes, const PathFinder &pathfinder)

void	ToWorldCoordinates (ESM::Pathgrid::Point &point, const ESM::Cell *cell)
	convert point from local (i.e. cell) to world coordinates More...

void	SetCurrentNodeToClosestAllowedNode (osg::Vec3f npcPos, AiWanderStorage &storage)

void	AddNonPathGridAllowedPoints (osg::Vec3f npcPos, const ESM::Pathgrid *pathGrid, int pointIndex, AiWanderStorage &storage)

void	AddPointBetweenPathGridPoints (const ESM::Pathgrid::Point &start, const ESM::Pathgrid::Point &end, AiWanderStorage &storage)

Static Private Member Functions
static int	OffsetToPreventOvercrowding ()

Private Attributes
int	mDistance

int	mDuration

float	mRemainingDuration

int	mTimeOfDay

std::vector< unsigned char >	mIdle

bool	mRepeat

bool	mHasReturnPosition

osg::Vec3f	mReturnPosition

osg::Vec3f	mInitialActorPosition

bool	mStoredInitialActorPosition

Static Private Attributes
static const std::string	sIdleSelectToGroupName [GroupIndex_MaxIdle-GroupIndex_MinIdle+1]
	lookup table for converting idleSelect value to groupName More...

Additional Inherited Members
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

Causes the Actor to wander within a specified range.

Member Enumeration Documentation

enum MWMechanics::AiWander::GreetingState

Enumerator
Greet_None
Greet_InProgress
Greet_Done

enum MWMechanics::AiWander::GroupIndex

private

Enumerator
GroupIndex_MinIdle
GroupIndex_MaxIdle

enum MWMechanics::AiWander::WanderState

Enumerator
Wander_ChooseAction
Wander_IdleNow
Wander_MoveNow
Wander_Walking

Constructor & Destructor Documentation

MWMechanics::AiWander::AiWander	(	int	distance,
		int	duration,
		int	timeOfDay,
		const std::vector< unsigned char > &	idle,
		bool	repeat
	)

Constructor.

Parameters

distance	Max distance the ACtor will wander
duration	Time, in hours, that this package will be preformed
timeOfDay	Currently unimplemented. Not functional in the original engine.
idle	Chances of each idle to play (9 in total)
repeat	Repeat wander or not

Here is the call graph for this function:

MWMechanics::AiWander::AiWander ( const ESM::AiSequence::AiWander * wander )

Here is the call graph for this function:

Member Function Documentation

void MWMechanics::AiWander::AddNonPathGridAllowedPoints	(	osg::Vec3f	npcPos,
		const ESM::Pathgrid *	pathGrid,
		int	pointIndex,
		AiWanderStorage &	storage
	)

private

Here is the call graph for this function:

Here is the caller graph for this function:

void MWMechanics::AiWander::AddPointBetweenPathGridPoints	(	const ESM::Pathgrid::Point &	start,
		const ESM::Pathgrid::Point &	end,
		AiWanderStorage &	storage
	)

private

Here is the call graph for this function:

Here is the caller graph for this function:

bool MWMechanics::AiWander::checkIdle	(	const MWWorld::Ptr &	actor,
		unsigned short	idleSelect
	)

private

Here is the call graph for this function:

Here is the caller graph for this function:

AiPackage * MWMechanics::AiWander::clone ( ) const

virtual

Clones the package.

Implements MWMechanics::AiPackage.

void MWMechanics::AiWander::completeManualWalking	(	const MWWorld::Ptr &	actor,
		AiWanderStorage &	storage
	)

private

Here is the call graph for this function:

Here is the caller graph for this function:

bool MWMechanics::AiWander::destinationIsAtWater	(	const MWWorld::Ptr &	actor,
		const osg::Vec3f &	destination
	)

private

Here is the call graph for this function:

Here is the caller graph for this function:

bool MWMechanics::AiWander::destinationThroughGround	(	const osg::Vec3f &	startPoint,
		const osg::Vec3f &	destination
	)

private

Here is the call graph for this function:

Here is the caller graph for this function:

void MWMechanics::AiWander::doPerFrameActionsForState	(	const MWWorld::Ptr &	actor,
		float	duration,
		AiWanderStorage &	storage,
		ESM::Position &	pos
	)

private

Here is the call graph for this function:

Here is the caller graph for this function:

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

private

Here is the call graph for this function:

Here is the caller graph for this function:

bool MWMechanics::AiWander::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::AiWander::fastForward	(	const MWWorld::Ptr &	actor,
		AiState &	state
	)

virtual

Simulates the passing of time.

Reimplemented from MWMechanics::AiPackage.

Here is the call graph for this function:

void MWMechanics::AiWander::getAllowedNodes	(	const MWWorld::Ptr &	actor,
		const ESM::Cell *	cell,
		AiWanderStorage &	storage
	)

private

Here is the call graph for this function:

Here is the caller graph for this function:

short unsigned MWMechanics::AiWander::getRandomIdle ( )

private

Here is the call graph for this function:

Here is the caller graph for this function:

bool MWMechanics::AiWander::getRepeat ( ) const

virtual

Return true if this package should repeat. Currently only used for Wander packages.

Reimplemented from MWMechanics::AiPackage.

int MWMechanics::AiWander::getTypeId ( ) const

virtual

Returns the TypeID of the AiPackage

See Also: enum TypeId

Implements MWMechanics::AiPackage.

void MWMechanics::AiWander::init ( )

private

Here is the caller graph for this function:

bool MWMechanics::AiWander::isPackageCompleted	(	const MWWorld::Ptr &	actor,
		AiWanderStorage &	storage
	)

private

Here is the call graph for this function:

Here is the caller graph for this function:

int MWMechanics::AiWander::OffsetToPreventOvercrowding ( )

staticprivate

Here is the call graph for this function:

Here is the caller graph for this function:

void MWMechanics::AiWander::onChooseActionStatePerFrameActions	(	const MWWorld::Ptr &	actor,
		AiWanderStorage &	storage
	)

private

Here is the call graph for this function:

Here is the caller graph for this function:

void MWMechanics::AiWander::onIdleStatePerFrameActions	(	const MWWorld::Ptr &	actor,
		float	duration,
		AiWanderStorage &	storage
	)

private

Here is the call graph for this function:

Here is the caller graph for this function:

void MWMechanics::AiWander::onWalkingStatePerFrameActions	(	const MWWorld::Ptr &	actor,
		float	duration,
		AiWanderStorage &	storage,
		ESM::Position &	pos
	)

private

Here is the call graph for this function:

Here is the caller graph for this function:

void MWMechanics::AiWander::playGreetingIfPlayerGetsTooClose	(	const MWWorld::Ptr &	actor,
		AiWanderStorage &	storage
	)

private

Here is the call graph for this function:

Here is the caller graph for this function:

bool MWMechanics::AiWander::playIdle	(	const MWWorld::Ptr &	actor,
		unsigned short	idleSelect
	)

private

Have the given actor play an idle animation

Returns: Success or error

Here is the call graph for this function:

Here is the caller graph for this function:

void MWMechanics::AiWander::playIdleDialogueRandomly ( const MWWorld::Ptr & actor )

private

Here is the call graph for this function:

Here is the caller graph for this function:

bool MWMechanics::AiWander::reactionTimeActions	(	const MWWorld::Ptr &	actor,
		AiWanderStorage &	storage,
		const MWWorld::CellStore *&	currentCell,
		bool	cellChange,
		ESM::Position &	pos,
		float	duration
	)

private

Here is the call graph for this function:

Here is the caller graph for this function:

void MWMechanics::AiWander::returnToStartLocation	(	const MWWorld::Ptr &	actor,
		AiWanderStorage &	storage,
		ESM::Position &	pos
	)

private

Here is the call graph for this function:

Here is the caller graph for this function:

void MWMechanics::AiWander::SetCurrentNodeToClosestAllowedNode	(	osg::Vec3f	npcPos,
		AiWanderStorage &	storage
	)

private

Here is the call graph for this function:

Here is the caller graph for this function:

void MWMechanics::AiWander::setPathToAnAllowedNode	(	const MWWorld::Ptr &	actor,
		AiWanderStorage &	storage,
		const ESM::Position &	actorPos
	)

private

Here is the call graph for this function:

Here is the caller graph for this function:

void MWMechanics::AiWander::setReturnPosition ( const osg::Vec3f & position )

Set the position to return to for a stationary (non-wandering) actor.

In case another AI package moved the actor elsewhere

void MWMechanics::AiWander::stopWalking	(	const MWWorld::Ptr &	actor,
		AiWanderStorage &	storage
	)

private

Here is the call graph for this function:

Here is the caller graph for this function:

void MWMechanics::AiWander::ToWorldCoordinates	(	ESM::Pathgrid::Point &	point,
		const ESM::Cell *	cell
	)

private

convert point from local (i.e. cell) to world coordinates

Here is the call graph for this function:

Here is the caller graph for this function:

void MWMechanics::AiWander::trimAllowedNodes	(	std::vector< ESM::Pathgrid::Point > &	nodes,
		const PathFinder &	pathfinder
	)

private

Here is the call graph for this function:

Here is the caller graph for this function:

void MWMechanics::AiWander::turnActorToFacePlayer	(	const osg::Vec3f &	actorPosition,
		const osg::Vec3f &	playerPosition,
		AiWanderStorage &	storage
	)

private

Here is the caller graph for this function:

void MWMechanics::AiWander::wanderNearStart	(	const MWWorld::Ptr &	actor,
		AiWanderStorage &	storage,
		int	wanderDistance
	)

private

Here is the call graph for this function:

Here is the caller graph for this function:

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

virtual

Reimplemented from MWMechanics::AiPackage.

Member Data Documentation

int MWMechanics::AiWander::mDistance

private

int MWMechanics::AiWander::mDuration

private

bool MWMechanics::AiWander::mHasReturnPosition

private

std::vector<unsigned char> MWMechanics::AiWander::mIdle

private

osg::Vec3f MWMechanics::AiWander::mInitialActorPosition

private

float MWMechanics::AiWander::mRemainingDuration

private

bool MWMechanics::AiWander::mRepeat

private

osg::Vec3f MWMechanics::AiWander::mReturnPosition

private

bool MWMechanics::AiWander::mStoredInitialActorPosition

private

int MWMechanics::AiWander::mTimeOfDay

private

const std::string MWMechanics::AiWander::sIdleSelectToGroupName

staticprivate

Initial value:

=
    {
        std::string("idle2"),
        std::string("idle3"),
        std::string("idle4"),
        std::string("idle5"),
        std::string("idle6"),
        std::string("idle7"),
        std::string("idle8"),
        std::string("idle9"),
    }

lookup table for converting idleSelect value to groupName

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

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

Public Types

Public Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation