Drag[en]gine Script Module DragonScript  1.23
Dragengine.Scenery.ECBehaviorActorCutscene Class Reference

Behavior adding cutscene support to actors. More...

Inheritance diagram for Dragengine.Scenery.ECBehaviorActorCutscene:
Dragengine.Scenery.DefaultECBehavior Dragengine.Scenery.ECBehavior Dragengine.Scenery.BehaviorCompatiblePersistency

Classes

class  BlockListenerFactory
 Factory creating listeners using block. More...
 
class  ConversationController
 Conversation condition and command controlling cutscene. More...
 
class  DefaultListener
 Default implementation of behavior instance listener. More...
 
interface  Listener
 Listener for behavior instance events. More...
 
interface  ListenerFactory
 Factory creating listeners. More...
 
enum  State
 States. More...
 

Additional Inherited Members

- Public Member Functions inherited from Dragengine.Scenery.DefaultECBehavior
void assignInstanceIndex (int instanceIndex)
 Assign instance index. More...
 
void dispose ()
 Dispose of behavior. More...
 
String getBehaviorID ()
 Unique identifier of behavior. More...
 
String getID ()
 Identifier. More...
 
int getInstanceIndex ()
 Instance index. More...
 
void loadSupportedData (String identifier, PersistencyEnvironment env, FileReader reader, ECBehaviorInstance instance)
 Load instance data of another behavior. More...
 
bool supportsBehaviorID (String identifier)
 Behavior supports loading instance data of another behavior. More...
 
- Public Member Functions inherited from Dragengine.Scenery.ECBehavior
ECBehaviorInstance createInstance (BehaviorElement element)
 Create Behavior instance. More...
 
- Protected Member Functions inherited from Dragengine.Scenery.DefaultECBehavior
DefaultECBehavior new (BehaviorElementClass eclass)
 Create default composeable behavior with empty identifier. More...
 
DefaultECBehavior new (BehaviorElementClass eclass, String id)
 Create default composeable behavior. More...
 
void setBehaviorID (String identifier)
 Set behavior identifier. More...
 
void useClassNameAsBehaviorID ()
 Set behavior identifier to "<class-name>:<identifier>". More...
 
void useFullyQualifiedClassNameAsBehaviorID ()
 Set behavior identifier to "<fully-qualified-class-name>:<identifier>". More...
 

Detailed Description

Behavior adding cutscene support to actors.

Allows actor to perform cutscene actions controlled by conversation scripts.

Loads a custom animator and applies it to ECBehaviorConversationActor. Controller mappings assigned to ECBehaviorConversationActor do affect the loaded animator so cutscene animators can integrate into switched animators. In addition this behavior adds a controller named "cutscene" which is used to play back the cutscene.

Upon starting the animation captures the current animation state into state number 0. This allows cutscenes to blend over from the current state if required.

Supports adding break points to interrupt playing back a cutscene until the conversation script decides to continue. This allows for special configurations and requires the used animator to support playing back an idle animation (for example using "idle" controller) while the cutscene controller is frozen at the break point value.

Also supports loading a sound or synthesizer to play back while the cutscene is running.

When using this behavior make sure the BaseActorAction subclass used supports changing animator assigned to ECBehaviorActorAnimated while the action is in used. If this is not the case the BaseActorAction subclass can access AnimatorController of the previous animator causing problems.

Adds these conversation condition and command named "cutscene".

Element class property prefix is "cutscene".


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