Dynamic music part. More...
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.
Member Function Documentation
◆ addTransition()
| void Dragengine.Audio.DynamicMusic.DynamicMusicPart.addTransition | ( | DynamicMusicTransition | transition | ) |
Add transition.
◆ getControllerValue()
| float Dragengine.Audio.DynamicMusic.DynamicMusicPart.getControllerValue | ( | ) |
Controller value to set if this part is selected.
◆ getMusic()
| Sound Dragengine.Audio.DynamicMusic.DynamicMusicPart.getMusic | ( | ) |
Music to play.
◆ getName()
| String Dragengine.Audio.DynamicMusic.DynamicMusicPart.getName | ( | ) |
Name.
◆ getTransitionAt()
| DynamicMusicTransition Dragengine.Audio.DynamicMusic.DynamicMusicPart.getTransitionAt | ( | int | index | ) |
Get transition at index.
◆ getTransitionCount()
| int Dragengine.Audio.DynamicMusic.DynamicMusicPart.getTransitionCount | ( | ) |
Number of transitions.
◆ hasTransition()
| bool Dragengine.Audio.DynamicMusic.DynamicMusicPart.hasTransition | ( | DynamicMusicTransition | transition | ) |
Transition is present.
◆ new() [1/2]
| DynamicMusicPart Dragengine.Audio.DynamicMusic.DynamicMusicPart.new | ( | ) |
Create dynamic music part with null music for init use.
◆ new() [2/2]
| DynamicMusicPart Dragengine.Audio.DynamicMusic.DynamicMusicPart.new | ( | String | name | ) |
Create dynamic music part.
◆ nextPart()
| String Dragengine.Audio.DynamicMusic.DynamicMusicPart.nextPart | ( | ) |
Name of next part to play or null to stop.
Returns the part of the first valid transition or our name.
◆ removeAllTransitions()
| void Dragengine.Audio.DynamicMusic.DynamicMusicPart.removeAllTransitions | ( | ) |
Remove all transitions.
◆ removeTransition()
| void Dragengine.Audio.DynamicMusic.DynamicMusicPart.removeTransition | ( | DynamicMusicTransition | transition | ) |
Remove transition.
◆ setControllerValue()
| void Dragengine.Audio.DynamicMusic.DynamicMusicPart.setControllerValue | ( | float | value | ) |
Set controller value to set if this part is selected.
◆ setMusic()
| void Dragengine.Audio.DynamicMusic.DynamicMusicPart.setMusic | ( | Sound | music | ) |
Set music to play.
The documentation for this class was generated from the following file:
