This contains the source code documentation of the class DialogicMusicEvent
.
DialogicMusicEvent
Inherits: DialogicEvent
Settings
Properties
Name | Type | Default |
---|---|---|
audio_bus | String | "Master" |
fade_length | float | 0.0 |
file_path | String | "" |
loop | bool | true |
volume | float | 0.0 |
Methods
Returns | Method |
---|---|
void | build_event_editor ( ) |
Dictionary | get_bus_suggestions ( ) |
String | get_shortcode ( ) |
Dictionary | get_shortcode_parameters ( ) |
Property Descriptions
The audio bus the music will be played at.
The length of the fade. If 0 (by default) it's an instant change.
The file to play. If empty, the previous music will be faded out.
If true, the audio will loop, otherwise only play once.
The volume the music will be played at.
Method Descriptions
func build_event_editor ( ) ⇒ void
No description available.
func get_bus_suggestions ( ) ⇒ Dictionary
No description available.
func get_shortcode ( ) ⇒ String
No description available.
func get_shortcode_parameters ( ) ⇒ Dictionary
No description available.