se_core::Idle Class Reference

#include <Idle.hpp>

Inheritance diagram for se_core::Idle:


Public Member Functions
	Idle ()
short	duration (ActionComponent &performer, Parameter &parameter) const
	Number of timesteps that should pass before the action is performed.
bool	isRepeating (long when, ActionComponent &performer, Parameter &parameter) const
	Should the action auto-repeat unless it has another action planned for this action channel? Returns false unless overridden.
void	perform (long when, ActionComponent &performer, Parameter &parameter) const
	Perform the action.
virtual bool	isContinuing (ActionComponent &performer, Parameter &parameter) const
	Should perform be called again before the action is complete? If true is returned, the action will continue even if other actions are planned for this channel in the ActionQueue.
virtual void	prepare (ActionComponent &performer, Parameter &parameter) const
	Called when the action is inserted into the ActionQueue.
virtual bool	doPause (ActionComponent &performer, Parameter &parameter) const
virtual void	feedbackEvent (ActionComponent &performer, Parameter &parameter, int type) const
virtual void	disrupt (ActionComponent &performer, Parameter &parameter) const
	Called if the action is disrupted, that is being removed from the ActionQueue without being performed.
int	id () const
	Get the Object id of the object.
virtual const char *	name () const
	Get the name of the Object.
int	type () const
	Get the type of the Object (got_ACTION, got_THING, etc).
Static Public Member Functions
const Action *	lookup (const char *name)
int	hash (int type, const char *name)
	Calculate hash (object id) given object type and name.
Static Protected Member Functions
const Object *	_lookup (int hash)
const Object *	_lookup (int type, const char *name)

Constructor & Destructor Documentation

se_core::Idle::Idle ( ) [inline]

Definition at line 31 of file Idle.hpp.

Member Function Documentation

const Object* se_core::Object::_lookup ( int type,

const char * name

) [inline, static, protected, inherited]

Definition at line 102 of file Object.hpp.

const Object * se_core::Object::_lookup ( int hash ) [static, protected, inherited]

Definition at line 56 of file Object.cpp.
References se_core::ObjectRepository::get(), and se_core::CompSchema::objectRepository().
Referenced by se_core::Signal::lookup(), se_core::Script::lookup(), se_core::QuestGoal::lookup(), se_core::Cutscene::lookup(), se_core::ThingCollide::lookup(), se_core::Physics::lookup(), se_core::Ambience::lookup(), and se_core::Action::lookup().

virtual void se_core::Action::disrupt ( ActionComponent & performer,

Parameter & parameter

) const [inline, virtual, inherited]

Called if the action is disrupted, that is being removed from the ActionQueue without being performed.

Parameters:

performer the param that performs this action

parameter parameters specifying how this action should be performed

Definition at line 102 of file Action.hpp.
Referenced by se_core::ActionComponent::disrupt().

virtual bool se_core::Action::doPause ( ActionComponent & performer,

Parameter & parameter

) const [inline, virtual, inherited]

Definition at line 92 of file Action.hpp.
Referenced by se_core::ActionComponent::continueAction(), and se_core::ActionComponent::scheduleNextAction().

short se_core::Idle::duration ( ActionComponent & performer,

Parameter & parameter

) const [inline, virtual]

Number of timesteps that should pass before the action is performed.
Returns 1 unless overridden.
Parameters:

performer the param that performs this action

parameter parameters specifying how this action should be performed

Reimplemented from se_core::Action.
Definition at line 32 of file Idle.hpp.

virtual void se_core::Action::feedbackEvent ( ActionComponent & performer,

Parameter & parameter,

int type

) const [inline, virtual, inherited]

Definition at line 93 of file Action.hpp.
Referenced by se_core::ActionComponent::castFeedbackEvent().

int se_core::Object::hash ( int type,

const char * name

) [static, inherited]

Calculate hash (object id) given object type and name.

Definition at line 42 of file Object.cpp.

int se_core::Object::id ( ) const [inline, inherited]

Get the Object id of the object.
Each instance of Object has a unique Object id assigned to it during construction. The id_ is a hash of the name. And will be the same every time the game is run.
Sometimes two different names can give the same hash, and id. When this occurs the name of the object must be changed.

Returns:
The unique Object instance id.

Definition at line 69 of file Object.hpp.
Referenced by se_core::ObjectRepository::add(), se_core::operator<<(), and se_core::ObjectRepository::remove().

virtual bool se_core::Action::isContinuing ( ActionComponent & performer,

Parameter & parameter

) const [inline, virtual, inherited]

Should perform be called again before the action is complete? If true is returned, the action will continue even if other actions are planned for this channel in the ActionQueue.
Returns false unless overridden.

Parameters:

performer the param that performs this action

parameter parameters specifying how this action should be performed

Definition at line 80 of file Action.hpp.
Referenced by se_core::ActionComponent::scheduleNextAction().

bool se_core::Idle::isRepeating ( long when,

ActionComponent & performer,

Parameter & parameter

) const [inline, virtual]

Should the action auto-repeat unless it has another action planned for this action channel? Returns false unless overridden.

Parameters:

performer the param that performs this action

parameter parameters specifying how this action should be performed

Reimplemented from se_core::Action.
Definition at line 33 of file Idle.hpp.

const Action* se_core::Action::lookup ( const char * name ) [inline, static, inherited]

Definition at line 46 of file Action.hpp.
References se_core::Object::_lookup(), and se_core::got_ACTION.

virtual const char* se_core::Object::name ( ) const [inline, virtual, inherited]

Get the name of the Object.

Returns:
The name of the Object, or 0 if is not named.

Definition at line 78 of file Object.hpp.
Referenced by se_core::operator<<(), se_core::CutsceneParser::parse(), and se_basic::Say::perform().

void se_core::Idle::perform ( long when,

ActionComponent & performer,

Parameter & parameter

) const [inline, virtual]

Perform the action.
Abstract method that must be overridden by subclasses.

Parameters:

performer the param that performs this action

parameter parameters specifying how this action should be performed

Implements se_core::Action.
Definition at line 36 of file Idle.hpp.

virtual void se_core::Action::prepare ( ActionComponent & performer,

Parameter & parameter

) const [inline, virtual, inherited]

Called when the action is inserted into the ActionQueue.

Parameters:

performer the param that performs this action

parameter parameters specifying how this action should be performed

Definition at line 90 of file Action.hpp.
Referenced by se_core::ActionComponent::scheduleNextAction().

int se_core::Object::type ( ) const [inline, inherited]

Get the type of the Object (got_ACTION, got_THING, etc).
Classes subclassing game objects should have a type enumerated in the enum ObjectType. The subclass is itself responsible for reporting the type during construction, and a whole subclass hierarchy may share the same type (like Action and its subclasses, Script and its subclasses, etc).

Returns:
The type of the game object.

Definition at line 91 of file Object.hpp.
Referenced by se_core::operator<<().

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

core/src/sim/action/Idle.hpp

Home Page | SagaEngine trunk (updated nightly) reference generated Sun Dec 2 20:06:26 2007 by Doxygen version 1.3.9.1.

se_core::Idle Class Reference

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Constructor & Destructor Documentation

Member Function Documentation