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::Script Class Reference

Base class for scripts. More...

#include <Script.hpp>

Inheritance diagram for se_core::Script:

se_core::Object se_core::CustomScript se_core::ReentrantScript se_core::TimelineScript List of all members.

Public Types

enum  { fb_SPEECH_FINISHED }

Public Member Functions

 Script (const char *name)
virtual ~Script ()
virtual ScriptData * init (const ScriptComponent &performer) const
virtual void reinit (const ScriptComponent &performer, ScriptData *sd) const
virtual void reinitPop (const ScriptComponent &performer, ScriptData *sd, const char *fromScript) const
virtual void touched (const ScriptComponent &performer, ScriptData *sd, void *param) const
void release (ScriptData *&sd) const
virtual void nextAction (const ScriptComponent &performer, int channel, ScriptData *sd, ActionAndParameter &out) const
virtual const Action * nextAction (const ScriptComponent &performer, int channel, ScriptData *sd, Parameter &out) const
virtual void feedbackEvent (const ScriptComponent &performer, ScriptData *sd, int type) const
virtual bool isStacker () const
 Should return false if the script should be popped before any is pushed on top of it.
virtual bool isTransparent () 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 Script * 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)

Detailed Description

Base class for scripts.

A script analyses the sitiation of a game actor and plans the next action. A script does not change the state of the performer in any way, except for what is needed to communicate with actions.

Definition at line 50 of file Script.hpp.

Member Enumeration Documentation

anonymous enum
 

Enumeration values:
fb_SPEECH_FINISHED 

Definition at line 66 of file Script.hpp.

Constructor & Destructor Documentation

se_core::Script::Script (  const char *  name  ) 
 

Definition at line 47 of file Script.cpp.

References se_core::got_SCRIPT.

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

Definition at line 54 of file Script.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(), 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::Script::feedbackEvent (  const ScriptComponent &  performer,
ScriptData *  sd,
int  type
)  const [inline, virtual]
 

Definition at line 67 of file Script.hpp.

Referenced by se_core::ScriptComponent::feedbackEvent().

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 ScriptData* se_core::Script::init (  const ScriptComponent &  performer  )  const [inline, virtual]
 

Reimplemented in se_core::CustomScript, and se_core::ReentrantScript.

Definition at line 58 of file Script.hpp.

Referenced by se_core::ScriptComponent::pushScript(), and se_core::ScriptComponent::setDefaultScript().

virtual bool se_core::Script::isStacker (   )  const [inline, virtual]
 

Should return false if the script should be popped before any is pushed on top of it.

Definition at line 73 of file Script.hpp.

virtual bool se_core::Script::isTransparent (   )  const [inline, virtual]
 

Definition at line 74 of file Script.hpp.

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

Definition at line 52 of file Script.hpp.

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

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

virtual const Action* se_core::Script::nextAction (  const ScriptComponent &  performer,
int  channel,
ScriptData *  sd,
Parameter &  out
)  const [inline, virtual]
 

Reimplemented in se_core::CustomScript, se_core::ReentrantScript, and se_core::TimelineScript.

Definition at line 64 of file Script.hpp.

void se_core::Script::nextAction (  const ScriptComponent &  performer,
int  channel,
ScriptData *  sd,
ActionAndParameter &  out
)  const [virtual]
 

Definition at line 61 of file Script.cpp.

References se_core::ActionAndParameter::parameter(), and se_core::ActionAndParameter::setAction().

virtual void se_core::Script::reinit (  const ScriptComponent &  performer,
ScriptData *  sd
)  const [inline, virtual]
 

Definition at line 59 of file Script.hpp.

virtual void se_core::Script::reinitPop (  const ScriptComponent &  performer,
ScriptData *  sd,
const char *  fromScript
)  const [inline, virtual]
 

Definition at line 60 of file Script.hpp.

void se_core::Script::release (  ScriptData *&  sd  )  const [inline]
 

Definition at line 62 of file Script.hpp.

virtual void se_core::Script::touched (  const ScriptComponent &  performer,
ScriptData *  sd,
void *  param
)  const [inline, virtual]
 

Definition at line 61 of file Script.hpp.

Referenced by se_core::ScriptComponent::touchDefault().

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:

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

SourceForge.net Logo