The Nebula Device 3: Script::ActionReader Class Reference

The Nebula Device 3

Script::ActionReader Class Reference

#include <actionreader.h>

Inheritance diagram for Script::ActionReader:

Core::RefCounted

Detailed Description

Provides functionality to read and write masterEvents and conditions from and to strings.

Note: Be aware that SetString will already tokenize the given string and therefore a lot of the work is done here (dont call it too often).

(C) 2006 Radon Labs GmbH

Public Member Functions

 ActionReader ()
 constructor
virtual ~ActionReader ()
 destructor
int GetRefCount () const
 get the current refcount
void AddRef ()
 increment refcount by one
void Release ()
 decrement refcount and destroy object if refcount is zero
bool IsInstanceOf (const Rtti &rtti) const
 return true if this object is instance of given class
bool IsInstanceOf (const Util::String &className) const
 return true if this object is instance of given class by string
bool IsInstanceOf (const Util::FourCC &classFourCC) const
 return true if this object is instance of given class by fourcc
bool IsA (const Rtti &rtti) const
 return true if this object is instance of given class, or a derived class
bool IsA (const Util::String &rttiName) const
 return true if this object is instance of given class, or a derived class, by string
bool IsA (const Util::FourCC &rttiFourCC) const
 return true if this object is instance of given class, or a derived class, by fourcc
const Util::StringGetClassName () const
 get the class name
Util::FourCC GetClassFourCC () const
 get the class FourCC code
void SetString (const Util::String &actionString)
 set the string to be parsed (read mode)
Ptr< Actions::ActionGetAction ()
 generate an action from the string (read mode)
Ptr< Conditions::ConditionGetCondition ()
 generate an action from the string (read mode)
Util::String GetClass ()
 get classname
int GetInt ()
 get an int
bool GetBool ()
 get a bool
float GetFloat ()
 get a float
Util::String GetString ()
 get a string
Ptr< Game::EntityGetEntity ()
 get an entity (might be 0)
Math::vector GetVector ()
 get a vector3
Math::float4 GetFloat4 ()
 get a vector4
int Version () const
 return content version of the action string
const Util::StringGetActionString () const
 get the action string (write mode)
void PutClass (Ptr< Core::RefCounted > &refcounted)
 put the classname
void PutInt (int value)
 put an int
void PutBool (bool value)
 put a bool
void PutFloat (float value)
 put a float
void PutString (const Util::String &text)
 put a string
void PutEntity (Ptr< Game::Entity > entity)
 put an entity (might be 0)
void PutVector (const Math::vector &vec)
 put a vector3
void PutFloat4 (const Math::float4 &vec)
 put a vector4
void PutVersion (int version)
 put

Static Public Member Functions

static void DumpRefCountingLeaks ()
 dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)

Protected Member Functions

Util::String NextToken (const Util::String &sourceString, int &startIndex, char limiter)
 helper function to extract data from string until limiter
Util::String NextToken (const Util::String &sourceString, int &startIndex)
 helper function to extract data from string until " " or ";"

Member Function Documentation

int Core::RefCounted::GetRefCount (  )  const [inline, inherited]

get the current refcount

Return the current refcount of the object.

void Core::RefCounted::AddRef (  )  [inline, inherited]

increment refcount by one

Increment the refcount of the object.

void Core::RefCounted::Release (  )  [inline, inherited]

decrement refcount and destroy object if refcount is zero

Decrement the refcount and destroy object if refcount is zero.

const Util::String & Core::RefCounted::GetClassName (  )  const [inline, inherited]

get the class name

Get the class name of the object.

Util::FourCC Core::RefCounted::GetClassFourCC (  )  const [inline, inherited]

get the class FourCC code

Get the class FourCC of the object.

void Core::RefCounted::DumpRefCountingLeaks (  )  [static, inherited]

dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)

This method should be called as the very last before an application exits.