Drag[en]gine Script Module DragonScript 1.32.1
Loading...
Searching...
No Matches
Dragengine.ConversationSystem.SimpleConversation Class Reference

Simple conversation. More...

Inheritance diagram for Dragengine.ConversationSystem.SimpleConversation:

Public Member Functions

void addActor (SimpleConversationActor actor)
 Add actor.
 
void addCamera (SimpleConversationCamera camera)
 Add camera.
 
void addSnippet (SimpleConversationSnippet snippet)
 Add snippet.
 
void forEachActor (Block ablock)
 Visit actors with block.
 
void forEachCamera (Block ablock)
 Visit cameras with block.
 
void forEachSnippet (Block ablock)
 Visit snippets with block.
 
int getActorCount ()
 Count of actors.
 
SimpleConversationActor getActorWith (StringID identifier)
 Actor with identifier or null.
 
int getSnippetCount ()
 Count of snippets.
 
SimpleConversationSnippet getSnippetWith (StringID identifier)
 Snippet with identifier or null.
 
SimpleConversation new (SimpleConversation conversation)
 Create deep copy of simple conversation.
 
SimpleConversation new (String pathFile)
 Create simple conversation.
 

Public Attributes

Dictionary pCameras
 
String pPathFile
 

Detailed Description

Simple conversation.

Version
1.25

Simple conversations allow to define quickly a conversation for use with the conversation system which is based on a simplified XML file. Regular conversations are powerful but can be tedious and time consuming for simple conversations which are not important nor complex. In a simple conversation the actors and the text they are speaking is mainly defined. Between switching actors talking random camera shot changes are added. Furthermore simple gestures can be easily defined right inside the text. See LoadSave.LoadSimpleConversation for an example XML definition.

Member Function Documentation

◆ addActor()

void Dragengine.ConversationSystem.SimpleConversation.addActor ( SimpleConversationActor  actor)

Add actor.

If actor with same name exists it is replaced.

◆ addCamera()

void Dragengine.ConversationSystem.SimpleConversation.addCamera ( SimpleConversationCamera  camera)

Add camera.

If camera with same name exists it is replaced.

◆ addSnippet()

void Dragengine.ConversationSystem.SimpleConversation.addSnippet ( SimpleConversationSnippet  snippet)

Add snippet.

If snippet with same name exists it is replaced.

◆ forEachActor()

void Dragengine.ConversationSystem.SimpleConversation.forEachActor ( Block  ablock)

Visit actors with block.

Block is required to have signature void(SimpleConversationActor actor) or void(int index, SimpleConversationActor actor).

◆ forEachCamera()

void Dragengine.ConversationSystem.SimpleConversation.forEachCamera ( Block  ablock)

Visit cameras with block.

Block is required to have signature void(SimpleConversationCamera camera) or void(int index, SimpleConversationCamera camera).

◆ forEachSnippet()

void Dragengine.ConversationSystem.SimpleConversation.forEachSnippet ( Block  ablock)

Visit snippets with block.

Block is required to have signature void(SimpleConversationSnippet snippet) or void(int index, SimpleConversationSnippet snippet).

◆ getActorCount()

int Dragengine.ConversationSystem.SimpleConversation.getActorCount ( )

Count of actors.

◆ getActorWith()

SimpleConversationActor Dragengine.ConversationSystem.SimpleConversation.getActorWith ( StringID  identifier)

Actor with identifier or null.

◆ getSnippetCount()

int Dragengine.ConversationSystem.SimpleConversation.getSnippetCount ( )

Count of snippets.

◆ getSnippetWith()

SimpleConversationSnippet Dragengine.ConversationSystem.SimpleConversation.getSnippetWith ( StringID  identifier)

Snippet with identifier or null.

◆ new() [1/2]

SimpleConversation Dragengine.ConversationSystem.SimpleConversation.new ( SimpleConversation  conversation)

Create deep copy of simple conversation.

◆ new() [2/2]

SimpleConversation Dragengine.ConversationSystem.SimpleConversation.new ( String  pathFile)

Create simple conversation.

Member Data Documentation

◆ pCameras

Dictionary Dragengine.ConversationSystem.SimpleConversation.pCameras

◆ pPathFile

String Dragengine.ConversationSystem.SimpleConversation.pPathFile

The documentation for this class was generated from the following file: