1. 1. Introduction
    ❱
    1. 1.1. Getting Started
  2. 2. FAQ
  3. 3. Character & Portraits
    ❱
    1. 3.1. Custom Portraits
    2. 3.2. Layered Portraits
  4. 4. Styles & Layouts
    ❱
    1. 4.1. Dialogic Nodes
  5. 5. Writing Texts
    ❱
    1. 5.1. Text Effects
    2. 5.2. Text Modifiers
  6. 6. Variables
  7. 7. Timelines
    ❱
    1. 7.1. Timeline Text Syntax
    2. 7.2. Creating Timelines In Code
  8. 8. Events
    ❱
    1. 8.1. Character Event
  9. 9. Input
    ❱
    1. 9.1. Auto-Advance
    2. 9.2. Auto-Skip
  10. 10. Utilities
    ❱
    1. 10.1. Dialogic Signals
    2. 10.2. Pausing
    3. 10.3. Saving & Loading
    4. 10.4. Reference Manager
    5. 10.5. Creating Extensions
    6. 10.6. Glossary
    7. 10.7. Translations
  11. 11. Class Reference
    ❱
    1. 11.1. Event
      ❱
      1. 11.1.1. BackgroundEvent
      2. 11.1.2. CallEvent
      3. 11.1.3. CharacterEvent
      4. 11.1.4. ChoiceEvent
      5. 11.1.5. CommentEvent
      6. 11.1.6. ConditionEvent
      7. 11.1.7. EndBranchEvent
      8. 11.1.8. EndTimelineEvent
      9. 11.1.9. Event
      10. 11.1.10. GlossaryEvent
      11. 11.1.11. HistoryEvent
      12. 11.1.12. JumpEvent
      13. 11.1.13. LabelEvent
      14. 11.1.14. DialogiClearEvent
      15. 11.1.15. MusicEvent
      16. 11.1.16. PositionEvent
      17. 11.1.17. ReturnEvent
      18. 11.1.18. SaveEvent
      19. 11.1.19. SettingEvent
      20. 11.1.20. SignalEvent
      21. 11.1.21. SoundEvent
      22. 11.1.22. StyleEvent
      23. 11.1.23. TextEvent
      24. 11.1.24. TextInputEvent
      25. 11.1.25. VariableEvent
      26. 11.1.26. VoiceEvent
      27. 11.1.27. WaitEvent
      28. 11.1.28. WaitInputEvent
    2. 11.2. Subsystem
      ❱
      1. 11.2.1. Audio
      2. 11.2.2. Backgrounds
      3. 11.2.3. Portraits
      4. 11.2.4. Choices
      5. 11.2.5. Animation
      6. 11.2.6. Expression
      7. 11.2.7. Input
      8. 11.2.8. Glossary
      9. 11.2.9. History
      10. 11.2.10. Jump
      11. 11.2.11. Save
      12. 11.2.12. Settings
      13. 11.2.13. Styles
      14. 11.2.14. Text
      15. 11.2.15. Text Input
      16. 11.2.16. Variables
      17. 11.2.17. Voice
    3. 11.3. Node
      ❱
      1. 11.3.1. Node_BackgroundHolder
      2. 11.3.2. Node_ButtonSound
      3. 11.3.3. Node_ChoiceButton
      4. 11.3.4. Node_DialogText
      5. 11.3.5. Node_Input
      6. 11.3.6. Node_NameLabel
      7. 11.3.7. Node_PortraitContainer
      8. 11.3.8. Node_StyleLayer
      9. 11.3.9. Node_TextBubble
      10. 11.3.10. Node_TextInput
      11. 11.3.11. Node_TypeSounds
    4. 11.4. Resource
      ❱
      1. 11.4.1. Character
      2. 11.4.2. CharacterFormatLoader
      3. 11.4.3. CharacterFormatSaver
      4. 11.4.4. Glossary
      5. 11.4.5. Style
      6. 11.4.6. StyleLayer
      7. 11.4.7. Timeline
      8. 11.4.8. TimelineFormatLoader
      9. 11.4.9. TimelineFormatSaver
    5. 11.5. Other
      ❱
      1. 11.5.1. DCSS
      2. 11.5.2. Animation
      3. 11.5.3. AutoAdvance
      4. 11.5.4. AutoSkip
      5. 11.5.5. Background
      6. 11.5.6. BackgroundTransition
      7. 11.5.7. CharacterEditorMainSection
      8. 11.5.8. CharacterEditorPortraitSection
      9. 11.5.9. CsvFile
      10. 11.5.10. Editor
      11. 11.5.11. GameHandler
      12. 11.5.12. Indexer
      13. 11.5.13. LayoutBase
      14. 11.5.14. LayoutLayer
      15. 11.5.15. Portrait
      16. 11.5.16. ResourceUtil
      17. 11.5.17. SettingsPage
      18. 11.5.18. Subsystem
      19. 11.5.19. Util
      20. 11.5.20. VisualEditorField
  12. Contributing

Dialogic 2 Documentation

DialogicBackgroundEvent

This contains the source code documentation of the class DialogicBackgroundEvent.

DialogicBackgroundEvent

Inherits: DialogicEvent

Settings

Properties

NameTypeDefault
sceneString""
argumentString""
fadefloat0.0
transitionString""

Methods

ReturnsMethod
Stringget_shortcode ( )
Dictionaryget_shortcode_parameters ( )
voidbuild_event_editor ( )
Dictionaryget_transition_suggestions ( _filter: String = "" )

Constants

const IMAGE = 0

No description available.


const CUSTOM = 1

No description available.


const DEFAULT = 0

No description available.


const CUSTOM = 1

No description available.


Property Descriptions

var scene = ""

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.


var argument = ""

The argument that is passed to the background scene. For the default scene it's the path to the image to show.


var fade = 0.0

The time the fade animation will take. Leave at 0 for instant change.


var transition = ""

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.