DialogicSoundEvent

This contains the source code documentation of the class DialogicSoundEvent.

DialogicSoundEvent

Inherits: DialogicEvent

Settings

Properties

NameTypeDefault
file_pathString""
volumefloat0.0
audio_busString""
loopboolfalse

Methods

ReturnsMethod
Stringget_shortcode ( )
Dictionaryget_shortcode_parameters ( )
voidbuild_event_editor ( )
Dictionaryget_bus_suggestions ( )

Property Descriptions

var file_path = ""

The path to the file to play.

var volume = 0.0

The volume to play the sound at.

var audio_bus = ""

The bus to play the sound on.

var loop = false

If true, the sound will loop infinitely. Not recommended (as there is no way to stop it).

Method Descriptions

func get_shortcode ( ) ⇒ String

No description available.

func get_shortcode_parameters ( ) ⇒ Dictionary

No description available.

func build_event_editor ( ) ⇒ void

No description available.

func get_bus_suggestions ( ) ⇒ Dictionary

No description available.