Script::DialogTake Class Reference
#include <dialogtake.h>
Inheritance diagram for Script::DialogTake:
Detailed Description
FIXME: the following description is no longer accurate!!!A dialog take is the smallest element of the dialog system. The take contain a id, a speaker-name, a type, a conditionhierarchy, a list of actions, a list of texts and a list of children. The id identifies the Take in the dialoghierarchy and must unique in the dialog. The speaker-name identifies the 'person' witch speaks. The type identifies the dialogtake as StartState, as Take or as Response. The conditionhierarchy is used to rule if the Take is active or not. The actions are executed if the Take is active. The list of texts represents the dialogtext witch the speaker is calling or the responsetext.
A complete overview of the dialog system can be found here: http://gambar/wiki/index.php/DSA_Story_Subsystem
(C) 2005 Radon Labs GmbH
Public Types | |
| enum | Type |
| take types | |
Public Member Functions | |
| DialogTake () | |
| constructor | |
| virtual | ~DialogTake () |
| destructor | |
| void | SetGuid (const Util::Guid &guid) |
| set the ID of the take | |
| const Util::Guid & | GetGuid () const |
| get the ID of the take | |
| void | SetId (const Util::String &id) |
| set the ID of the take | |
| const Util::String & | GetId () const |
| get the ID of the take | |
| void | SetSpeaker (const Util::String &speaker) |
| set the name of the speaker | |
| const Util::String & | GetSpeaker () const |
| get the name of the speaker | |
| void | SetEmote (const Util::String &emote) |
| set the emote string of the take | |
| const Util::String & | GetEmote () const |
| get the emote string of the take | |
| void | SetType (const Type type) |
| set the type of the Take | |
| Type | GetType () const |
| get the type of the Take | |
| void | SetSound (const Util::String &id) |
| set the sound name of the take | |
| const Util::String & | GetSound () const |
| get the sound name of the take | |
| void | SetShortText (const Util::String &id) |
| set the short text of the take | |
| const Util::String & | GetShortText () const |
| get the short text of the take | |
| void | SetTimeStamp (Timing::Time t) |
| set timestamp | |
| Timing::Time | GetTimeStamp () const |
| get timestamp | |
| void | SetActionRef (const Util::Guid &guid) |
| set action reference guid | |
| const Util::Guid & | GetActionRef () const |
| get action reference guid | |
| void | SetActionBlock (const Util::Guid &guid) |
| set action block guid | |
| const Util::Guid & | GetActionBock () const |
| get action block guid | |
| void | AddText (const Util::String &text) |
| add a text to the textlist | |
| const Util::Array< Util::String > & | GetTextList () |
| get the textlist | |
| void | AddAction (const Ptr< Actions::Action > &action) |
| add a action to the actionlist | |
| void | SetActionList (const Util::Array< Ptr< Actions::Action > > &actions) |
| set the actionlist | |
| const Util::Array< Ptr< Actions::Action > > & | GetActionList () |
| get the actionlist | |
| void | AddChildTake (const Ptr< DialogTake > &child) |
| add a child to the childlist | |
| const Util::Array< Ptr< DialogTake > > & | GetChildTakes () |
| get the childlist | |
| void | SetCondition (const Ptr< Conditions::Condition > &condition) |
| set the condition for this take | |
| const Ptr< Conditions::Condition > & | GetCondition () const |
| get the condition for this take | |
| bool | HasCondition () |
| return if take has a condition | |
| int | GetNumChildTakes () const |
| get the count of children takes | |
| void | ExecuteActions () |
| executes the actions of this take | |
| bool | Assert (const Ptr< Script::InfoLog > &infoLog) |
| executes the assert functions from the members of this take | |
| 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::String & | GetClassName () const |
| get the class name | |
| Util::FourCC | GetClassFourCC () const |
| get the class FourCC code | |
Static Public Member Functions | |
| static Type | StringToType (const Util::String &str) |
| convert string to take type | |
| static void | DumpRefCountingLeaks () |
| dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!) | |
Member Function Documentation
| bool Script::DialogTake::Assert | ( | const Ptr< Script::InfoLog > & | infoLog | ) |
executes the assert functions from the members of this take
Executes the assert functions from the members of this take. Additionally it collects errors in the info log object and returns false in case of errors instead of closing the application.
| 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.