Drag[en]gine Script Module DragonScript Script API  1.0
DynamicMusicPart Class Reference

Dynamic music part. More...

Inheritance diagram for DynamicMusicPart:

Public Member Functions

void addTransition (DynamicMusicTransition transition)
 Add transition. More...
 
float getControllerValue ()
 Controller value to set if this part is selected. More...
 
Sound getMusic ()
 Music to play. More...
 
String getName ()
 Name. More...
 
DynamicMusicTransition getTransitionAt (int index)
 Get transition at index. More...
 
int getTransitionCount ()
 Number of transitions. More...
 
bool hasTransition (DynamicMusicTransition transition)
 Transition is present. More...
 
DynamicMusicPart new ()
 Create dynamic music part with null music for init use. More...
 
DynamicMusicPart new (String name)
 Create dynamic music part. More...
 
String nextPart ()
 Name of next part to play or null to stop. More...
 
void removeAllTransitions ()
 Remove all transitions. More...
 
void removeTransition (DynamicMusicTransition transition)
 Remove transition. More...
 
void setControllerValue (float value)
 Set controller value to set if this part is selected. More...
 
void setMusic (Sound music)
 Set music to play. More...
 

Detailed Description

Dynamic music part.

Music to play with transitions to next parts. If no transitions are defined or no transitions match the playback stops after this part. If music is null playback stops after this part. Use null music only for parts used as init part which are used only to find the first part to play.

Author
Roland Pl├╝ss
Version
1.0
Date
2016

Member Function Documentation

void addTransition ( DynamicMusicTransition  transition)

Add transition.

float getControllerValue ( )

Controller value to set if this part is selected.

Sound getMusic ( )

Music to play.

String getName ( )

Name.

DynamicMusicTransition getTransitionAt ( int  index)

Get transition at index.

int getTransitionCount ( )

Number of transitions.

bool hasTransition ( DynamicMusicTransition  transition)

Transition is present.

Create dynamic music part with null music for init use.

DynamicMusicPart new ( String  name)

Create dynamic music part.

String nextPart ( )

Name of next part to play or null to stop.

Returns the part of the first valid transition or our name.

void removeAllTransitions ( )

Remove all transitions.

void removeTransition ( DynamicMusicTransition  transition)

Remove transition.

void setControllerValue ( float  value)

Set controller value to set if this part is selected.

void setMusic ( Sound  music)

Set music to play.


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