Nimbus::Soaring Class Reference

#include <Soaring.h>

Inheritance diagram for Nimbus::Soaring:

Collaboration diagram for Nimbus::Soaring:

Public Member Functions
	Soaring (BehaviourType type, World *world, EventSystem *eventSystem)
	Soaring (BehaviourType type, World *world, Ogre::ConfigFile::SettingsMultiMap *initializingSettings, EventSystem *eventSystem)
	Soaring (Soaring *other, World *world, int id, EventSystem *eventSystem)
virtual	~Soaring (void)
virtual void	startup (void)
virtual void	update (void)
virtual void	shutdown (void)
virtual Behaviour *	clone (Ogre::ConfigFile::SettingsMultiMap *initializingSettings, EventSystem *eventSystem)
virtual Behaviour *	clone (int id, EventSystem *eventSystem)
Public Member Functions inherited from Nimbus::Behaviour
	Behaviour (BehaviourType type, World *world, EventSystem *eventSystem)
	Behaviour (BehaviourType type, World *world, Ogre::ConfigFile::SettingsMultiMap *initializingSettings, EventSystem *eventSystem)
	Behaviour (Behaviour *other, World *world, int id, EventSystem *eventSystem)
BehaviourType	getBehaviourType ()

Additional Inherited Members
Protected Attributes inherited from Nimbus::Behaviour
World *	mWorld
BehaviourType	mBehaviourType
GameEntityId	mParentId
EventSystem *	mEntityEventSystem

Detailed Description

Soaring allows the entity to be sensitive to wind data. It uses the SOAR_ENTITY event to alert the entity which direction the wind is pushing the entity.

Constructor & Destructor Documentation

Soaring::Soaring	(	BehaviourType	type,
		World *	world,
		EventSystem *	eventSystem
	)

Default constructor, taking a world pointer.

Parameters

type	The type of Behaviour being constructed.
world	A pointer to the game world.
eventSystem	The event system that localized events will be passed to.

Here is the caller graph for this function:

Soaring::Soaring	(	BehaviourType	type,
		World *	world,
		Ogre::ConfigFile::SettingsMultiMap *	initializingSettings,
		EventSystem *	eventSystem
	)

Constructor based of a set of initial settings.

Parameters

type	The type of Behaviour being constructed.
world	A pointer to the game world.
intitializingSettings	A map of settings used to construct the intial entity.
eventSystem	The event system that localized events will be passed to.

Soaring::Soaring	(	Soaring *	other,
		World *	world,
		int	id,
		EventSystem *	eventSystem
	)

Constructor based on another Soaring behaviour.

Parameters

other	A pointer to the other Soaring behaviour.
world	A pointer to the game world.
id	The id of the parent entity holding this behaviour.
eventSystem	The event system that localized events will be passed to.

Soaring::~Soaring ( void  )

virtual

Virtual destructor for destroying things.

Member Function Documentation

Behaviour * Soaring::clone ( Ogre::ConfigFile::SettingsMultiMap *  initializingSettings, EventSystem *  eventSystem  )

virtual

Duplicates the entity using the settings given.

Returns

A pointer given by the constructor.

Implements Nimbus::Behaviour.

Here is the call graph for this function:

Behaviour * Soaring::clone ( int  id, EventSystem *  eventSystem  )

virtual

Duplicates the entity based on the current copy. This is used to enable use of the prototype pattern.

Implements Nimbus::Behaviour.

Here is the call graph for this function:

void Soaring::shutdown ( void  )

virtual

!! STUBBED !! Shuts down the behaviour, taking care of any major cleanup.

Implements Nimbus::Behaviour.

void Soaring::startup ( void  )

virtual

!! STUBBED !! Starts up the initial behaviour.

Implements Nimbus::Behaviour.

void Soaring::update ( void  )

virtual

Sends off a SOAR_ENTITY event to the entity's flocking group.

Implements Nimbus::Behaviour.

Here is the call graph for this function:

---

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

• C:/Users/Hazen/Documents/projects/Nimbus/src/Behaviours/Soaring.h
• C:/Users/Hazen/Documents/projects/Nimbus/src/Behaviours/Soaring.cpp