Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages | Search for 

se_core::Ambience Class Reference

#include <Ambience.hpp>

Inheritance diagram for se_core::Ambience:

se_core::Object List of all members.

Public Member Functions

 Ambience (const char *name)
virtual void musicEndedEvent (SoundCentral &soundCentral) const =0
virtual void musicStoppedEvent (SoundCentral &soundCentral) const =0
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 Ambience * 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::Ambience::Ambience (  const char *  name  )  [inline]
 

Definition at line 33 of file Ambience.hpp.

References se_core::got_AMBIENCE.

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(), lookup(), and se_core::Action::lookup().

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

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

Definition at line 35 of file Ambience.hpp.

References se_core::Object::_lookup(), and se_core::got_AMBIENCE.

virtual void se_core::Ambience::musicEndedEvent (  SoundCentral &  soundCentral  )  const [pure virtual]
 

virtual void se_core::Ambience::musicStoppedEvent (  SoundCentral &  soundCentral  )  const [pure virtual]
 

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

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:

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

SourceForge.net Logo