This contains the source code documentation of the class DialogicBackgroundEvent.
DialogicBackgroundEvent
Inherits: DialogicEvent
Event to show scenes in the background and switch between them.
Properties
Methods
| Returns | Method |
|---|---|
| String | get_shortcode ( ) |
| Dictionary | get_shortcode_parameters ( ) |
| void | build_event_editor ( ) |
| Dictionary | get_transition_suggestions ( _filter: String = "" ) |
Constants
No description available.
No description available.
No description available.
No description available.
Property Descriptions
The scene to use. If empty, this will default to the DefaultBackground.gd scene. This scene supports images and fading. If you set it to a scene path, then that scene will be instanced. Learn more about custom backgrounds in the Subsystem_Background.gd docs.
The argument that is passed to the background scene. For the default scene it's the path to the image to show.
The time the fade animation will take. Leave at 0 for instant change.
Name of the transition to use.
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_transition_suggestions ( _filter: String = "" ) ⇒ Dictionary
No description available.