se_core::Cutscene Class Reference

#include <Cutscene.hpp>

Inheritance diagram for se_core::Cutscene:

List of all members.

Public Types
enum	MultiSimObjectType { MGO_BEFORE = 0, MGO_AFTER, MGO_COUNT }
Public Member Functions
	Cutscene (String *name)
virtual	~Cutscene ()
void	setQuestGoal (const QuestGoal *questGoal)
const QuestGoal *	questGoal ()
void	setScripts (const Area &area, Actor &performer, Actor *scriptTarget=0)
void	setSingleScript (ShowingCutscene *showingCutscene, Actor &actor)
	Used mainly for involving newcomers to the area into the cutscene.
ObjectList &	beforeTheseGoals ()
ObjectList &	afterTheseGoals ()
const ObjectList &	beforeTheseGoals () const
const ObjectList &	afterTheseGoals () const
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 Cutscene *	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)

---

Member Enumeration Documentation

enum se_core::Cutscene::MultiSimObjectType

Enumeration values: MGO_BEFORE  MGO_AFTER  MGO_COUNT  Definition at line 41 of file Cutscene.hpp.

---

Constructor & Destructor Documentation

se_core::Cutscene::Cutscene (  String *  name  )

Definition at line 39 of file Cutscene.cpp. References se_core::got_CUTSCENE.

se_core::Cutscene::~Cutscene (   )  [virtual]

Definition at line 46 of file Cutscene.cpp.

---

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

const ObjectList& se_core::Cutscene::afterTheseGoals (   )  const [inline]

Definition at line 54 of file Cutscene.hpp.

ObjectList& se_core::Cutscene::afterTheseGoals (   )  [inline]

Definition at line 52 of file Cutscene.hpp. Referenced by se_core::CutsceneParser::parse().

const ObjectList& se_core::Cutscene::beforeTheseGoals (   )  const [inline]

Definition at line 53 of file Cutscene.hpp.

ObjectList& se_core::Cutscene::beforeTheseGoals (   )  [inline]

Definition at line 51 of file Cutscene.hpp. Referenced by se_core::CutsceneParser::parse().

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 Cutscene* se_core::Cutscene::lookup (  const char *  name  )  [inline, static]

Definition at line 37 of file Cutscene.hpp. References se_core::Object::_lookup(), and se_core::got_CUTSCENE.

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

const QuestGoal* se_core::Cutscene::questGoal (   )  [inline]

Definition at line 48 of file Cutscene.hpp.

void se_core::Cutscene::setQuestGoal (  const QuestGoal *  questGoal  )  [inline]

Definition at line 47 of file Cutscene.hpp. Referenced by se_core::CutsceneParser::parse().

void se_core::Cutscene::setScripts (  const Area &  area, Actor &  performer, Actor *  scriptTarget = 0 )

Definition at line 52 of file Cutscene.cpp.

void se_core::Cutscene::setSingleScript (  ShowingCutscene *  showingCutscene, Actor &  actor )

Used mainly for involving newcomers to the area into the cutscene. Definition at line 109 of file Cutscene.cpp.

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 files:

• core/src/sim/script/Cutscene.hpp
• core/src/sim/script/Cutscene.cpp

---

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