From 7b117f8e99919ad32dd8c7c48d0e5eddd35a1dd4 Mon Sep 17 00:00:00 2001 From: Cake <65981767+CakeVR@users.noreply.github.com> Date: Mon, 30 Sep 2024 12:06:26 +0200 Subject: [PATCH] Update Classes to Dialogic 2.0 - Alpha 15 (#64) --- documentation/class_index.md | 179 +++++------ documentation/classes/class_dcss.md | 22 -- .../classes/class_dialogicanimation.md | 89 +++++- .../classes/class_dialogicautoadvance.md | 72 ++--- .../classes/class_dialogicautoskip.md | 18 +- .../classes/class_dialogicbackground.md | 10 +- .../classes/class_dialogicbackgroundevent.md | 26 +- .../class_dialogicbackgroundtransition.md | 44 +-- .../classes/class_dialogiccallevent.md | 42 +-- .../classes/class_dialogiccharacter.md | 70 ++--- ..._dialogiccharactereditorportraitsection.md | 10 +- .../classes/class_dialogiccharacterevent.md | 232 +++++++++++---- .../classes/class_dialogicchoiceevent.md | 61 +++- ...arevent.md => class_dialogicclearevent.md} | 38 +-- .../classes/class_dialogiccommentevent.md | 8 +- .../classes/class_dialogicconditionevent.md | 34 +-- .../classes/class_dialogiccsvfile.md | 54 ++-- documentation/classes/class_dialogiceditor.md | 16 +- .../classes/class_dialogicendbranchevent.md | 18 +- .../classes/class_dialogicendtimelineevent.md | 6 +- documentation/classes/class_dialogicevent.md | 280 +++++++++++------- .../classes/class_dialogicgamehandler.md | 209 ++++++------- .../classes/class_dialogicglossary.md | 68 ++--- .../classes/class_dialogicglossaryevent.md | 12 +- .../classes/class_dialogichistoryevent.md | 8 +- .../classes/class_dialogicindexer.md | 19 +- .../classes/class_dialogicjumpevent.md | 34 +-- .../classes/class_dialogiclabelevent.md | 28 +- .../classes/class_dialogiclayoutbase.md | 22 +- .../classes/class_dialogiclayoutlayer.md | 10 +- .../classes/class_dialogicmusicevent.md | 34 +-- .../classes/class_dialogicnode_buttonsound.md | 12 +- .../class_dialogicnode_choicebutton.md | 31 +- .../classes/class_dialogicnode_dialogtext.md | 54 ++-- .../class_dialogicnode_nextindicator.md | 56 +++- .../class_dialogicnode_portraitcontainer.md | 149 +++++++--- .../classes/class_dialogicnode_textbubble.md | 200 ------------- .../classes/class_dialogicnode_textinput.md | 28 +- .../classes/class_dialogicnode_typesounds.md | 66 ++--- .../class_dialogicportraitanimationutil.md | 98 ++++++ .../classes/class_dialogicpositionevent.md | 138 --------- .../classes/class_dialogicresourceutil.md | 117 ++++---- .../classes/class_dialogicreturnevent.md | 16 +- .../classes/class_dialogicsaveevent.md | 8 +- .../classes/class_dialogicsettingevent.md | 30 +- .../classes/class_dialogicsidebar.md | 225 ++++++++++++++ .../class_dialogicsidebar.resourcelistitem.md | 112 +++++++ .../classes/class_dialogicsignalevent.md | 18 +- .../classes/class_dialogicsoundevent.md | 32 +- documentation/classes/class_dialogicstyle.md | 82 ++--- .../classes/class_dialogicstyleevent.md | 16 +- .../classes/class_dialogicstylelayer.md | 6 +- .../classes/class_dialogicsubsystem.md | 25 +- .../classes/class_dialogictextevent.md | 103 +++---- .../classes/class_dialogictextinputevent.md | 30 +- .../classes/class_dialogictimeline.md | 30 +- documentation/classes/class_dialogicutil.md | 163 +++++----- .../classes/class_dialogicvariableevent.md | 30 +- .../class_dialogicvisualeditorfield.md | 6 +- .../class_dialogicvisualeditorfieldnumber.md | 38 +-- .../classes/class_dialogicvoiceevent.md | 22 +- .../classes/class_dialogicwaitevent.md | 18 +- .../classes/class_dialogicwaitinputevent.md | 8 +- documentation/classes/subsystem_animation.md | 36 ++- documentation/classes/subsystem_audio.md | 67 +++-- .../classes/subsystem_backgrounds.md | 34 +-- documentation/classes/subsystem_choices.md | 77 ++--- documentation/classes/subsystem_containers.md | 212 +++++++++++++ documentation/classes/subsystem_expression.md | 45 ++- documentation/classes/subsystem_glossary.md | 32 +- documentation/classes/subsystem_history.md | 173 +++++++---- documentation/classes/subsystem_input.md | 69 +++-- documentation/classes/subsystem_jump.md | 40 +-- documentation/classes/subsystem_portraits.md | 171 +++++------ documentation/classes/subsystem_save.md | 161 ++++++---- documentation/classes/subsystem_settings.md | 26 +- documentation/classes/subsystem_styles.md | 54 ++-- documentation/classes/subsystem_text.md | 247 ++++++++------- documentation/classes/subsystem_text_input.md | 10 +- documentation/classes/subsystem_variables.md | 65 ++-- .../subsystem_variables.variablefolder.md | 16 +- documentation/classes/subsystem_voice.md | 68 ++--- 82 files changed, 3143 insertions(+), 2200 deletions(-) rename documentation/classes/{class_dialogiclearevent.md => class_dialogicclearevent.md} (98%) delete mode 100644 documentation/classes/class_dialogicnode_textbubble.md create mode 100644 documentation/classes/class_dialogicportraitanimationutil.md delete mode 100644 documentation/classes/class_dialogicpositionevent.md create mode 100644 documentation/classes/class_dialogicsidebar.md create mode 100644 documentation/classes/class_dialogicsidebar.resourcelistitem.md create mode 100644 documentation/classes/subsystem_containers.md diff --git a/documentation/class_index.md b/documentation/class_index.md index ece0a05..ebaa1ad 100644 --- a/documentation/class_index.md +++ b/documentation/class_index.md @@ -6,98 +6,103 @@ *All classes from the Dialogic 2 source code.* - [Subsystem]() - - [Audio](classes/subsystem_audio.md) - - [Backgrounds](classes/subsystem_backgrounds.md) - - [Portraits](classes/subsystem_portraits.md) - - [Choices](classes/subsystem_choices.md) - - [Animation](classes/subsystem_animation.md) - - [Expression](classes/subsystem_expression.md) - - [Input](classes/subsystem_input.md) - - [Glossary](classes/subsystem_glossary.md) - - [History](classes/subsystem_history.md) - - [Jump](classes/subsystem_jump.md) - - [Save](classes/subsystem_save.md) - - [Settings](classes/subsystem_settings.md) - - [Styles](classes/subsystem_styles.md) - - [Text](classes/subsystem_text.md) - - [Text_input](classes/subsystem_text_input.md) - - [Variables.VariableFolder](classes/subsystem_variables.variablefolder.md) - - [Variables](classes/subsystem_variables.md) - - [Voice](classes/subsystem_voice.md) + - [Audio](class__subsystem_audio.md) + - [Backgrounds](class__subsystem_backgrounds.md) + - [Containers](class__subsystem_containers.md) + - [Portraits](class__subsystem_portraits.md) + - [Choices](class__subsystem_choices.md) + - [Animation](class__subsystem_animation.md) + - [Expression](class__subsystem_expression.md) + - [Input](class__subsystem_input.md) + - [Glossary](class__subsystem_glossary.md) + - [History](class__subsystem_history.md) + - [Jump](class__subsystem_jump.md) + - [Save](class__subsystem_save.md) + - [Settings](class__subsystem_settings.md) + - [Styles](class__subsystem_styles.md) + - [Text](class__subsystem_text.md) + - [Text_input](class__subsystem_text_input.md) + - [Variables.VariableFolder](class__subsystem_variables.variablefolder.md) + - [Variables](class__subsystem_variables.md) + - [Voice](class__subsystem_voice.md) - [Event]() - - [BackgroundEvent](classes/class_dialogicbackgroundevent.md) - - [CallEvent](classes/class_dialogiccallevent.md) - - [CharacterEvent](classes/class_dialogiccharacterevent.md) - - [ChoiceEvent](classes/class_dialogicchoiceevent.md) - - [CommentEvent](classes/class_dialogiccommentevent.md) - - [ConditionEvent](classes/class_dialogicconditionevent.md) - - [EndBranchEvent](classes/class_dialogicendbranchevent.md) - - [EndTimelineEvent](classes/class_dialogicendtimelineevent.md) - - [Event](classes/class_dialogicevent.md) - - [GlossaryEvent](classes/class_dialogicglossaryevent.md) - - [HistoryEvent](classes/class_dialogichistoryevent.md) - - [JumpEvent](classes/class_dialogicjumpevent.md) - - [LabelEvent](classes/class_dialogiclabelevent.md) - - [learEvent](classes/class_dialogiclearevent.md) - - [MusicEvent](classes/class_dialogicmusicevent.md) - - [PositionEvent](classes/class_dialogicpositionevent.md) - - [ReturnEvent](classes/class_dialogicreturnevent.md) - - [SaveEvent](classes/class_dialogicsaveevent.md) - - [SettingEvent](classes/class_dialogicsettingevent.md) - - [SignalEvent](classes/class_dialogicsignalevent.md) - - [SoundEvent](classes/class_dialogicsoundevent.md) - - [StyleEvent](classes/class_dialogicstyleevent.md) - - [TextEvent](classes/class_dialogictextevent.md) - - [TextInputEvent](classes/class_dialogictextinputevent.md) - - [VariableEvent](classes/class_dialogicvariableevent.md) - - [VoiceEvent](classes/class_dialogicvoiceevent.md) - - [WaitEvent](classes/class_dialogicwaitevent.md) - - [WaitInputEvent](classes/class_dialogicwaitinputevent.md) + - [BackgroundEvent](class__dialogicbackgroundevent.md) + - [CallEvent](class__dialogiccallevent.md) + - [CharacterEvent](class__dialogiccharacterevent.md) + - [ChoiceEvent](class__dialogicchoiceevent.md) + - [ClearEvent](class__dialogicclearevent.md) + - [CommentEvent](class__dialogiccommentevent.md) + - [ConditionEvent](class__dialogicconditionevent.md) + - [EndBranchEvent](class__dialogicendbranchevent.md) + - [EndTimelineEvent](class__dialogicendtimelineevent.md) + - [Event](class__dialogicevent.md) + - [GlossaryEvent](class__dialogicglossaryevent.md) + - [HistoryEvent](class__dialogichistoryevent.md) + - [JumpEvent](class__dialogicjumpevent.md) + - [LabelEvent](class__dialogiclabelevent.md) + - [MusicEvent](class__dialogicmusicevent.md) + - [ReturnEvent](class__dialogicreturnevent.md) + - [SaveEvent](class__dialogicsaveevent.md) + - [SettingEvent](class__dialogicsettingevent.md) + - [SignalEvent](class__dialogicsignalevent.md) + - [SoundEvent](class__dialogicsoundevent.md) + - [StyleEvent](class__dialogicstyleevent.md) + - [TextEvent](class__dialogictextevent.md) + - [TextInputEvent](class__dialogictextinputevent.md) + - [VariableEvent](class__dialogicvariableevent.md) + - [VoiceEvent](class__dialogicvoiceevent.md) + - [WaitEvent](class__dialogicwaitevent.md) + - [WaitInputEvent](class__dialogicwaitinputevent.md) - [Resource]() - - [Character](classes/class_dialogiccharacter.md) - - [CharacterFormatLoader](classes/class_dialogiccharacterformatloader.md) - - [CharacterFormatSaver](classes/class_dialogiccharacterformatsaver.md) - - [Glossary](classes/class_dialogicglossary.md) - - [Style](classes/class_dialogicstyle.md) - - [StyleLayer](classes/class_dialogicstylelayer.md) - - [Timeline](classes/class_dialogictimeline.md) - - [TimelineFormatLoader](classes/class_dialogictimelineformatloader.md) - - [TimelineFormatSaver](classes/class_dialogictimelineformatsaver.md) + - [Character](class__dialogiccharacter.md) + - [CharacterFormatLoader](class__dialogiccharacterformatloader.md) + - [CharacterFormatSaver](class__dialogiccharacterformatsaver.md) + - [Glossary](class__dialogicglossary.md) + - [Style](class__dialogicstyle.md) + - [StyleLayer](class__dialogicstylelayer.md) + - [Timeline](class__dialogictimeline.md) + - [TimelineFormatLoader](class__dialogictimelineformatloader.md) + - [TimelineFormatSaver](class__dialogictimelineformatsaver.md) - [Node]() - - [BackgroundHolder](classes/class_dialogicnode_backgroundholder.md) - - [ButtonSound](classes/class_dialogicnode_buttonsound.md) - - [ChoiceButton](classes/class_dialogicnode_choicebutton.md) - - [DialogText](classes/class_dialogicnode_dialogtext.md) - - [Input](classes/class_dialogicnode_input.md) - - [NameLabel](classes/class_dialogicnode_namelabel.md) - - [NextIndicator](classes/class_dialogicnode_nextindicator.md) - - [PortraitContainer](classes/class_dialogicnode_portraitcontainer.md) - - [StyleLayer](classes/class_dialogicnode_stylelayer.md) - - [TextBubble](classes/class_dialogicnode_textbubble.md) - - [TextInput](classes/class_dialogicnode_textinput.md) - - [TypeSounds](classes/class_dialogicnode_typesounds.md) + - [BackgroundHolder](class__dialogicnode_backgroundholder.md) + - [ButtonSound](class__dialogicnode_buttonsound.md) + - [ChoiceButton](class__dialogicnode_choicebutton.md) + - [DialogText](class__dialogicnode_dialogtext.md) + - [Input](class__dialogicnode_input.md) + - [NameLabel](class__dialogicnode_namelabel.md) + - [NextIndicator](class__dialogicnode_nextindicator.md) + - [PortraitContainer](class__dialogicnode_portraitcontainer.md) + - [StyleLayer](class__dialogicnode_stylelayer.md) + - [TextInput](class__dialogicnode_textinput.md) + - [TypeSounds](class__dialogicnode_typesounds.md) - [Other]() - - [Animation](classes/class_dialogicanimation.md) - - [AutoAdvance](classes/class_dialogicautoadvance.md) - - [AutoSkip](classes/class_dialogicautoskip.md) - - [Background](classes/class_dialogicbackground.md) - - [BackgroundTransition](classes/class_dialogicbackgroundtransition.md) - - [CharacterEditorMainSection](classes/class_dialogiccharactereditormainsection.md) - - [CharacterEditorPortraitSection](classes/class_dialogiccharactereditorportraitsection.md) - - [CsvFile](classes/class_dialogiccsvfile.md) - - [Editor](classes/class_dialogiceditor.md) - - [GameHandler](classes/class_dialogicgamehandler.md) - - [Indexer](classes/class_dialogicindexer.md) - - [LayoutBase](classes/class_dialogiclayoutbase.md) - - [LayoutLayer](classes/class_dialogiclayoutlayer.md) - - [Portrait](classes/class_dialogicportrait.md) - - [ResourceUtil](classes/class_dialogicresourceutil.md) - - [SettingsPage](classes/class_dialogicsettingspage.md) - - [Subsystem](classes/class_dialogicsubsystem.md) - - [Util](classes/class_dialogicutil.md) - - [VisualEditorField](classes/class_dialogicvisualeditorfield.md) - + - [DCSS](class__dcss.md) + - [Animation](class__dialogicanimation.md) + - [AutoAdvance](class__dialogicautoadvance.md) + - [AutoSkip](class__dialogicautoskip.md) + - [Background](class__dialogicbackground.md) + - [BackgroundTransition](class__dialogicbackgroundtransition.md) + - [CharacterEditorMainSection](class__dialogiccharactereditormainsection.md) + - [CharacterEditorPortraitSection](class__dialogiccharactereditorportraitsection.md) + - [CsvFile](class__dialogiccsvfile.md) + - [Editor](class__dialogiceditor.md) + - [GameHandler](class__dialogicgamehandler.md) + - [Indexer](class__dialogicindexer.md) + - [LayoutBase](class__dialogiclayoutbase.md) + - [LayoutLayer](class__dialogiclayoutlayer.md) + - [ManualAdvance](class__dialogicmanualadvance.md) + - [Portrait](class__dialogicportrait.md) + - [PortraitAnimationUtil](class__dialogicportraitanimationutil.md) + - [ResourceUtil](class__dialogicresourceutil.md) + - [SettingsPage](class__dialogicsettingspage.md) + - [Sidebar.ResourceListItem](class__dialogicsidebar.resourcelistitem.md) + - [Sidebar](class__dialogicsidebar.md) + - [Subsystem](_dialogicsubsystem.md) + - [Util](class__dialogicutil.md) + - [VisualEditorField](class__dialogicvisualeditorfield.md) + - [VisualEditorFieldNumber](class__dialogicvisualeditorfieldnumber.md) + - [VisualEditorFieldVector](class__dialogicvisualeditorfieldvector.md) diff --git a/documentation/classes/class_dcss.md b/documentation/classes/class_dcss.md index 3c10dff..23b205d 100644 --- a/documentation/classes/class_dcss.md +++ b/documentation/classes/class_dcss.md @@ -14,24 +14,12 @@ ## Methods Returns | Method --- | --- -[float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | [get_editor_scale](#method-get_editor_scale) ( ) [StyleBoxFlat](https://docs.godotengine.org/en/latest/classes/class_styleboxflat.html#class-styleboxflat) | [inline](#method-inline) ( `style`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) ) -[StyleBoxFlat](https://docs.godotengine.org/en/latest/classes/class_styleboxflat.html#class-styleboxflat) | [style](#method-style) ( `node`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant), `style`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) ) --- ## Method Descriptions -**func [get_editor_scale](#method-get_editor_scale) ( ) ⇒ [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float)** - - - - *No description available.* - ---- - - - **func [inline](#method-inline) ( `style`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) ) ⇒ [StyleBoxFlat](https://docs.godotengine.org/en/latest/classes/class_styleboxflat.html#class-styleboxflat)** @@ -40,13 +28,3 @@ Returns | Method --- - - -**func [style](#method-style) ( `node`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant), `style`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) ) ⇒ [StyleBoxFlat](https://docs.godotengine.org/en/latest/classes/class_styleboxflat.html#class-styleboxflat)** - - - - *No description available.* - ---- - diff --git a/documentation/classes/class_dialogicanimation.md b/documentation/classes/class_dialogicanimation.md index af95da9..5eaf9ef 100644 --- a/documentation/classes/class_dialogicanimation.md +++ b/documentation/classes/class_dialogicanimation.md @@ -12,11 +12,12 @@ Class that can be used to animate portraits. Can be extended to create animation ## Properties Name | Type | Default --- | --- | --- -[end_position](#property-end_position) | [Vector2](https://docs.godotengine.org/en/latest/classes/class_vector2.html#class-vector2) | [node](#property-node) | [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) | -[orig_pos](#property-orig_pos) | [Vector2](https://docs.godotengine.org/en/latest/classes/class_vector2.html#class-vector2) | -[repeats](#property-repeats) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | [time](#property-time) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | +[base_position](#property-base_position) | [Vector2](https://docs.godotengine.org/en/latest/classes/class_vector2.html#class-vector2) | +[base_scale](#property-base_scale) | [Vector2](https://docs.godotengine.org/en/latest/classes/class_vector2.html#class-vector2) | +[repeats](#property-repeats) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | +[is_reversed](#property-is_reversed) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` --- ## Methods @@ -26,12 +27,21 @@ Returns | Method void | [finished_one_loop](#method-finished_one_loop) ( ) void | [pause](#method-pause) ( ) void | [resume](#method-resume) ( ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_modulation_property](#method-get_modulation_property) ( ) --- +## Constants -## Signals +**const IN = 1** + + + + *No description available.* + +--- -**signal [finished](#signal-finished) ( )** + +**const OUT = 2** @@ -40,8 +50,16 @@ Returns | Method --- +**const ACTION = 3** + + + + *No description available.* + +--- -**signal [finished_once](#signal-finished_once) ( )** + +**const CROSSFADE = 4** @@ -49,18 +67,29 @@ Returns | Method --- -## Property Descriptions +## Signals + + +**signal [finished_once](#signal-finished_once) ( )** -**var end_position** + *No description available.* + +--- + +**signal [finished](#signal-finished) ( )** + -Set at runtime, will be the position at which to end the animation. + + *No description available.* --- +## Property Descriptions + **var node** @@ -73,11 +102,31 @@ Set at runtime, will be the node to animate. -**var orig_pos** +**var time** + + + +Set at runtime, will be the length of the animation. + +--- + + + +**var base_position** -Set at runtime. The position the node started at. +Set at runtime, will be the base position of the node. Depending on the animation, this might be the start, end or both. + +--- + + + +**var base_scale** + + + +Set at runtime, will be the base scale of the node. --- @@ -93,11 +142,11 @@ Used to repeate the animation for a number of times. -**var time** +**var is_reversed = false** -Set at runtime, will be the length of the animation. +If `true`, the animation will be reversed. This must be implemented by each animation or it will have no effect. --- @@ -109,7 +158,7 @@ Set at runtime, will be the length of the animation. -To be overridden. Do the actual animating/tweening in here. Use the properties , , , . +To be overridden. Do the actual animating/tweening in here. Use the properties `node`, `time`, `base_position`, etc. --- @@ -119,7 +168,7 @@ To be overridden. Do the actual animating/tweening in here. Use the properties , - *No description available.* +This method controls whether to repeat the animation or not. Animations must call this once they finished an animation. --- @@ -143,3 +192,13 @@ To be overridden. Do the actual animating/tweening in here. Use the properties , --- + + +**func [get_modulation_property](#method-get_modulation_property) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** + + + +If the animation wants to change the modulation, this method will return the property to change. The [CanvasGroup](class_canvasgroup.md) can use `self_modulate` instead of `modulate` to uniformly change the modulation of all children without additively overlaying the modulations. + +--- + diff --git a/documentation/classes/class_dialogicautoadvance.md b/documentation/classes/class_dialogicautoadvance.md index b349860..e2e2ac8 100644 --- a/documentation/classes/class_dialogicautoadvance.md +++ b/documentation/classes/class_dialogicautoadvance.md @@ -15,29 +15,29 @@ Auto-Advance is a feature that automatically advances the timeline after a playe ## Properties Name | Type | Default --- | --- | --- -[autoadvance_timer](#property-autoadvance_timer) | [Timer](https://docs.godotengine.org/en/latest/classes/class_timer.html#class-timer) | -[await_playing_voice](#property-await_playing_voice) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `true` -[delay_modifier](#property-delay_modifier) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `1.0` -[enabled_forced](#property-enabled_forced) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` -[enabled_until_next_event](#property-enabled_until_next_event) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` -[enabled_until_user_input](#property-enabled_until_user_input) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` +[autoadvance_timer](#property-autoadvance_timer) | [Timer](https://docs.godotengine.org/en/latest/classes/class_timer.html#class-timer) | `new()` [fixed_delay](#property-fixed_delay) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `1.0` -[ignored_characters](#property-ignored_characters) | [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | +[delay_modifier](#property-delay_modifier) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `1.0` +[per_word_delay](#property-per_word_delay) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `0.0` +[per_character_delay](#property-per_character_delay) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `0.1` [ignored_characters_enabled](#property-ignored_characters_enabled) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` +[ignored_characters](#property-ignored_characters) | [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | `{}` +[await_playing_voice](#property-await_playing_voice) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `true` [override_delay_for_current_event](#property-override_delay_for_current_event) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `-1.0` -[per_character_delay](#property-per_character_delay) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `0.1` -[per_word_delay](#property-per_word_delay) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `0.0` +[enabled_until_next_event](#property-enabled_until_next_event) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` +[enabled_forced](#property-enabled_forced) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` +[enabled_until_user_input](#property-enabled_until_user_input) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` --- ## Methods Returns | Method --- | --- -[float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | [get_progress](#method-get_progress) ( ) -[float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | [get_time](#method-get_time) ( ) -[float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | [get_time_left](#method-get_time_left) ( ) +void | [start](#method-start) ( ) [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_advancing](#method-is_advancing) ( ) +[float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | [get_time_left](#method-get_time_left) ( ) +[float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | [get_time](#method-get_time) ( ) [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_enabled](#method-is_enabled) ( ) -void | [start](#method-start) ( ) +[float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | [get_progress](#method-get_progress) ( ) --- ## Signals @@ -65,7 +65,7 @@ Returns | Method -**var autoadvance_timer = ** +**var autoadvance_timer = new()** @@ -75,7 +75,7 @@ Returns | Method -**var await_playing_voice = true** +**var fixed_delay = 1.0** @@ -95,37 +95,37 @@ Returns | Method -**var enabled_forced = false** +**var per_word_delay = 0.0** -If true, Auto-Advance will stay enabled until this is set to false. This boolean can be used to create an automatic text display. Stacks with `enabled_until_next_event` and `enabled_until_user_input`. + *No description available.* --- -**var enabled_until_next_event = false** +**var per_character_delay = 0.1** -If true, Auto-Advance will be active until the next event. Use this flag to create a temporary Auto-Advance mode. You can utilise `override_delay_for_current_event` to set a temporary Auto-Advance delay for this event. Stacks with `enabled_forced` and `enabled_until_user_input`. + *No description available.* --- -**var enabled_until_user_input = false** +**var ignored_characters_enabled = false** -If true, Auto-Advance will be active until the player presses a button. Use this flag when the player wants to enable Auto-Advance. Stacks with `enabled_forced` and `enabled_until_next_event`. + *No description available.* --- -**var fixed_delay = 1.0** +**var ignored_characters = {}** @@ -135,7 +135,7 @@ If true, Auto-Advance will be active until the player presses a button. Use thi -**var ignored_characters = ** +**var await_playing_voice = true** @@ -145,7 +145,7 @@ If true, Auto-Advance will be active until the player presses a button. Use thi -**var ignored_characters_enabled = false** +**var override_delay_for_current_event = -1.0** @@ -155,31 +155,31 @@ If true, Auto-Advance will be active until the player presses a button. Use thi -**var override_delay_for_current_event = -1.0** +**var enabled_until_next_event = false** - *No description available.* +If true, Auto-Advance will be active until the next event. Use this flag to create a temporary Auto-Advance mode. You can utilise `override_delay_for_current_event` to set a temporary Auto-Advance delay for this event. Stacks with `enabled_forced` and `enabled_until_user_input`. --- -**var per_character_delay = 0.1** +**var enabled_forced = false** - *No description available.* +If true, Auto-Advance will stay enabled until this is set to false. This boolean can be used to create an automatic text display. Stacks with `enabled_until_next_event` and `enabled_until_user_input`. --- -**var per_word_delay = 0.0** +**var enabled_until_user_input = false** - *No description available.* +If true, Auto-Advance will be active until the player presses a button. Use this flag when the player wants to enable Auto-Advance. Stacks with `enabled_forced` and `enabled_until_next_event`. --- @@ -187,17 +187,17 @@ If true, Auto-Advance will be active until the player presses a button. Use thi -**func [get_progress](#method-get_progress) ( ) ⇒ [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float)** +**func [start](#method-start) ( ) ⇒ void** -Returns the progress of the auto-advance timer on a scale between 0 and 1. The higher the value, the closer the timer is to finishing. If auto-advancing is disabled, returns -1. + *No description available.* --- -**func [get_time](#method-get_time) ( ) ⇒ [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float)** +**func [is_advancing](#method-is_advancing) ( ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** @@ -217,7 +217,7 @@ Returns the progress of the auto-advance timer on a scale between 0 and 1. The h -**func [is_advancing](#method-is_advancing) ( ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [get_time](#method-get_time) ( ) ⇒ [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float)** @@ -237,11 +237,11 @@ Returns whether Auto-Advance is currently considered enabled. Auto-Advance uses -**func [start](#method-start) ( ) ⇒ void** +**func [get_progress](#method-get_progress) ( ) ⇒ [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float)** - *No description available.* +Returns the progress of the auto-advance timer on a scale between 0 and 1. The higher the value, the closer the timer is to finishing. If auto-advancing is disabled, returns -1. --- diff --git a/documentation/classes/class_dialogicautoskip.md b/documentation/classes/class_dialogicautoskip.md index 9532fea..772645d 100644 --- a/documentation/classes/class_dialogicautoskip.md +++ b/documentation/classes/class_dialogicautoskip.md @@ -15,10 +15,10 @@ Auto-Skip must be implemented per event. ## Properties Name | Type | Default --- | --- | --- -[disable_on_unread_text](#property-disable_on_unread_text) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `true` -[disable_on_user_input](#property-disable_on_user_input) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `true` -[enable_on_visited](#property-enable_on_visited) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `true` [enabled](#property-enabled) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` +[disable_on_user_input](#property-disable_on_user_input) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `true` +[disable_on_unread_text](#property-disable_on_unread_text) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` +[enable_on_visited](#property-enable_on_visited) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` [skip_voice](#property-skip_voice) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `true` [time_per_event](#property-time_per_event) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `0.1` @@ -37,11 +37,11 @@ Name | Type | Default -**var disable_on_unread_text = true** +**var enabled = false** -If `true`, Auto-Skip will be disabled when the timeline advances to a unread Text event or an event requesting user input. +Whether Auto-Skip is enabled or not. If Auto-Skip is referred to be disabled[/i], it refers to setting this this variable to `false`. This variable will automatically emit [autoskip_changed](#signal-autoskip_changed) when changed. --- @@ -57,21 +57,21 @@ If `true`, Auto-Skip will be disabled when the user presses a recognised input a -**var enable_on_visited = true** +**var disable_on_unread_text = false** -If `true`, Auto-Skip will be enabled when the timeline advances to a previously visited Text event. Useful if the player always wants to skip already-visited Text events. +If `true`, Auto-Skip will be disabled when the timeline advances to a unread Text event or an event requesting user input. --- -**var enabled = false** +**var enable_on_visited = false** -Whether Auto-Skip is enabled or not. If Auto-Skip is referred to be disabled[/i], it refers to setting this this variable to `false`. This variable will automatically emit [autoskip_changed](#signal-autoskip_changed) when changed. +If `true`, Auto-Skip will be enabled when the timeline advances to a previously visited Text event. Useful if the player always wants to skip already-visited Text events. --- diff --git a/documentation/classes/class_dialogicbackground.md b/documentation/classes/class_dialogicbackground.md index 5d7ed79..260a6a7 100644 --- a/documentation/classes/class_dialogicbackground.md +++ b/documentation/classes/class_dialogicbackground.md @@ -12,27 +12,27 @@ This is the base class for dialogic backgrounds. Extend it and override it's met ## Properties Name | Type | Default --- | --- | --- -[viewport](#property-viewport) | [SubViewport](https://docs.godotengine.org/en/latest/classes/class_subviewport.html#class-subviewport) | [viewport_container](#property-viewport_container) | [SubViewportContainer](https://docs.godotengine.org/en/latest/classes/class_subviewportcontainer.html#class-subviewportcontainer) | +[viewport](#property-viewport) | [SubViewport](https://docs.godotengine.org/en/latest/classes/class_subviewport.html#class-subviewport) | ## Property Descriptions -**var viewport** +**var viewport_container** -The viewport that holds this background. Set when instanced. +The subviewport container that holds this background. Set when instanced. --- -**var viewport_container** +**var viewport** -The subviewport container that holds this background. Set when instanced. +The viewport that holds this background. Set when instanced. --- diff --git a/documentation/classes/class_dialogicbackgroundevent.md b/documentation/classes/class_dialogicbackgroundevent.md index 2fde8cc..3c0a119 100644 --- a/documentation/classes/class_dialogicbackgroundevent.md +++ b/documentation/classes/class_dialogicbackgroundevent.md @@ -12,19 +12,19 @@ ## Properties Name | Type | Default --- | --- | --- +[scene](#property-scene) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` [argument](#property-argument) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` [fade](#property-fade) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `0.0` -[scene](#property-scene) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` [transition](#property-transition) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` --- ## Methods Returns | Method --- | --- -void | [build_event_editor](#method-build_event_editor) ( ) [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_shortcode](#method-get_shortcode) ( ) [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) -[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_transition_suggestions](#method-get_transition_suggestions) ( `filter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) +void | [build_event_editor](#method-build_event_editor) ( ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_transition_suggestions](#method-get_transition_suggestions) ( `_filter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) --- ## Constants @@ -67,31 +67,31 @@ Returns | Method -**var argument = ""** +**var scene = ""** -The argument that is passed to the background scene. For the default scene it's the path to the image to show. +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 fade = 0.0** +**var argument = ""** -The time the fade animation will take. Leave at 0 for instant change. +The argument that is passed to the background scene. For the default scene it's the path to the image to show. --- -**var scene = ""** +**var fade = 0.0** -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 time the fade animation will take. Leave at 0 for instant change. --- @@ -109,7 +109,7 @@ Name of the transition to use. -**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** +**func [get_shortcode](#method-get_shortcode) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** @@ -119,7 +119,7 @@ Name of the transition to use. -**func [get_shortcode](#method-get_shortcode) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** @@ -129,7 +129,7 @@ Name of the transition to use. -**func [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** @@ -139,7 +139,7 @@ Name of the transition to use. -**func [get_transition_suggestions](#method-get_transition_suggestions) ( `filter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [get_transition_suggestions](#method-get_transition_suggestions) ( `_filter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** diff --git a/documentation/classes/class_dialogicbackgroundtransition.md b/documentation/classes/class_dialogicbackgroundtransition.md index 9d449d6..de295b0 100644 --- a/documentation/classes/class_dialogicbackgroundtransition.md +++ b/documentation/classes/class_dialogicbackgroundtransition.md @@ -12,20 +12,20 @@ ## Properties Name | Type | Default --- | --- | --- -[bg_holder](#property-bg_holder) | [DialogicNode_BackgroundHolder](class_dialogicnode_backgroundholder.md) | -[next_scene](#property-next_scene) | [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) | -[next_texture](#property-next_texture) | [ViewportTexture](https://docs.godotengine.org/en/latest/classes/class_viewporttexture.html#class-viewporttexture) | +[this_folder](#property-this_folder) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `get_base_dir()` [prev_scene](#property-prev_scene) | [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) | [prev_texture](#property-prev_texture) | [ViewportTexture](https://docs.godotengine.org/en/latest/classes/class_viewporttexture.html#class-viewporttexture) | -[this_folder](#property-this_folder) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | +[next_scene](#property-next_scene) | [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) | +[next_texture](#property-next_texture) | [ViewportTexture](https://docs.godotengine.org/en/latest/classes/class_viewporttexture.html#class-viewporttexture) | [time](#property-time) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | +[bg_holder](#property-bg_holder) | [DialogicNode_BackgroundHolder](class_dialogicnode_backgroundholder.md) | --- ## Methods Returns | Method --- | --- -[ShaderMaterial](https://docs.godotengine.org/en/latest/classes/class_shadermaterial.html#class-shadermaterial) | [set_shader](#method-set_shader) ( `path_to_shader`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `` ) -[PropertyTweener](https://docs.godotengine.org/en/latest/classes/class_propertytweener.html#class-propertytweener) | [tween_shader_progress](#method-tween_shader_progress) ( `progress_parameter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `"progress"` ) +[ShaderMaterial](https://docs.godotengine.org/en/latest/classes/class_shadermaterial.html#class-shadermaterial) | [set_shader](#method-set_shader) ( `path_to_shader`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `path_join(...)` ) +[PropertyTweener](https://docs.godotengine.org/en/latest/classes/class_propertytweener.html#class-propertytweener) | [tween_shader_progress](#method-tween_shader_progress) ( `_progress_parameter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `"progress"` ) --- ## Signals @@ -43,71 +43,71 @@ Returns | Method -**var bg_holder** +**var this_folder = get_base_dir()** -Set before _fade() is called, will be the background holder (TextureRect) +Helper --- -**var next_scene** +**var prev_scene** -Set before _fade() is called, will be the root node of the upcoming bg scene. +Set before _fade() is called, will be the root node of the previous bg scene. --- -**var next_texture** +**var prev_texture** -Set before _fade() is called, will be the viewport texture of the upcoming bg scene. +Set before _fade() is called, will be the viewport texture of the previous bg scene. --- -**var prev_scene** +**var next_scene** -Set before _fade() is called, will be the root node of the previous bg scene. +Set before _fade() is called, will be the root node of the upcoming bg scene. --- -**var prev_texture** +**var next_texture** -Set before _fade() is called, will be the viewport texture of the previous bg scene. +Set before _fade() is called, will be the viewport texture of the upcoming bg scene. --- -**var this_folder = ** +**var time** -Helper +Set before _fade() is called, will be the requested time for the fade --- -**var time** +**var bg_holder** -Set before _fade() is called, will be the requested time for the fade +Set before _fade() is called, will be the background holder (TextureRect) --- @@ -115,7 +115,7 @@ Set before _fade() is called, will be the requested time for the fade -**func [set_shader](#method-set_shader) ( `path_to_shader`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `` ) ⇒ [ShaderMaterial](https://docs.godotengine.org/en/latest/classes/class_shadermaterial.html#class-shadermaterial)** +**func [set_shader](#method-set_shader) ( `path_to_shader`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `path_join(...)` ) ⇒ [ShaderMaterial](https://docs.godotengine.org/en/latest/classes/class_shadermaterial.html#class-shadermaterial)** @@ -125,7 +125,7 @@ Set before _fade() is called, will be the requested time for the fade -**func [tween_shader_progress](#method-tween_shader_progress) ( `progress_parameter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `"progress"` ) ⇒ [PropertyTweener](https://docs.godotengine.org/en/latest/classes/class_propertytweener.html#class-propertytweener)** +**func [tween_shader_progress](#method-tween_shader_progress) ( `_progress_parameter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `"progress"` ) ⇒ [PropertyTweener](https://docs.godotengine.org/en/latest/classes/class_propertytweener.html#class-propertytweener)** diff --git a/documentation/classes/class_dialogiccallevent.md b/documentation/classes/class_dialogiccallevent.md index 4518b23..bfeb8c1 100644 --- a/documentation/classes/class_dialogiccallevent.md +++ b/documentation/classes/class_dialogiccallevent.md @@ -12,53 +12,53 @@ ## Properties Name | Type | Default --- | --- | --- -[arguments](#property-arguments) | [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | [autoload_name](#property-autoload_name) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` [method](#property-method) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` +[arguments](#property-arguments) | [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | `[]` --- ## Methods Returns | Method --- | --- -void | [build_event_editor](#method-build_event_editor) ( ) -void | [check_arguments_and_update_warning](#method-check_arguments_and_update_warning) ( ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [to_text](#method-to_text) ( ) void | [from_text](#method-from_text) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_valid_event](#method-is_valid_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) +void | [build_event_editor](#method-build_event_editor) ( ) [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_autoload_suggestions](#method-get_autoload_suggestions) ( `filter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_method_suggestions](#method-get_method_suggestions) ( `filter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `temp_autoload`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) -[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) -[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_valid_event](#method-is_valid_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [to_text](#method-to_text) ( ) void | [update_argument_info](#method-update_argument_info) ( ) +void | [check_arguments_and_update_warning](#method-check_arguments_and_update_warning) ( ) --- ## Property Descriptions -**var arguments = ** +**var autoload_name = ""** -A list of arguments to give to the call. +The name of the autoload to call the method on. --- -**var autoload_name = ""** +**var method = ""** -The name of the autoload to call the method on. +The name of the method to call on the given autoload. --- -**var method = ""** +**var arguments = []** -The name of the method to call on the given autoload. +A list of arguments to give to the call. --- @@ -66,7 +66,7 @@ The name of the method to call on the given autoload. -**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** +**func [to_text](#method-to_text) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** @@ -76,7 +76,7 @@ The name of the method to call on the given autoload. -**func [check_arguments_and_update_warning](#method-check_arguments_and_update_warning) ( ) ⇒ void** +**func [from_text](#method-from_text) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** @@ -86,7 +86,7 @@ The name of the method to call on the given autoload. -**func [from_text](#method-from_text) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** +**func [is_valid_event](#method-is_valid_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** @@ -96,7 +96,7 @@ The name of the method to call on the given autoload. -**func [get_autoload_suggestions](#method-get_autoload_suggestions) ( `filter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** @@ -106,7 +106,7 @@ The name of the method to call on the given autoload. -**func [get_method_suggestions](#method-get_method_suggestions) ( `filter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `temp_autoload`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** @@ -116,7 +116,7 @@ The name of the method to call on the given autoload. -**func [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [get_autoload_suggestions](#method-get_autoload_suggestions) ( `filter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** @@ -126,7 +126,7 @@ The name of the method to call on the given autoload. -**func [is_valid_event](#method-is_valid_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [get_method_suggestions](#method-get_method_suggestions) ( `filter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `temp_autoload`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** @@ -136,7 +136,7 @@ The name of the method to call on the given autoload. -**func [to_text](#method-to_text) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [update_argument_info](#method-update_argument_info) ( ) ⇒ void** @@ -146,7 +146,7 @@ The name of the method to call on the given autoload. -**func [update_argument_info](#method-update_argument_info) ( ) ⇒ void** +**func [check_arguments_and_update_warning](#method-check_arguments_and_update_warning) ( ) ⇒ void** diff --git a/documentation/classes/class_dialogiccharacter.md b/documentation/classes/class_dialogiccharacter.md index 3b1f471..14f092a 100644 --- a/documentation/classes/class_dialogiccharacter.md +++ b/documentation/classes/class_dialogiccharacter.md @@ -12,29 +12,29 @@ Resource that represents a character in dialog. Manages/contains portraits, cust ## Properties Name | Type | Default --- | --- | --- +[display_name](#property-display_name) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` +[nicknames](#property-nicknames) | [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | `[]` [color](#property-color) | [Color](https://docs.godotengine.org/en/latest/classes/class_color.html#class-color) | `Color(0, 0, 0, 1)` -[custom_info](#property-custom_info) | [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | -[default_portrait](#property-default_portrait) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` [description](#property-description) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` -[display_name](#property-display_name) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` -[mirror](#property-mirror) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` -[nicknames](#property-nicknames) | [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | -[offset](#property-offset) | [Vector2](https://docs.godotengine.org/en/latest/classes/class_vector2.html#class-vector2) | `Vector2(0, 0)` -[portraits](#property-portraits) | [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [scale](#property-scale) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `1.0` +[offset](#property-offset) | [Vector2](https://docs.godotengine.org/en/latest/classes/class_vector2.html#class-vector2) | `Vector2(0, 0)` +[mirror](#property-mirror) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` +[default_portrait](#property-default_portrait) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` +[portraits](#property-portraits) | [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | `{}` +[custom_info](#property-custom_info) | [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | `{}` --- ## Methods Returns | Method --- | --- [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [add_translation_id](#method-add_translation_id) ( ) -[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_character_name](#method-get_character_name) ( ) -[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_display_name_translated](#method-get_display_name_translated) ( ) -[Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | [get_nicknames_translated](#method-get_nicknames_translated) ( ) -[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_portrait_info](#method-get_portrait_info) ( `portrait_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_property_translation_key](#method-get_property_translation_key) ( `property`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_set_translation_id](#method-get_set_translation_id) ( ) void | [remove_translation_id](#method-remove_translation_id) ( ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_property_translation_key](#method-get_property_translation_key) ( `property`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) +[Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | [get_nicknames_translated](#method-get_nicknames_translated) ( ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_display_name_translated](#method-get_display_name_translated) ( ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_character_name](#method-get_character_name) ( ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_portrait_info](#method-get_portrait_info) ( `portrait_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) --- ## Constants @@ -59,7 +59,7 @@ Returns | Method -**var color = Color(0, 0, 0, 1)** +**var display_name = ""** @@ -69,7 +69,7 @@ Returns | Method -**var custom_info = ** +**var nicknames = []** @@ -79,7 +79,7 @@ Returns | Method -**var default_portrait = ""** +**var color = Color(0, 0, 0, 1)** @@ -99,7 +99,7 @@ Returns | Method -**var display_name = ""** +**var scale = 1.0** @@ -109,7 +109,7 @@ Returns | Method -**var mirror = false** +**var offset = Vector2(0, 0)** @@ -119,7 +119,7 @@ Returns | Method -**var nicknames = ** +**var mirror = false** @@ -129,7 +129,7 @@ Returns | Method -**var offset = Vector2(0, 0)** +**var default_portrait = ""** @@ -139,7 +139,7 @@ Returns | Method -**var portraits = ** +**var portraits = {}** @@ -149,7 +149,7 @@ Returns | Method -**var scale = 1.0** +**var custom_info = {}** @@ -171,71 +171,71 @@ Adds a translation ID to the character. -**func [get_character_name](#method-get_character_name) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [get_set_translation_id](#method-get_set_translation_id) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** -Returns the name of the file (without the extension). +Returns the character's translation ID. Adds a translation ID to the character if it doesn't have one. --- -**func [get_display_name_translated](#method-get_display_name_translated) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [remove_translation_id](#method-remove_translation_id) ( ) ⇒ void** -Translates and returns the display name of the character. +Removes the translation ID from the character. --- -**func [get_nicknames_translated](#method-get_nicknames_translated) ( ) ⇒ [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array)** +**func [get_property_translation_key](#method-get_property_translation_key) ( `property`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** -Translates the nicknames of the characters and then returns them as an array of strings. +Checks `property` and matches it to a translation key. Undefined behaviour if an invalid integer is passed. --- -**func [get_portrait_info](#method-get_portrait_info) ( `portrait_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [get_nicknames_translated](#method-get_nicknames_translated) ( ) ⇒ [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array)** -Returns the info of the given portrait. Uses the default portrait if the given portrait doesn't exist. +Translates the nicknames of the characters and then returns them as an array of strings. --- -**func [get_property_translation_key](#method-get_property_translation_key) ( `property`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [get_display_name_translated](#method-get_display_name_translated) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** -Checks `property` and matches it to a translation key. Undefined behaviour if an invalid integer is passed. +Translates and returns the display name of the character. --- -**func [get_set_translation_id](#method-get_set_translation_id) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [get_character_name](#method-get_character_name) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** -Returns the character's translation ID. Adds a translation ID to the character if it doesn't have one. +Returns the best name for this character. --- -**func [remove_translation_id](#method-remove_translation_id) ( ) ⇒ void** +**func [get_portrait_info](#method-get_portrait_info) ( `portrait_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** -Removes the translation ID from the character. +Returns the info of the given portrait. Uses the default portrait if the given portrait doesn't exist. --- diff --git a/documentation/classes/class_dialogiccharactereditorportraitsection.md b/documentation/classes/class_dialogiccharactereditorportraitsection.md index 3142ebf..2d711ff 100644 --- a/documentation/classes/class_dialogiccharactereditorportraitsection.md +++ b/documentation/classes/class_dialogiccharactereditorportraitsection.md @@ -13,8 +13,8 @@ Base class for all portrait settings sections. Methods should be overriden. Chan Name | Type | Default --- | --- | --- [character_editor](#property-character_editor) | [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control) | -[hint_text](#property-hint_text) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` [selected_item](#property-selected_item) | [TreeItem](https://docs.godotengine.org/en/latest/classes/class_treeitem.html#class-treeitem) | `null` +[hint_text](#property-hint_text) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` ## Signals @@ -51,21 +51,21 @@ Reference to the character editor, set when instantiated -**var hint_text = ""** +**var selected_item = null** -If not empty a hint icon is added to the section title +Reference to the selected portrait item. `selected_item.get_metadata(0)` can access the portraits data --- -**var selected_item = null** +**var hint_text = ""** -Reference to the selected portrait item. `selected_item.get_metadata(0)` can access the portraits data +If not empty a hint icon is added to the section title --- diff --git a/documentation/classes/class_dialogiccharacterevent.md b/documentation/classes/class_dialogiccharacterevent.md index 750d4d1..14e3ed8 100644 --- a/documentation/classes/class_dialogiccharacterevent.md +++ b/documentation/classes/class_dialogiccharacterevent.md @@ -13,39 +13,51 @@ Name | Type | Default --- | --- | --- [action](#property-action) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `0` -[animation_length](#property-animation_length) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `0.5` +[character](#property-character) | [DialogicCharacter](class_dialogiccharacter.md) | `null` +[portrait](#property-portrait) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` +[transform](#property-transform) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `"center"` [animation_name](#property-animation_name) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` +[animation_length](#property-animation_length) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `0.5` [animation_repeats](#property-animation_repeats) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `1` [animation_wait](#property-animation_wait) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` -[character](#property-character) | [DialogicCharacter](class_dialogiccharacter.md) | `null` -[character_identifier](#property-character_identifier) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | -[extra_data](#property-extra_data) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` +[fade_animation](#property-fade_animation) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` +[fade_length](#property-fade_length) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `0.5` +[transform_time](#property-transform_time) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `0.0` +[transform_ease](#property-transform_ease) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `2` +[transform_trans](#property-transform_trans) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `1` +[ease_options](#property-ease_options) | [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | `[...]` +[trans_options](#property-trans_options) | [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | `[...]` +[z_index](#property-z_index) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `0` [mirrored](#property-mirrored) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` -[portrait](#property-portrait) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` -[position](#property-position) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `1` -[position_move_time](#property-position_move_time) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `0.0` -[regex](#property-regex) | [RegEx](https://docs.godotengine.org/en/latest/classes/class_regex.html#class-regex) | -[set_mirrored](#property-set_mirrored) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` +[extra_data](#property-extra_data) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` [set_portrait](#property-set_portrait) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` -[set_position](#property-set_position) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` +[set_transform](#property-set_transform) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` [set_z_index](#property-set_z_index) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` -[z_index](#property-z_index) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `0` +[set_mirrored](#property-set_mirrored) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` +[character_identifier](#property-character_identifier) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | +[regex](#property-regex) | [RegEx](https://docs.godotengine.org/en/latest/classes/class_regex.html#class-regex) | `create_from_string(...)` --- ## Methods Returns | Method --- | --- -void | [build_event_editor](#method-build_event_editor) ( ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [to_text](#method-to_text) ( ) void | [from_text](#method-from_text) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_animation_suggestions](#method-get_animation_suggestions) ( `search_text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_character_suggestions](#method-get_character_suggestions) ( `search_text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_portrait_suggestions](#method-get_portrait_suggestions) ( `search_text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) -[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [has_no_portraits](#method-has_no_portraits) ( ) [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_valid_event](#method-is_valid_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +void | [build_event_editor](#method-build_event_editor) ( ) +[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [should_show_transform_options](#method-should_show_transform_options) ( ) [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [should_show_animation_options](#method-should_show_animation_options) ( ) +[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [should_show_fade_options](#method-should_show_fade_options) ( ) [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [should_show_portrait_selector](#method-should_show_portrait_selector) ( ) -[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [to_text](#method-to_text) ( ) +[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [has_no_portraits](#method-has_no_portraits) ( ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_character_suggestions](#method-get_character_suggestions) ( `search_text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_portrait_suggestions](#method-get_portrait_suggestions) ( `search_text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_position_suggestions](#method-get_position_suggestions) ( `search_text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_animation_suggestions](#method-get_animation_suggestions) ( `search_text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_fade_suggestions](#method-get_fade_suggestions) ( `search_text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) +void | [suggest_parameter](#method-suggest_parameter) ( `parameter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `line`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `TextNode`: [TextEdit](https://docs.godotengine.org/en/latest/classes/class_textedit.html#class-textedit) ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [list_to_suggestions](#method-list_to_suggestions) ( `list`: [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) ) --- ## Constants @@ -89,11 +101,31 @@ The type of action of this event (JOIN/LEAVE/UPDATE). See . -**var animation_length = 0.5** +**var character = null** -Length of the animation. +The character that will join/leave/update. + +--- + + + +**var portrait = ""** + + + +For Join/Update, this will be the portrait of the character that is shown. Not used on Leave. If empty, the default portrait will be used. + +--- + + + +**var transform = "center"** + + + +The index of the position this character should move to --- @@ -109,6 +141,16 @@ Name of the animation script (extending DialogicAnimation). On Join/Leave empty +**var animation_length = 0.5** + + + +Length of the animation. + +--- + + + **var animation_repeats = 1** @@ -129,91 +171,101 @@ If true, the events waits for the animation to finish before the next event star -**var character = null** +**var fade_animation = ""** -The character that will join/leave/update. +The fade animation to use. If left empty, the default cross-fade animation AND time will be used. --- -**var character_identifier** +**var fade_length = 0.5** -Used to set the character resource from the unique name identifier and vice versa + *No description available.* --- -**var extra_data = ""** +**var transform_time = 0.0** -If set, will be passed to the portrait scene. +For Update only. If bigger then 0, the portrait will tween to the new position (if changed) in this time (in seconds). --- -**var mirrored = false** +**var transform_ease = 2** -If true, the portrait will be set to mirrored. + *No description available.* --- -**var portrait = ""** +**var transform_trans = 1** -For Join/Update, this will be the portrait of the character that is shown. Not used on Leave. If empty, the default portrait will be used. + *No description available.* --- -**var position = 1** +**var ease_options = [...]** -The index of the position this character should move to + *No description available.* --- -**var position_move_time = 0.0** +**var trans_options = [...]** -For Update only. If bigger then 0, the portrait will tween to the new position (if changed) in this time (in seconds). + *No description available.* --- -**var regex = ** +**var z_index = 0** - *No description available.* +The z_index that the portrait should have. --- -**var set_mirrored = false** +**var mirrored = false** - *No description available.* +If true, the portrait will be set to mirrored. + +--- + + + +**var extra_data = ""** + + + +If set, will be passed to the portrait scene. --- @@ -229,7 +281,7 @@ Indicators for whether something should be updated (UPDATE mode only) -**var set_position = false** +**var set_transform = false** @@ -249,11 +301,31 @@ Indicators for whether something should be updated (UPDATE mode only) -**var z_index = 0** +**var set_mirrored = false** -The z_index that the portrait should have. + *No description available.* + +--- + + + +**var character_identifier** + + + +Used to set the character resource from the unique name identifier and vice versa + +--- + + + +**var regex = create_from_string(...)** + + + + *No description available.* --- @@ -261,7 +333,7 @@ The z_index that the portrait should have. -**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** +**func [to_text](#method-to_text) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** @@ -281,7 +353,7 @@ The z_index that the portrait should have. -**func [get_animation_suggestions](#method-get_animation_suggestions) ( `search_text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** @@ -291,7 +363,7 @@ The z_index that the portrait should have. -**func [get_character_suggestions](#method-get_character_suggestions) ( `search_text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [is_valid_event](#method-is_valid_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** @@ -301,7 +373,7 @@ The z_index that the portrait should have. -**func [get_portrait_suggestions](#method-get_portrait_suggestions) ( `search_text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** @@ -311,11 +383,41 @@ The z_index that the portrait should have. -**func [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [should_show_transform_options](#method-should_show_transform_options) ( ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** + + + + *No description available.* + +--- + + + +**func [should_show_animation_options](#method-should_show_animation_options) ( ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** + + + + *No description available.* + +--- -this is only here to provide a list of default values this way the module manager can add custom default overrides to this event. this is also why some properties are commented out, because it's not recommended to overwrite them this way +**func [should_show_fade_options](#method-should_show_fade_options) ( ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** + + + + *No description available.* + +--- + + + +**func [should_show_portrait_selector](#method-should_show_portrait_selector) ( ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** + + + + *No description available.* --- @@ -331,7 +433,7 @@ this is only here to provide a list of default values this way the module manage -**func [is_valid_event](#method-is_valid_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [get_character_suggestions](#method-get_character_suggestions) ( `search_text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** @@ -341,7 +443,7 @@ this is only here to provide a list of default values this way the module manage -**func [should_show_animation_options](#method-should_show_animation_options) ( ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [get_portrait_suggestions](#method-get_portrait_suggestions) ( `search_text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** @@ -351,7 +453,7 @@ this is only here to provide a list of default values this way the module manage -**func [should_show_portrait_selector](#method-should_show_portrait_selector) ( ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [get_position_suggestions](#method-get_position_suggestions) ( `search_text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** @@ -361,7 +463,17 @@ this is only here to provide a list of default values this way the module manage -**func [to_text](#method-to_text) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [get_animation_suggestions](#method-get_animation_suggestions) ( `search_text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** + + + + *No description available.* + +--- + + + +**func [get_fade_suggestions](#method-get_fade_suggestions) ( `search_text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** @@ -369,3 +481,23 @@ this is only here to provide a list of default values this way the module manage --- + + +**func [suggest_parameter](#method-suggest_parameter) ( `parameter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `line`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `TextNode`: [TextEdit](https://docs.godotengine.org/en/latest/classes/class_textedit.html#class-textedit) ) ⇒ void** + + + + *No description available.* + +--- + + + +**func [list_to_suggestions](#method-list_to_suggestions) ( `list`: [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** + + + +HELPER + +--- + diff --git a/documentation/classes/class_dialogicchoiceevent.md b/documentation/classes/class_dialogicchoiceevent.md index 86d5d86..9dd62a2 100644 --- a/documentation/classes/class_dialogicchoiceevent.md +++ b/documentation/classes/class_dialogicchoiceevent.md @@ -12,21 +12,24 @@ Event that allows adding choices. Needs to go after a text event (or another cho ## Properties Name | Type | Default --- | --- | --- +[text](#property-text) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` [condition](#property-condition) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` -[disabled_text](#property-disabled_text) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` [else_action](#property-else_action) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `2` -[text](#property-text) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` +[disabled_text](#property-disabled_text) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` +[extra_data](#property-extra_data) | [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | `{}` +[regex](#property-regex) | [RegEx](https://docs.godotengine.org/en/latest/classes/class_regex.html#class-regex) | `create_from_string(...)` --- ## Methods Returns | Method --- | --- -[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [allow_alt_text](#method-allow_alt_text) ( ) -void | [build_event_editor](#method-build_event_editor) ( ) -void | [from_text](#method-from_text) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control) | [get_end_branch_control](#method-get_end_branch_control) ( ) -[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_valid_event](#method-is_valid_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [to_text](#method-to_text) ( ) +void | [from_text](#method-from_text) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) +[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_valid_event](#method-is_valid_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +void | [build_event_editor](#method-build_event_editor) ( ) +[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [allow_alt_text](#method-allow_alt_text) ( ) --- ## Constants @@ -60,6 +63,16 @@ Returns | Method +**var text = ""** + + + +# Settings The text that is displayed on the choice button. + +--- + + + **var condition = ""** @@ -70,6 +83,16 @@ If not empty this condition will determine if this choice is active. +**var else_action = 2** + + + +Determines what happens if is false. Default will use the action set in the settings. + +--- + + + **var disabled_text = ""** @@ -80,21 +103,21 @@ The text that is displayed if is false and is Disable. If empty will be used -**var else_action = 2** +**var extra_data = {}** -Determines what happens if is false. Default will use the action set in the settings. +A dictionary that can be filled with arbitrary information This can then be interpreted by a custom choice layer --- -**var text = ""** +**var regex = create_from_string(...)** -# Settings The text that is displayed on the choice button. + *No description available.* --- @@ -102,7 +125,7 @@ Determines what happens if is false. Default will use the action set in the se -**func [allow_alt_text](#method-allow_alt_text) ( ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [get_end_branch_control](#method-get_end_branch_control) ( ) ⇒ [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control)** @@ -112,7 +135,7 @@ Determines what happens if is false. Default will use the action set in the se -**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** +**func [to_text](#method-to_text) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** @@ -132,7 +155,7 @@ Determines what happens if is false. Default will use the action set in the se -**func [get_end_branch_control](#method-get_end_branch_control) ( ) ⇒ [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control)** +**func [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** @@ -152,7 +175,17 @@ Determines what happens if is false. Default will use the action set in the se -**func [to_text](#method-to_text) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** + + + + *No description available.* + +--- + + + +**func [allow_alt_text](#method-allow_alt_text) ( ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** diff --git a/documentation/classes/class_dialogiclearevent.md b/documentation/classes/class_dialogicclearevent.md similarity index 98% rename from documentation/classes/class_dialogiclearevent.md rename to documentation/classes/class_dialogicclearevent.md index c76c11d..f2b234e 100644 --- a/documentation/classes/class_dialogiclearevent.md +++ b/documentation/classes/class_dialogicclearevent.md @@ -1,39 +1,39 @@
-
DialogiClearEvent
+
DialogicClearEvent
-*This contains the source code documentation of the class `DialogiClearEvent`.* +*This contains the source code documentation of the class `DialogicClearEvent`.* -# DialogiClearEvent +# DialogicClearEvent **Inherits:** [DialogicEvent](class_dialogicevent.md) ############################################################################## EDITOR REPRESENTATION ############################################################################## ## Properties Name | Type | Default --- | --- | --- -[clear_background](#property-clear_background) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `true` -[clear_music](#property-clear_music) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `true` -[clear_portrait_positions](#property-clear_portrait_positions) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `true` +[time](#property-time) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `1.0` +[step_by_step](#property-step_by_step) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `true` +[clear_textbox](#property-clear_textbox) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `true` [clear_portraits](#property-clear_portraits) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `true` [clear_style](#property-clear_style) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `true` -[clear_textbox](#property-clear_textbox) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `true` -[step_by_step](#property-step_by_step) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `true` -[time](#property-time) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `1.0` +[clear_music](#property-clear_music) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `true` +[clear_portrait_positions](#property-clear_portrait_positions) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `true` +[clear_background](#property-clear_background) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `true` --- ## Methods Returns | Method --- | --- -void | [build_event_editor](#method-build_event_editor) ( ) [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_shortcode](#method-get_shortcode) ( ) [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) +void | [build_event_editor](#method-build_event_editor) ( ) --- ## Property Descriptions -**var clear_background = true** +**var time = 1.0** @@ -43,7 +43,7 @@ Returns | Method -**var clear_music = true** +**var step_by_step = true** @@ -53,7 +53,7 @@ Returns | Method -**var clear_portrait_positions = true** +**var clear_textbox = true** @@ -83,7 +83,7 @@ Returns | Method -**var clear_textbox = true** +**var clear_music = true** @@ -93,7 +93,7 @@ Returns | Method -**var step_by_step = true** +**var clear_portrait_positions = true** @@ -103,7 +103,7 @@ Returns | Method -**var time = 1.0** +**var clear_background = true** @@ -115,7 +115,7 @@ Returns | Method -**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** +**func [get_shortcode](#method-get_shortcode) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** @@ -125,7 +125,7 @@ Returns | Method -**func [get_shortcode](#method-get_shortcode) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** @@ -135,7 +135,7 @@ Returns | Method -**func [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** diff --git a/documentation/classes/class_dialogiccommentevent.md b/documentation/classes/class_dialogiccommentevent.md index 63ff469..f419c7b 100644 --- a/documentation/classes/class_dialogiccommentevent.md +++ b/documentation/classes/class_dialogiccommentevent.md @@ -18,10 +18,10 @@ Name | Type | Default ## Methods Returns | Method --- | --- -void | [build_event_editor](#method-build_event_editor) ( ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [to_text](#method-to_text) ( ) void | [from_text](#method-from_text) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_valid_event](#method-is_valid_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [to_text](#method-to_text) ( ) +void | [build_event_editor](#method-build_event_editor) ( ) --- ## Property Descriptions @@ -39,7 +39,7 @@ Content of the comment. -**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** +**func [to_text](#method-to_text) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** @@ -69,7 +69,7 @@ Content of the comment. -**func [to_text](#method-to_text) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** diff --git a/documentation/classes/class_dialogicconditionevent.md b/documentation/classes/class_dialogicconditionevent.md index ffa3d96..3f0e41f 100644 --- a/documentation/classes/class_dialogicconditionevent.md +++ b/documentation/classes/class_dialogicconditionevent.md @@ -12,19 +12,19 @@ Event that allows branching a timeline based on a condition. ## Properties Name | Type | Default --- | --- | --- -[condition](#property-condition) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` [condition_type](#property-condition_type) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `0` +[condition](#property-condition) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` --- ## Methods Returns | Method --- | --- -void | [build_event_editor](#method-build_event_editor) ( ) -void | [from_text](#method-from_text) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control) | [get_end_branch_control](#method-get_end_branch_control) ( ) -[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_valid_event](#method-is_valid_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [should_execute_this_branch](#method-should_execute_this_branch) ( ) +[Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control) | [get_end_branch_control](#method-get_end_branch_control) ( ) [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [to_text](#method-to_text) ( ) +void | [from_text](#method-from_text) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_valid_event](#method-is_valid_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +void | [build_event_editor](#method-build_event_editor) ( ) --- ## Constants @@ -58,21 +58,21 @@ Returns | Method -**var condition = ""** +**var condition_type = 0** -The condition as a string. Will be executed as an Expression. +# Settings condition type (see ). Defaults to if. --- -**var condition_type = 0** +**var condition = ""** -# Settings condition type (see ). Defaults to if. +The condition as a string. Will be executed as an Expression. --- @@ -80,17 +80,17 @@ The condition as a string. Will be executed as an Expression. -**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** +**func [should_execute_this_branch](#method-should_execute_this_branch) ( ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** - *No description available.* +only called if the previous event was an end-branch event return true if this event should be executed if the previous event was an end-branch event --- -**func [from_text](#method-from_text) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** +**func [get_end_branch_control](#method-get_end_branch_control) ( ) ⇒ [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control)** @@ -100,7 +100,7 @@ The condition as a string. Will be executed as an Expression. -**func [get_end_branch_control](#method-get_end_branch_control) ( ) ⇒ [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control)** +**func [to_text](#method-to_text) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** @@ -110,7 +110,7 @@ The condition as a string. Will be executed as an Expression. -**func [is_valid_event](#method-is_valid_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [from_text](#method-from_text) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** @@ -120,17 +120,17 @@ The condition as a string. Will be executed as an Expression. -**func [should_execute_this_branch](#method-should_execute_this_branch) ( ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [is_valid_event](#method-is_valid_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** -only called if the previous event was an end-branch event return true if this event should be executed if the previous event was an end-branch event + *No description available.* --- -**func [to_text](#method-to_text) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** diff --git a/documentation/classes/class_dialogiccsvfile.md b/documentation/classes/class_dialogiccsvfile.md index 91ad17c..4ecac6e 100644 --- a/documentation/classes/class_dialogiccsvfile.md +++ b/documentation/classes/class_dialogiccsvfile.md @@ -12,22 +12,22 @@ Handles translation of a [DialogicTimeline](class_dialogictimeline.md) to a CSV ## Properties Name | Type | Default --- | --- | --- -[add_separator](#property-add_separator) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` +[lines](#property-lines) | [PackedStringArray[]](https://docs.godotengine.org/en/latest/classes/class_packedstringarray.html#class-packedstringarray) | `[]` +[old_lines](#property-old_lines) | [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | `{}` [column_count](#property-column_count) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `0` -[file](#property-file) | [FileAccess](https://docs.godotengine.org/en/latest/classes/class_fileaccess.html#class-fileaccess) | [is_new_file](#property-is_new_file) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` -[lines](#property-lines) | [PackedStringArray[]](https://docs.godotengine.org/en/latest/classes/class_packedstringarray.html#class-packedstringarray) | -[new_rows](#property-new_rows) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `0` -[old_lines](#property-old_lines) | [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | -[updated_rows](#property-updated_rows) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `0` +[file](#property-file) | [FileAccess](https://docs.godotengine.org/en/latest/classes/class_fileaccess.html#class-fileaccess) | [used_file_path](#property-used_file_path) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | +[updated_rows](#property-updated_rows) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `0` +[new_rows](#property-new_rows) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `0` +[add_separator](#property-add_separator) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` --- ## Methods Returns | Method --- | --- -void | [add_translation_keys_to_glossary](#method-add_translation_keys_to_glossary) ( `glossary`: [DialogicGlossary](class_dialogicglossary.md) ) void | [collect_lines_from_characters](#method-collect_lines_from_characters) ( `characters`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) ) +void | [add_translation_keys_to_glossary](#method-add_translation_keys_to_glossary) ( `glossary`: [DialogicGlossary](class_dialogicglossary.md) ) void | [collect_lines_from_glossary](#method-collect_lines_from_glossary) ( `glossary`: [DialogicGlossary](class_dialogicglossary.md) ) void | [collect_lines_from_timeline](#method-collect_lines_from_timeline) ( `timeline`: [DialogicTimeline](class_dialogictimeline.md) ) void | [update_csv_file_on_disk](#method-update_csv_file_on_disk) ( ) @@ -73,31 +73,31 @@ Returns | Method -**var add_separator = false** +**var lines = []** -Whether this CSV handler should add newlines as a separator between sections. A section may be a new character, new timeline, or new glossary item inside a per-project file. + *No description available.* --- -**var column_count = 0** +**var old_lines = {}** -The amount of columns the CSV file has after loading it. Used to add trailing commas to new lines. +Dictionary of lines from the original file. Key: String, Value: PackedStringArray --- -**var file** +**var column_count = 0** -The underlying file used to read and write the CSV file. +The amount of columns the CSV file has after loading it. Used to add trailing commas to new lines. --- @@ -113,51 +113,51 @@ Whether this CSV file was able to be loaded a defined file path. -**var lines = ** +**var file** - *No description available.* +The underlying file used to read and write the CSV file. --- -**var new_rows = 0** +**var used_file_path** -The amount of events that were added to the CSV file. +File path used to load the CSV file. --- -**var old_lines = ** +**var updated_rows = 0** -Dictionary of lines from the original file. Key: String, Value: PackedStringArray +The amount of events that were updated in the CSV file. --- -**var updated_rows = 0** +**var new_rows = 0** -The amount of events that were updated in the CSV file. +The amount of events that were added to the CSV file. --- -**var used_file_path** +**var add_separator = false** -File path used to load the CSV file. +Whether this CSV handler should add newlines as a separator between sections. A section may be a new character, new timeline, or new glossary item inside a per-project file. --- @@ -165,21 +165,21 @@ File path used to load the CSV file. -**func [add_translation_keys_to_glossary](#method-add_translation_keys_to_glossary) ( `glossary`: [DialogicGlossary](class_dialogicglossary.md) ) ⇒ void** +**func [collect_lines_from_characters](#method-collect_lines_from_characters) ( `characters`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) ) ⇒ void** -Reads all `lines` and adds them to the given `glossary`'s internal collection of words-to-translation-key mappings. Populate the CSV's lines with the method [collect_lines_from_glossary](#property-collect_lines_from_glossary) before. +Collects names from the given `characters` and adds them to the `lines`. If this is the character name CSV file, use this method to take previously collected characters from other [DialogicCsvFile](class_dialogiccsvfile.md)s. --- -**func [collect_lines_from_characters](#method-collect_lines_from_characters) ( `characters`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) ) ⇒ void** +**func [add_translation_keys_to_glossary](#method-add_translation_keys_to_glossary) ( `glossary`: [DialogicGlossary](class_dialogicglossary.md) ) ⇒ void** -Collects names from the given `characters` and adds them to the `lines`. If this is the character name CSV file, use this method to take previously collected characters from other [DialogicCsvFile](class_dialogiccsvfile.md)s. +Reads all `lines` and adds them to the given `glossary`'s internal collection of words-to-translation-key mappings. Populate the CSV's lines with the method [collect_lines_from_glossary](#property-collect_lines_from_glossary) before. --- diff --git a/documentation/classes/class_dialogiceditor.md b/documentation/classes/class_dialogiceditor.md index a9a5042..f8cc24f 100644 --- a/documentation/classes/class_dialogiceditor.md +++ b/documentation/classes/class_dialogiceditor.md @@ -12,10 +12,10 @@ Base class for all dialogic editors. ## Properties Name | Type | Default --- | --- | --- -[alternative_text](#property-alternative_text) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` [current_resource](#property-current_resource) | [Resource](https://docs.godotengine.org/en/latest/classes/class_resource.html#class-resource) | [current_resource_state](#property-current_resource_state) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | [editors_manager](#property-editors_manager) | [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control) | +[alternative_text](#property-alternative_text) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` ## Constants @@ -39,7 +39,7 @@ Name | Type | Default ## Signals -**signal [opened](#signal-opened) ( )** +**signal [resource_saved](#signal-resource_saved) ( )** @@ -49,7 +49,7 @@ Name | Type | Default -**signal [resource_saved](#signal-resource_saved) ( )** +**signal [resource_unsaved](#signal-resource_unsaved) ( )** @@ -59,7 +59,7 @@ Name | Type | Default -**signal [resource_unsaved](#signal-resource_unsaved) ( )** +**signal [opened](#signal-opened) ( )** @@ -71,7 +71,7 @@ Name | Type | Default -**var alternative_text = ""** +**var current_resource** @@ -81,7 +81,7 @@ Name | Type | Default -**var current_resource** +**var current_resource_state** @@ -91,7 +91,7 @@ Name | Type | Default -**var current_resource_state** +**var editors_manager** @@ -101,7 +101,7 @@ Name | Type | Default -**var editors_manager** +**var alternative_text = ""** diff --git a/documentation/classes/class_dialogicendbranchevent.md b/documentation/classes/class_dialogicendbranchevent.md index bb4cb63..47aa598 100644 --- a/documentation/classes/class_dialogicendbranchevent.md +++ b/documentation/classes/class_dialogicendbranchevent.md @@ -15,10 +15,10 @@ Returns | Method --- | --- [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | [find_next_index](#method-find_next_index) ( ) -[int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | [find_opening_index](#method-find_opening_index) ( ) -void | [from_text](#method-from_text) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_valid_event](#method-is_valid_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | [find_opening_index](#method-find_opening_index) ( `at_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [to_text](#method-to_text) ( ) +void | [from_text](#method-from_text) ( `_string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_valid_event](#method-is_valid_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) --- ## Method Descriptions @@ -34,7 +34,7 @@ Returns | Method -**func [find_opening_index](#method-find_opening_index) ( ) ⇒ [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int)** +**func [find_opening_index](#method-find_opening_index) ( `at_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) ⇒ [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int)** @@ -44,17 +44,17 @@ Returns | Method -**func [from_text](#method-from_text) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** +**func [to_text](#method-to_text) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** - *No description available.* +NOTE: This event is very special. It is rarely stored at all, as it is usually just a placeholder for removing an indentation level. When copying events however, some representation of this is necessary. That's why this is half-implemented. --- -**func [is_valid_event](#method-is_valid_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [from_text](#method-from_text) ( `_string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** @@ -64,11 +64,11 @@ Returns | Method -**func [to_text](#method-to_text) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [is_valid_event](#method-is_valid_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** -NOTE: This event is very special. It is rarely stored at all, as it is usually just a placeholder for removing an indentation level. When copying events however, some representation of this is necessary. That's why this is half-implemented. + *No description available.* --- diff --git a/documentation/classes/class_dialogicendtimelineevent.md b/documentation/classes/class_dialogicendtimelineevent.md index fe4a13b..946086e 100644 --- a/documentation/classes/class_dialogicendtimelineevent.md +++ b/documentation/classes/class_dialogicendtimelineevent.md @@ -14,14 +14,14 @@ ## Methods Returns | Method --- | --- -void | [build_event_editor](#method-build_event_editor) ( ) [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_shortcode](#method-get_shortcode) ( ) +void | [build_event_editor](#method-build_event_editor) ( ) --- ## Method Descriptions -**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** +**func [get_shortcode](#method-get_shortcode) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** @@ -31,7 +31,7 @@ Returns | Method -**func [get_shortcode](#method-get_shortcode) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** diff --git a/documentation/classes/class_dialogicevent.md b/documentation/classes/class_dialogicevent.md index f8994a9..5123094 100644 --- a/documentation/classes/class_dialogicevent.md +++ b/documentation/classes/class_dialogicevent.md @@ -12,54 +12,59 @@ Base event class for all dialogic events. Implements basic properties, translati ## Properties Name | Type | Default --- | --- | --- -[can_contain_events](#property-can_contain_events) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` -[created_by_button](#property-created_by_button) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` +[event_name](#property-event_name) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `"Event"` [dialogic](#property-dialogic) | [DialogicGameHandler](class_dialogicgamehandler.md) | `null` -[dialogic_color_name](#property-dialogic_color_name) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` -[disable_editor_button](#property-disable_editor_button) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` -[editor_list](#property-editor_list) | [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | -[empty_lines_above](#property-empty_lines_above) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `0` +[needs_indentation](#property-needs_indentation) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` +[can_contain_events](#property-can_contain_events) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` [end_branch_event](#property-end_branch_event) | [DialogicEndBranchEvent](class_dialogicendbranchevent.md) | `null` -[event_category](#property-event_category) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `"Other"` -[event_color](#property-event_color) | [Color](https://docs.godotengine.org/en/latest/classes/class_color.html#class-color) | `Color(0.984314, 0.694118, 0.235294, 1)` -[event_name](#property-event_name) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `"Event"` +[wants_to_group](#property-wants_to_group) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` [event_node_as_text](#property-event_node_as_text) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` [event_node_ready](#property-event_node_ready) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` +[empty_lines_above](#property-empty_lines_above) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `0` +[event_color](#property-event_color) | [Color](https://docs.godotengine.org/en/latest/classes/class_color.html#class-color) | `Color(0.984314, 0.694118, 0.235294, 1)` +[dialogic_color_name](#property-dialogic_color_name) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` [event_sorting_index](#property-event_sorting_index) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `0` +[disable_editor_button](#property-disable_editor_button) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` [expand_by_default](#property-expand_by_default) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` [help_page_path](#property-help_page_path) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` -[needs_indentation](#property-needs_indentation) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` -[wants_to_group](#property-wants_to_group) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` +[created_by_button](#property-created_by_button) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` +[editor_node](#property-editor_node) | [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control) | `null` +[event_category](#property-event_category) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `"Other"` +[editor_list](#property-editor_list) | [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | `[]` +[this_folder](#property-this_folder) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `get_base_dir()` --- ## Methods Returns | Method --- | --- -void | [add_body_edit](#method-add_body_edit) ( `variable`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `editor_type`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `16`, `extra_info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) = ``, `condition`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) -void | [add_body_line_break](#method-add_body_line_break) ( `condition`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) -void | [add_header_button](#method-add_header_button) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `callable`: [Callable](https://docs.godotengine.org/en/latest/classes/class_callable.html#class-callable), `tooltip`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `icon`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) = `null`, `condition`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) -void | [add_header_edit](#method-add_header_edit) ( `variable`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `editor_type`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `16`, `extra_info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) = ``, `condition`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) -void | [add_header_label](#method-add_header_label) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `condition`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) -[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [add_translation_id](#method-add_translation_id) ( ) -void | [build_event_editor](#method-build_event_editor) ( ) -[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [can_be_translated](#method-can_be_translated) ( ) void | [execute](#method-execute) ( `_dialogic_game_handler`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) void | [finish](#method-finish) ( ) -void | [from_text](#method-from_text) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control) | [get_end_branch_control](#method-get_end_branch_control) ( ) -[Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | [get_event_editor_info](#method-get_event_editor_info) ( ) -[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_property_translated](#method-get_property_translated) ( `property_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [should_execute_this_branch](#method-should_execute_this_branch) ( ) +[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [can_be_translated](#method-can_be_translated) ( ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [add_translation_id](#method-add_translation_id) ( ) +void | [remove_translation_id](#method-remove_translation_id) ( ) [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_property_translation_key](#method-get_property_translation_key) ( `property_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_property_translated](#method-get_property_translated) ( `property_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +void | [update_text_version](#method-update_text_version) ( ) [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_shortcode](#method-get_shortcode) ( ) [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) -[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_string_full_event](#method-is_string_full_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [to_text](#method-to_text) ( ) +void | [from_text](#method-from_text) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [store_to_shortcode_parameters](#method-store_to_shortcode_parameters) ( `params`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) = `{}` ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [value_to_string](#method-value_to_string) ( `value`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant), `suggestions`: [Callable](https://docs.godotengine.org/en/latest/classes/class_callable.html#class-callable) = `Callable()` ) +void | [load_from_shortcode_parameters](#method-load_from_shortcode_parameters) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_valid_event](#method-is_valid_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_string_full_event](#method-is_string_full_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [parse_shortcode_parameters](#method-parse_shortcode_parameters) ( `shortcode`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -void | [remove_translation_id](#method-remove_translation_id) ( ) void | [set_default_color](#method-set_default_color) ( `value`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) -[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [should_execute_this_branch](#method-should_execute_this_branch) ( ) -[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [to_text](#method-to_text) ( ) -void | [update_text_version](#method-update_text_version) ( ) +[Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | [get_event_editor_info](#method-get_event_editor_info) ( ) +void | [build_event_editor](#method-build_event_editor) ( ) +void | [add_header_label](#method-add_header_label) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `condition`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) +void | [add_header_edit](#method-add_header_edit) ( `variable`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `editor_type`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `16`, `extra_info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) = `{}`, `condition`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) +void | [add_header_button](#method-add_header_button) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `callable`: [Callable](https://docs.godotengine.org/en/latest/classes/class_callable.html#class-callable), `tooltip`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `icon`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) = `null`, `condition`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) +void | [add_body_edit](#method-add_body_edit) ( `variable`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `editor_type`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `16`, `extra_info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) = `{}`, `condition`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) +void | [add_body_line_break](#method-add_body_line_break) ( `condition`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) --- ## Constants @@ -234,17 +239,16 @@ Returns | Method --- -## Signals - -**signal [event_finished](#signal-event_finished) ( `event_resource`: [DialogicEvent](class_dialogicevent.md) )** +**const COLOR = 17** - Emmited when the event finish. The signal is emmited with the event resource event_resource[/code] + *No description available.* --- +## Signals **signal [event_started](#signal-event_started) ( `event_resource`: [DialogicEvent](class_dialogicevent.md) )** @@ -257,6 +261,16 @@ Returns | Method +**signal [event_finished](#signal-event_finished) ( `event_resource`: [DialogicEvent](class_dialogicevent.md) )** + + + + Emmited when the event finish. The signal is emmited with the event resource event_resource[/code] + +--- + + + **signal [ui_update_needed](#signal-ui_update_needed) ( )** @@ -279,91 +293,91 @@ Returns | Method -**var can_contain_events = false** +**var event_name = "Event"** -If true this event will spawn with an END BRANCH event and higher the indentation +The event name that'll be displayed in the editor. --- -**var created_by_button = false** +**var dialogic = null** -Is the event block created by a button? +A reference to dialogic during execution, can be used the same as Dialogic (reference to the autoload) --- -**var dialogic = null** +**var needs_indentation = false** -A reference to dialogic during execution, can be used the same as Dialogic (reference to the autoload) +If true this event can not be toplevel (e.g. Choice) --- -**var dialogic_color_name = ""** +**var can_contain_events = false** -If you are using the default color palette +If true this event will spawn with an END BRANCH event and higher the indentation --- -**var disable_editor_button = false** +**var end_branch_event = null** -If true the event will not have a button in the visual editor sidebar +If is true this is a reference to the end branch event --- -**var editor_list = ** +**var wants_to_group = false** -List that stores the fields for the editor +If this is true this event will group with other similar events (like choices do). --- -**var empty_lines_above = 0** +**var event_node_as_text = ""** -How many empty lines are before this event +Stores the event in a text format. Does NOT automatically update. --- -**var end_branch_event = null** +**var event_node_ready = false** -If is true this is a reference to the end branch event +Flags if the event has been processed or is only stored as text --- -**var event_category = "Other"** +**var empty_lines_above = 0** -The categories and which one to put it in (in the visual editor sidebar) +How many empty lines are before this event --- @@ -379,89 +393,97 @@ The event color that event node will take in the editor -**var event_name = "Event"** +**var dialogic_color_name = ""** -The event name that'll be displayed in the editor. +If you are using the default color palette --- -**var event_node_as_text = ""** +**var event_sorting_index = 0** -Stores the event in a text format. Does NOT automatically update. +To sort the buttons shown in the editor. Lower index is placed at the top of a category --- -**var event_node_ready = false** +**var disable_editor_button = false** -Flags if the event has been processed or is only stored as text +If true the event will not have a button in the visual editor sidebar --- -**var event_sorting_index = 0** +**var expand_by_default = false** -To sort the buttons shown in the editor. Lower index is placed at the top of a category +If false the event will hide it's body by default. Recommended for most events --- -**var expand_by_default = false** +**var help_page_path = ""** -If false the event will hide it's body by default. Recommended for most events +The URL to open when right_click>Documentation is selected --- -**var help_page_path = ""** +**var created_by_button = false** -The URL to open when right_click>Documentation is selected +Is the event block created by a button? --- -**var needs_indentation = false** +**var editor_node = null** -If true this event can not be toplevel (e.g. Choice) +Reference to the node, that represents this event. Only works while in visual editor mode. Use with care. --- -**var wants_to_group = false** +**var event_category = "Other"** -If this is true this event will group with other similar events (like choices do). +The categories and which one to put it in (in the visual editor sidebar) --- -## Method Descriptions + + +**var editor_list = []** + + + +List that stores the fields for the editor + +--- -**func [add_body_edit](#method-add_body_edit) ( `variable`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `editor_type`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `16`, `extra_info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) = ``, `condition`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ void** +**var this_folder = get_base_dir()** @@ -469,43 +491,55 @@ If this is true this event will group with other similar events (like choices do --- +## Method Descriptions -**func [add_body_line_break](#method-add_body_line_break) ( `condition`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ void** +**func [execute](#method-execute) ( `_dialogic_game_handler`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) ⇒ void** - *No description available.* + +Executes the event behaviour. In subclasses (not this one) should be overriden! --- -**func [add_header_button](#method-add_header_button) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `callable`: [Callable](https://docs.godotengine.org/en/latest/classes/class_callable.html#class-callable), `tooltip`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `icon`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) = `null`, `condition`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ void** +**func [finish](#method-finish) ( ) ⇒ void** - *No description available.* +Ends the event behaviour. --- -**func [add_header_edit](#method-add_header_edit) ( `variable`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `editor_type`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `16`, `extra_info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) = ``, `condition`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ void** +**func [get_end_branch_control](#method-get_end_branch_control) ( ) ⇒ [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control)** - *No description available.* +to be overridden by sub-classes only called if can_contain_events is true. return a control node that should show on the END BRANCH node --- -**func [add_header_label](#method-add_header_label) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `condition`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ void** +**func [should_execute_this_branch](#method-should_execute_this_branch) ( ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** - *No description available.* +to be overridden by sub-classes only called if can_contain_events is true and the previous event was an end-branch event return true if this event should be executed if the previous event was an end-branch event basically only important for the Condition event but who knows. Some day someone might need this. + +--- + + + +**func [can_be_translated](#method-can_be_translated) ( ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** + + + +Returns true if there is any translatable properties on this event. Overwrite [_get_translatable_properties()] to change this. --- @@ -521,87 +555,97 @@ This is automatically called, no need to use this. -**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** +**func [remove_translation_id](#method-remove_translation_id) ( ) ⇒ void** -to be overwritten by the sub_classes + *No description available.* --- -**func [can_be_translated](#method-can_be_translated) ( ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [get_property_translation_key](#method-get_property_translation_key) ( `property_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** -Returns true if there is any translatable properties on this event. Overwrite [_get_translatable_properties()] to change this. + *No description available.* --- -**func [execute](#method-execute) ( `_dialogic_game_handler`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) ⇒ void** +**func [get_property_translated](#method-get_property_translated) ( `property_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** -Executes the event behaviour. In subclasses (not this one) should be overriden! +Call this whenever you are using a translatable property --- -**func [finish](#method-finish) ( ) ⇒ void** +**func [update_text_version](#method-update_text_version) ( ) ⇒ void** -Ends the event behaviour. +Call this if you updated an event and want the changes to be saved. --- -**func [from_text](#method-from_text) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** +**func [get_shortcode](#method-get_shortcode) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** -loads the variables from the string stored above by default it uses the shortcode format, but can be overridden +If this uses the short-code format, return the shortcode. --- -**func [get_end_branch_control](#method-get_end_branch_control) ( ) ⇒ [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control)** +**func [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** -to be overridden by sub-classes only called if can_contain_events is true. return a control node that should show on the END BRANCH node +If this uses the short-code format, return the parameters and corresponding property names. --- -**func [get_event_editor_info](#method-get_event_editor_info) ( ) ⇒ [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array)** +**func [to_text](#method-to_text) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** - *No description available.* +Returns a readable presentation of the event (This is how it's stored). By default it uses a shortcode format, but can be overridden. --- -**func [get_property_translated](#method-get_property_translated) ( `property_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [from_text](#method-from_text) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** -Call this whenever you are using a translatable property +Loads the variables from the string stored by [to_text](#property-to_text). By default it uses the shortcode format, but can be overridden. --- -**func [get_property_translation_key](#method-get_property_translation_key) ( `property_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [store_to_shortcode_parameters](#method-store_to_shortcode_parameters) ( `params`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) = `{}` ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** + + + +Returns a string with all the shortcode parameters. + +--- + + + +**func [value_to_string](#method-value_to_string) ( `value`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant), `suggestions`: [Callable](https://docs.godotengine.org/en/latest/classes/class_callable.html#class-callable) = `Callable()` ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** @@ -611,21 +655,21 @@ Call this whenever you are using a translatable property -**func [get_shortcode](#method-get_shortcode) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [load_from_shortcode_parameters](#method-load_from_shortcode_parameters) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** -if this uses the short-code format, return the shortcode + *No description available.* --- -**func [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [is_valid_event](#method-is_valid_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** -if this uses the short-code format, return the parameters and corresponding property names +Has to return `true`, if the given string can be interpreted as this event. By default it uses the shortcode formta, but can be overridden. --- @@ -641,27 +685,27 @@ has to return true if this string seems to be a full event of this kind (only te -**func [is_valid_event](#method-is_valid_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [parse_shortcode_parameters](#method-parse_shortcode_parameters) ( `shortcode`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** -has to return true, if the given string can be interpreted as this event by default it uses the shortcode formta, but can be overridden +Used to get all the shortcode parameters in a string as a dictionary. --- -**func [parse_shortcode_parameters](#method-parse_shortcode_parameters) ( `shortcode`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [set_default_color](#method-set_default_color) ( `value`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) ⇒ void** -used to get all the shortcode parameters in a string as a dictionary + *No description available.* --- -**func [remove_translation_id](#method-remove_translation_id) ( ) ⇒ void** +**func [get_event_editor_info](#method-get_event_editor_info) ( ) ⇒ [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array)** @@ -671,7 +715,17 @@ used to get all the shortcode parameters in a string as a dictionary -**func [set_default_color](#method-set_default_color) ( `value`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) ⇒ void** +**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** + + + +to be overwritten by the sub_classes + +--- + + + +**func [add_header_label](#method-add_header_label) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `condition`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ void** @@ -681,31 +735,41 @@ used to get all the shortcode parameters in a string as a dictionary -**func [should_execute_this_branch](#method-should_execute_this_branch) ( ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [add_header_edit](#method-add_header_edit) ( `variable`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `editor_type`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `16`, `extra_info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) = `{}`, `condition`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ void** -to be overridden by sub-classes only called if can_contain_events is true and the previous event was an end-branch event return true if this event should be executed if the previous event was an end-branch event basically only important for the Condition event but who knows. Some day someone might need this. + *No description available.* --- -**func [to_text](#method-to_text) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [add_header_button](#method-add_header_button) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `callable`: [Callable](https://docs.godotengine.org/en/latest/classes/class_callable.html#class-callable), `tooltip`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `icon`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) = `null`, `condition`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ void** -returns a readable presentation of the event (This is how it's stored) by default it uses a shortcode format, but can be overridden + *No description available.* --- -**func [update_text_version](#method-update_text_version) ( ) ⇒ void** +**func [add_body_edit](#method-add_body_edit) ( `variable`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `editor_type`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `16`, `extra_info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) = `{}`, `condition`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ void** -Call this if you updated an event and want the changes to be saved. + *No description available.* + +--- + + + +**func [add_body_line_break](#method-add_body_line_break) ( `condition`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ void** + + + + *No description available.* --- diff --git a/documentation/classes/class_dialogicgamehandler.md b/documentation/classes/class_dialogicgamehandler.md index efb1e1c..ae3f523 100644 --- a/documentation/classes/class_dialogicgamehandler.md +++ b/documentation/classes/class_dialogicgamehandler.md @@ -16,47 +16,48 @@ Autoload script that allows you to interact with all of Dialogic's systems: ## Properties Name | Type | Default --- | --- | --- -[Animations](#property-animations) | `Modules/Core/subsystem_animation.gd` | -[Audio](#property-audio) | `Modules/Audio/subsystem_audio.gd` | -[Backgrounds](#property-backgrounds) | `Modules/Background/subsystem_backgrounds.gd` | -[Choices](#property-choices) | `Modules/Choice/subsystem_choices.gd` | -[Expressions](#property-expressions) | `Modules/Core/subsystem_expression.gd` | -[Glossary](#property-glossary) | `Modules/Glossary/subsystem_glossary.gd` | -[History](#property-history) | `Modules/History/subsystem_history.gd` | -[Inputs](#property-inputs) | `Modules/Core/subsystem_input.gd` | -[Jump](#property-jump) | `Modules/Jump/subsystem_jump.gd` | -[Portraits](#property-portraits) | `Modules/Character/subsystem_portraits.gd` | -[Save](#property-save) | `Modules/Save/subsystem_save.gd` | -[Settings](#property-settings) | `Modules/Settings/subsystem_settings.gd` | -[Styles](#property-styles) | `Modules/Style/subsystem_styles.gd` | -[Text](#property-text) | `Modules/Text/subsystem_text.gd` | -[TextInput](#property-textinput) | `Modules/TextInput/subsystem_text_input.gd` | -[VAR](#property-var) | `Modules/Variable/subsystem_variables.gd` | -[Voice](#property-voice) | `Modules/Voice/subsystem_voice.gd` | +[current_timeline](#property-current_timeline) | [DialogicTimeline](class_dialogictimeline.md) | `null` +[current_timeline_events](#property-current_timeline_events) | [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | `[]` [current_event_idx](#property-current_event_idx) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `0` +[current_state_info](#property-current_state_info) | [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | `{}` [current_state](#property-current_state) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `0` -[current_state_info](#property-current_state_info) | [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | -[current_timeline](#property-current_timeline) | [DialogicTimeline](class_dialogictimeline.md) | `null` -[current_timeline_events](#property-current_timeline_events) | [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | [paused](#property-paused) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` +[Audio](#property-audio) | `Modules/Audio/subsystem_audio.gd` | `new()` +[Backgrounds](#property-backgrounds) | `Modules/Background/subsystem_backgrounds.gd` | `new()` +[Portraits](#property-portraits) | `Modules/Character/subsystem_portraits.gd` | `new()` +[PortraitContainers](#property-portraitcontainers) | `Modules/Character/subsystem_containers.gd` | `new()` +[Choices](#property-choices) | `Modules/Choice/subsystem_choices.gd` | `new()` +[Expressions](#property-expressions) | `Modules/Core/subsystem_expression.gd` | `new()` +[Animations](#property-animations) | `Modules/Core/subsystem_animation.gd` | `new()` +[Inputs](#property-inputs) | `Modules/Core/subsystem_input.gd` | `new()` +[Glossary](#property-glossary) | `Modules/Glossary/subsystem_glossary.gd` | `new()` +[History](#property-history) | `Modules/History/subsystem_history.gd` | `new()` +[Jump](#property-jump) | `Modules/Jump/subsystem_jump.gd` | `new()` +[Save](#property-save) | `Modules/Save/subsystem_save.gd` | `new()` +[Settings](#property-settings) | `Modules/Settings/subsystem_settings.gd` | `new()` +[Styles](#property-styles) | `Modules/Style/subsystem_styles.gd` | `new()` +[Text](#property-text) | `Modules/Text/subsystem_text.gd` | `new()` +[TextInput](#property-textinput) | `Modules/TextInput/subsystem_text_input.gd` | `new()` +[VAR](#property-var) | `Modules/Variable/subsystem_variables.gd` | `new()` +[Voice](#property-voice) | `Modules/Voice/subsystem_voice.gd` | `new()` --- ## Methods Returns | Method --- | --- -[DialogicSubsystem](class_dialogicsubsystem.md) | [add_subsystem](#method-add_subsystem) ( `subsystem_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `script_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -void | [clear](#method-clear) ( `clear_flags`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) +[Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) | [start](#method-start) ( `timeline`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant), `label`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) = `""` ) +void | [start_timeline](#method-start_timeline) ( `timeline`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant), `label_or_idx`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) = `""` ) +[Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) | [preload_timeline](#method-preload_timeline) ( `timeline_resource`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) void | [end_timeline](#method-end_timeline) ( ) -[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_full_state](#method-get_full_state) ( ) -[DialogicSubsystem](class_dialogicsubsystem.md) | [get_subsystem](#method-get_subsystem) ( `subsystem_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -void | [handle_event](#method-handle_event) ( `event_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) void | [handle_next_event](#method-handle_next_event) ( `_ignore_argument`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) = `""` ) -[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [has_subsystem](#method-has_subsystem) ( `subsystem_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +void | [handle_event](#method-handle_event) ( `event_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) +void | [clear](#method-clear) ( `clear_flags`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_full_state](#method-get_full_state) ( ) void | [load_full_state](#method-load_full_state) ( `state_info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) ) -[Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) | [preload_timeline](#method-preload_timeline) ( `timeline_resource`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) +[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [has_subsystem](#method-has_subsystem) ( `subsystem_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[DialogicSubsystem](class_dialogicsubsystem.md) | [get_subsystem](#method-get_subsystem) ( `subsystem_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[DialogicSubsystem](class_dialogicsubsystem.md) | [add_subsystem](#method-add_subsystem) ( `subsystem_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `script_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) void | [print_debug_moment](#method-print_debug_moment) ( ) -[Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) | [start](#method-start) ( `timeline`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant), `label`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) = `""` ) -void | [start_timeline](#method-start_timeline) ( `timeline`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant), `label_or_idx`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) = `""` ) --- ## Constants @@ -135,6 +136,16 @@ Returns | Method ## Signals +**signal [state_changed](#signal-state_changed) ( `new_state`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) )** + + + + Emitted when `current_state` change. + +--- + + + **signal [dialogic_paused](#signal-dialogic_paused) ( )** @@ -155,119 +166,119 @@ Returns | Method -**signal [event_handled](#signal-event_handled) ( `resource`: [DialogicEvent](class_dialogicevent.md) )** +**signal [timeline_ended](#signal-timeline_ended) ( )** - Emitted when an event starts being executed. The event may not have finished executing yet. + Emitted when the timeline ends. This can be a timeline ending or [end_timeline](#property-end_timeline) being called. --- -**signal [signal_event](#signal-signal_event) ( `argument`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) )** +**signal [timeline_started](#signal-timeline_started) ( )** - Emitted when a [SignalEvent](class_signalevent.md) event was reached. + Emitted when a timeline starts by calling either [start](#property-start) or [start_timeline](#property-start_timeline). --- -**signal [state_changed](#signal-state_changed) ( `new_state`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) )** +**signal [event_handled](#signal-event_handled) ( `resource`: [DialogicEvent](class_dialogicevent.md) )** - Emitted when `current_state` change. + Emitted when an event starts being executed. The event may not have finished executing yet. --- -**signal [text_signal](#signal-text_signal) ( `argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) )** +**signal [signal_event](#signal-signal_event) ( `argument`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) )** - Emitted when a signal event gets fired from a [TextEvent](class_textevent.md) event. + Emitted when a [SignalEvent](class_signalevent.md) event was reached. --- -**signal [timeline_ended](#signal-timeline_ended) ( )** +**signal [text_signal](#signal-text_signal) ( `argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) )** - Emitted when the timeline ends. This can be a timeline ending or [end_timeline](#property-end_timeline) being called. + Emitted when a signal event gets fired from a [TextEvent](class_textevent.md) event. --- +## Property Descriptions -**signal [timeline_started](#signal-timeline_started) ( )** +**var current_timeline = null** - Emitted when a timeline starts by calling either [start](#property-start) or [start_timeline](#property-start_timeline). ---- +Reference to the currently executed timeline. -## Property Descriptions +--- -**var Animations = ** +**var current_timeline_events = []** - *No description available.* +Copy of the `current_timeline`'s events. --- -**var Audio = ** +**var current_event_idx = 0** - *No description available.* +Index of the event the timeline handling is currently at. --- -**var Backgrounds = ** +**var current_state_info = {}** - *No description available.* +Contains all information that subsystems consider relevant for the current situation --- -**var Choices = ** +**var current_state = 0** - *No description available.* +Current state (see `States` enum). --- -**var Expressions = ** +**var paused = false** - *No description available.* +When `true`, many dialogic processes won't continue until it's `false` again. --- -**var Glossary = ** +**var Audio = new()** @@ -277,7 +288,7 @@ Returns | Method -**var History = ** +**var Backgrounds = new()** @@ -287,7 +298,7 @@ Returns | Method -**var Inputs = ** +**var Portraits = new()** @@ -297,7 +308,7 @@ Returns | Method -**var Jump = ** +**var PortraitContainers = new()** @@ -307,7 +318,7 @@ Returns | Method -**var Portraits = ** +**var Choices = new()** @@ -317,7 +328,7 @@ Returns | Method -**var Save = ** +**var Expressions = new()** @@ -327,7 +338,7 @@ Returns | Method -**var Settings = ** +**var Animations = new()** @@ -337,7 +348,7 @@ Returns | Method -**var Styles = ** +**var Inputs = new()** @@ -347,7 +358,7 @@ Returns | Method -**var Text = ** +**var Glossary = new()** @@ -357,7 +368,7 @@ Returns | Method -**var TextInput = ** +**var History = new()** @@ -367,7 +378,7 @@ Returns | Method -**var VAR = ** +**var Jump = new()** @@ -377,7 +388,7 @@ Returns | Method -**var Voice = ** +**var Save = new()** @@ -387,61 +398,61 @@ Returns | Method -**var current_event_idx = 0** +**var Settings = new()** -Index of the event the timeline handling is currently at. + *No description available.* --- -**var current_state = 0** +**var Styles = new()** -Current state (see `States` enum). + *No description available.* --- -**var current_state_info = ** +**var Text = new()** -Contains all information that subsystems consider relevant for the current situation + *No description available.* --- -**var current_timeline = null** +**var TextInput = new()** -Reference to the currently executed timeline. + *No description available.* --- -**var current_timeline_events = ** +**var VAR = new()** -Copy of the `current_timeline`'s events. + *No description available.* --- -**var paused = false** +**var Voice = new()** -When `true`, many dialogic processes won't continue until it's `false` again. + *No description available.* --- @@ -449,51 +460,51 @@ When `true`, many dialogic processes won't continue until it's `false` again. -**func [add_subsystem](#method-add_subsystem) ( `subsystem_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `script_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [DialogicSubsystem](class_dialogicsubsystem.md)** +**func [start](#method-start) ( `timeline`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant), `label`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) = `""` ) ⇒ [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node)** -Adds a subsystem node with the given `subsystem_name` and `script_path`. +Method to start a timeline AND ensure that a layout scene is present. For argument info, checkout [start_timeline](#property-start_timeline). -> returns the layout node --- -**func [clear](#method-clear) ( `clear_flags`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** +**func [start_timeline](#method-start_timeline) ( `timeline`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant), `label_or_idx`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) = `""` ) ⇒ void** -Resets Dialogic's state fully or partially. By using the clear flags from the `ClearFlags` enum you can specify what info should be kept. For example, at timeline end usually it doesn't clear node or subsystem info. +Method to start a timeline without adding a layout scene. @timeline can be either a loaded timeline resource or a path to a timeline file. @label_or_idx can be a label (string) or index (int) to skip to immediatly. --- -**func [end_timeline](#method-end_timeline) ( ) ⇒ void** +**func [preload_timeline](#method-preload_timeline) ( `timeline_resource`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) ⇒ [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant)** -Clears and stops the current timeline. +Preloader function, prepares a timeline and returns an object to hold for later `timeline_resource` can be either a path (string) or a loaded timeline (resource) --- -**func [get_full_state](#method-get_full_state) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [end_timeline](#method-end_timeline) ( ) ⇒ void** -Returns a dictionary containing all necessary information to later recreate the same state with load_full_state. The [Save](subsystem_save.md) subsystem might be more useful for you. However, this can be used to integrate the info into your own save system. +Clears and stops the current timeline. --- -**func [get_subsystem](#method-get_subsystem) ( `subsystem_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [DialogicSubsystem](class_dialogicsubsystem.md)** +**func [handle_next_event](#method-handle_next_event) ( `_ignore_argument`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) = `""` ) ⇒ void** -Returns the subsystem node of the given `subsystem_name` or null if it doesn't exist. +Handles the next event. --- @@ -509,21 +520,21 @@ Handles the event at the given index `event_index`. You can call this manually, -**func [handle_next_event](#method-handle_next_event) ( `_ignore_argument`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) = `""` ) ⇒ void** +**func [clear](#method-clear) ( `clear_flags`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** -Handles the next event. +Resets Dialogic's state fully or partially. By using the clear flags from the `ClearFlags` enum you can specify what info should be kept. For example, at timeline end usually it doesn't clear node or subsystem info. --- -**func [has_subsystem](#method-has_subsystem) ( `subsystem_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [get_full_state](#method-get_full_state) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** -Returns `true` if a subystem with the given `subsystem_name` exists. +Returns a dictionary containing all necessary information to later recreate the same state with load_full_state. The [Save](subsystem_save.md) subsystem might be more useful for you. However, this can be used to integrate the info into your own save system. --- @@ -539,41 +550,41 @@ This method tries to load the state from the given `state_info`. Will automatica -**func [preload_timeline](#method-preload_timeline) ( `timeline_resource`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) ⇒ [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant)** +**func [has_subsystem](#method-has_subsystem) ( `subsystem_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** -Preloader function, prepares a timeline and returns an object to hold for later `timeline_resource` can be either a path (string) or a loaded timeline (resource) +Returns `true` if a subystem with the given `subsystem_name` exists. --- -**func [print_debug_moment](#method-print_debug_moment) ( ) ⇒ void** +**func [get_subsystem](#method-get_subsystem) ( `subsystem_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [DialogicSubsystem](class_dialogicsubsystem.md)** - *No description available.* +Returns the subsystem node of the given `subsystem_name` or null if it doesn't exist. --- -**func [start](#method-start) ( `timeline`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant), `label`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) = `""` ) ⇒ [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node)** +**func [add_subsystem](#method-add_subsystem) ( `subsystem_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `script_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [DialogicSubsystem](class_dialogicsubsystem.md)** -Method to start a timeline AND ensure that a layout scene is present. For argument info, checkout [start_timeline](#property-start_timeline). -> returns the layout node +Adds a subsystem node with the given `subsystem_name` and `script_path`. --- -**func [start_timeline](#method-start_timeline) ( `timeline`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant), `label_or_idx`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) = `""` ) ⇒ void** +**func [print_debug_moment](#method-print_debug_moment) ( ) ⇒ void** -Method to start a timeline without adding a layout scene. @timeline can be either a loaded timeline resource or a path to a timeline file. @label_or_idx can be a label (string) or index (int) to skip to immediatly. + *No description available.* --- diff --git a/documentation/classes/class_dialogicglossary.md b/documentation/classes/class_dialogicglossary.md index 3b8f944..582c449 100644 --- a/documentation/classes/class_dialogicglossary.md +++ b/documentation/classes/class_dialogicglossary.md @@ -12,25 +12,25 @@ Resource used to store glossary entries. Can be saved to disc and used as a glos ## Properties Name | Type | Default --- | --- | --- +[entries](#property-entries) | [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | `{}` [enabled](#property-enabled) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `true` -[entries](#property-entries) | [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | --- ## Methods Returns | Method --- | --- +[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [remove_entry](#method-remove_entry) ( `entry_key`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +void | [replace_entry_key](#method-replace_entry_key) ( `old_entry_key`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `new_entry_key`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_entry](#method-get_entry) ( `entry_key`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [try_add_entry](#method-try_add_entry) ( `entry`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_set_regex_option](#method-get_set_regex_option) ( `entry_key`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [add_translation_id](#method-add_translation_id) ( ) +void | [remove_translation_id](#method-remove_translation_id) ( ) +void | [remove_entry_translation_ids](#method-remove_entry_translation_ids) ( ) void | [clear_translation_keys](#method-clear_translation_keys) ( ) -[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_entry](#method-get_entry) ( `entry_key`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_property_translation_key](#method-get_property_translation_key) ( `entry_key`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `property`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_set_glossary_entry_translation_id](#method-get_set_glossary_entry_translation_id) ( `entry_key`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_set_glossary_translation_id](#method-get_set_glossary_translation_id) ( ) -[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_set_regex_option](#method-get_set_regex_option) ( `entry_key`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [remove_entry](#method-remove_entry) ( `entry_key`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -void | [remove_entry_translation_ids](#method-remove_entry_translation_ids) ( ) -void | [remove_translation_id](#method-remove_translation_id) ( ) -void | [replace_entry_key](#method-replace_entry_key) ( `old_entry_key`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `new_entry_key`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [try_add_entry](#method-try_add_entry) ( `entry`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) ) --- ## Constants @@ -118,21 +118,21 @@ Returns | Method -**var enabled = true** +**var entries = {}** -If false, no entries from this glossary will be shown +Stores all entries for the glossary. The value may either be a dictionary, representing an entry, or a string, representing the actual key for the key used. The string key-value pairs are the alias keys, they allow to redirect the actual glossary entry. --- -**var entries = ** +**var enabled = true** -Stores all entries for the glossary. The value may either be a dictionary, representing an entry, or a string, representing the actual key for the key used. The string key-value pairs are the alias keys, they allow to redirect the actual glossary entry. +If false, no entries from this glossary will be shown --- @@ -140,21 +140,21 @@ Stores all entries for the glossary. The value may either be a dictionary, repr -**func [add_translation_id](#method-add_translation_id) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [remove_entry](#method-remove_entry) ( `entry_key`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** -This is automatically called, no need to use this. +Removes an entry and all its aliases (alternative property) from the glossary. `entry_key` may be an entry name or an alias. Returns true if the entry matching the given `entry_key` was found. --- -**func [clear_translation_keys](#method-clear_translation_keys) ( ) ⇒ void** +**func [replace_entry_key](#method-replace_entry_key) ( `old_entry_key`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `new_entry_key`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** -Clears the lookup tables using translation keys. +Do not use this to update alternative names. In order to update alternative names, delete all with `_remove_entry_alias` and then add them again with `_add_entry_key_alias`. --- @@ -170,91 +170,91 @@ Gets the glossary entry for the given `entry_key`. If there is no matching entry -**func [get_property_translation_key](#method-get_property_translation_key) ( `entry_key`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `property`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [try_add_entry](#method-try_add_entry) ( `entry`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** -Returns a key used to reference this glossary in the translation CSV file. Time complexity: O(1) +Adds `entry` to the glossary if it does not exist. If it does exist, returns false. --- -**func [get_set_glossary_entry_translation_id](#method-get_set_glossary_entry_translation_id) ( `entry_key`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [get_set_regex_option](#method-get_set_regex_option) ( `entry_key`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** -Tries to get the glossary entry's translation ID. If it does not exist, a new one will be generated. +Gets the regex option for the given `entry_key`. If the regex option does not exist, it will be generated. A regex option is the accumulation of valid words that can trigger the glossary popup. The `entry_key` must be valid or an error will occur. --- -**func [get_set_glossary_translation_id](#method-get_set_glossary_translation_id) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [add_translation_id](#method-add_translation_id) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** -Tries to get the glossary's translation ID. If it does not exist, a new one will be generated. +This is automatically called, no need to use this. --- -**func [get_set_regex_option](#method-get_set_regex_option) ( `entry_key`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [remove_translation_id](#method-remove_translation_id) ( ) ⇒ void** -Gets the regex option for the given `entry_key`. If the regex option does not exist, it will be generated. A regex option is the accumulation of valid words that can trigger the glossary popup. The `entry_key` must be valid or an error will occur. +Removes the translation ID of this glossary. --- -**func [remove_entry](#method-remove_entry) ( `entry_key`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [remove_entry_translation_ids](#method-remove_entry_translation_ids) ( ) ⇒ void** -Removes an entry and all its aliases (alternative property) from the glossary. `entry_key` may be an entry name or an alias. Returns true if the entry matching the given `entry_key` was found. +Removes the translation ID of all glossary entries. --- -**func [remove_entry_translation_ids](#method-remove_entry_translation_ids) ( ) ⇒ void** +**func [clear_translation_keys](#method-clear_translation_keys) ( ) ⇒ void** -Removes the translation ID of all glossary entries. +Clears the lookup tables using translation keys. --- -**func [remove_translation_id](#method-remove_translation_id) ( ) ⇒ void** +**func [get_property_translation_key](#method-get_property_translation_key) ( `entry_key`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `property`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** -Removes the translation ID of this glossary. +Returns a key used to reference this glossary in the translation CSV file. Time complexity: O(1) --- -**func [replace_entry_key](#method-replace_entry_key) ( `old_entry_key`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `new_entry_key`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** +**func [get_set_glossary_entry_translation_id](#method-get_set_glossary_entry_translation_id) ( `entry_key`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** -Do not use this to update alternative names. In order to update alternative names, delete all with `_remove_entry_alias` and then add them again with `_add_entry_key_alias`. +Tries to get the glossary entry's translation ID. If it does not exist, a new one will be generated. --- -**func [try_add_entry](#method-try_add_entry) ( `entry`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [get_set_glossary_translation_id](#method-get_set_glossary_translation_id) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** -Adds `entry` to the glossary if it does not exist. If it does exist, returns false. +Tries to get the glossary's translation ID. If it does not exist, a new one will be generated. --- diff --git a/documentation/classes/class_dialogicglossaryevent.md b/documentation/classes/class_dialogicglossaryevent.md index 5b8cd91..3738d5d 100644 --- a/documentation/classes/class_dialogicglossaryevent.md +++ b/documentation/classes/class_dialogicglossaryevent.md @@ -14,35 +14,35 @@ ## Methods Returns | Method --- | --- -void | [build_event_editor](#method-build_event_editor) ( ) [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_shortcode](#method-get_shortcode) ( ) [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) +void | [build_event_editor](#method-build_event_editor) ( ) --- ## Method Descriptions -**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** +**func [get_shortcode](#method-get_shortcode) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** - *No description available.* +############################################################################## SAVING/LOADING ############################################################################## --- -**func [get_shortcode](#method-get_shortcode) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** -############################################################################## SAVING/LOADING ############################################################################## + *No description available.* --- -**func [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** diff --git a/documentation/classes/class_dialogichistoryevent.md b/documentation/classes/class_dialogichistoryevent.md index ed61fe4..94a2106 100644 --- a/documentation/classes/class_dialogichistoryevent.md +++ b/documentation/classes/class_dialogichistoryevent.md @@ -18,9 +18,9 @@ Name | Type | Default ## Methods Returns | Method --- | --- -void | [build_event_editor](#method-build_event_editor) ( ) [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_shortcode](#method-get_shortcode) ( ) [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) +void | [build_event_editor](#method-build_event_editor) ( ) --- ## Constants @@ -66,7 +66,7 @@ The type of action: Clear, Pause or Resume -**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** +**func [get_shortcode](#method-get_shortcode) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** @@ -76,7 +76,7 @@ The type of action: Clear, Pause or Resume -**func [get_shortcode](#method-get_shortcode) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** @@ -86,7 +86,7 @@ The type of action: Clear, Pause or Resume -**func [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** diff --git a/documentation/classes/class_dialogicindexer.md b/documentation/classes/class_dialogicindexer.md index c952949..a1676ec 100644 --- a/documentation/classes/class_dialogicindexer.md +++ b/documentation/classes/class_dialogicindexer.md @@ -14,21 +14,22 @@ Overwrite the methods to return the contents of that folder. ## Properties Name | Type | Default --- | --- | --- -[this_folder](#property-this_folder) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | +[this_folder](#property-this_folder) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `get_base_dir()` --- ## Methods Returns | Method --- | --- [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | [list_dir](#method-list_dir) ( `subdir`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) -[Dictionary[]](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [list_special_resources](#method-list_special_resources) ( `subdir`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `type`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `extension`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [list_special_resources](#method-list_special_resources) ( `subdir`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `extension`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [list_animations](#method-list_animations) ( `subdir`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) [Dictionary[]](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [scan_for_layout_parts](#method-scan_for_layout_parts) ( ) --- ## Property Descriptions -**var this_folder = ** +**var this_folder = get_base_dir()** @@ -50,7 +51,17 @@ Returns | Method -**func [list_special_resources](#method-list_special_resources) ( `subdir`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `type`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `extension`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ [Dictionary[]](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [list_special_resources](#method-list_special_resources) ( `subdir`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `extension`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** + + + + *No description available.* + +--- + + + +**func [list_animations](#method-list_animations) ( `subdir`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** diff --git a/documentation/classes/class_dialogicjumpevent.md b/documentation/classes/class_dialogicjumpevent.md index dfd601e..6868cff 100644 --- a/documentation/classes/class_dialogicjumpevent.md +++ b/documentation/classes/class_dialogicjumpevent.md @@ -12,41 +12,41 @@ ## Properties Name | Type | Default --- | --- | --- -[label_name](#property-label_name) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` [timeline](#property-timeline) | [DialogicTimeline](class_dialogictimeline.md) | +[label_name](#property-label_name) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` [timeline_identifier](#property-timeline_identifier) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` --- ## Methods Returns | Method --- | --- -void | [build_event_editor](#method-build_event_editor) ( ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [to_text](#method-to_text) ( ) void | [from_text](#method-from_text) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_label_suggestions](#method-get_label_suggestions) ( `filter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) -[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) -[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_timeline_suggestions](#method-get_timeline_suggestions) ( `filter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_valid_event](#method-is_valid_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [to_text](#method-to_text) ( ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) +void | [build_event_editor](#method-build_event_editor) ( ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_timeline_suggestions](#method-get_timeline_suggestions) ( `_filter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_label_suggestions](#method-get_label_suggestions) ( `_filter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) --- ## Property Descriptions -**var label_name = ""** +**var timeline** -If not empty, the event will try to find a Label event with this set as name. Empty by default.. +The timeline to jump to, if null then it's the current one. This setting should be a dialogic timeline resource. --- -**var timeline** +**var label_name = ""** -The timeline to jump to, if null then it's the current one. This setting should be a dialogic timeline resource. +If not empty, the event will try to find a Label event with this set as name. Empty by default.. --- @@ -64,11 +64,11 @@ Used to set the timeline resource from the unique name identifier and vice versa -**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** +**func [to_text](#method-to_text) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** - *No description available.* +############################################################################## SAVING/LOADING ############################################################################## --- @@ -84,7 +84,7 @@ Used to set the timeline resource from the unique name identifier and vice versa -**func [get_label_suggestions](#method-get_label_suggestions) ( `filter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [is_valid_event](#method-is_valid_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** @@ -104,7 +104,7 @@ Used to set the timeline resource from the unique name identifier and vice versa -**func [get_timeline_suggestions](#method-get_timeline_suggestions) ( `filter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** @@ -114,7 +114,7 @@ Used to set the timeline resource from the unique name identifier and vice versa -**func [is_valid_event](#method-is_valid_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [get_timeline_suggestions](#method-get_timeline_suggestions) ( `_filter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** @@ -124,11 +124,11 @@ Used to set the timeline resource from the unique name identifier and vice versa -**func [to_text](#method-to_text) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [get_label_suggestions](#method-get_label_suggestions) ( `_filter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** -############################################################################## SAVING/LOADING ############################################################################## + *No description available.* --- diff --git a/documentation/classes/class_dialogiclabelevent.md b/documentation/classes/class_dialogiclabelevent.md index 95751b7..219e53b 100644 --- a/documentation/classes/class_dialogiclabelevent.md +++ b/documentation/classes/class_dialogiclabelevent.md @@ -12,38 +12,38 @@ ## Properties Name | Type | Default --- | --- | --- -[display_name](#property-display_name) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` [name](#property-name) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` +[display_name](#property-display_name) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` --- ## Methods Returns | Method --- | --- -void | [build_event_editor](#method-build_event_editor) ( ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [to_text](#method-to_text) ( ) void | [from_text](#method-from_text) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_valid_event](#method-is_valid_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [to_text](#method-to_text) ( ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) +void | [build_event_editor](#method-build_event_editor) ( ) --- ## Property Descriptions -**var display_name = ""** +**var name = ""** - *No description available.* +Used to identify the label. Duplicate names in a timeline will mean it always chooses the first. --- -**var name = ""** +**var display_name = ""** -Used to identify the label. Duplicate names in a timeline will mean it always chooses the first. + *No description available.* --- @@ -51,11 +51,11 @@ Used to identify the label. Duplicate names in a timeline will mean it always ch -**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** +**func [to_text](#method-to_text) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** - *No description available.* +############################################################################## SAVING/LOADING ############################################################################## --- @@ -71,7 +71,7 @@ Used to identify the label. Duplicate names in a timeline will mean it always ch -**func [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [is_valid_event](#method-is_valid_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** @@ -81,7 +81,7 @@ Used to identify the label. Duplicate names in a timeline will mean it always ch -**func [is_valid_event](#method-is_valid_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** @@ -91,11 +91,11 @@ Used to identify the label. Duplicate names in a timeline will mean it always ch -**func [to_text](#method-to_text) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** -############################################################################## SAVING/LOADING ############################################################################## + *No description available.* --- diff --git a/documentation/classes/class_dialogiclayoutbase.md b/documentation/classes/class_dialogiclayoutbase.md index d6184b0..876bb50 100644 --- a/documentation/classes/class_dialogiclayoutbase.md +++ b/documentation/classes/class_dialogiclayoutbase.md @@ -15,10 +15,10 @@ Base class that should be extended by custom layouts. Returns | Method --- | --- [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) | [add_layer](#method-add_layer) ( `layer`: [DialogicLayoutLayer](class_dialogiclayoutlayer.md) ) -void | [appply_export_overrides](#method-appply_export_overrides) ( ) -[Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) | [get_global_setting](#method-get_global_setting) ( `setting`: [StringName](https://docs.godotengine.org/en/latest/classes/class_stringname.html#class-stringname), `default`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) | [get_layer](#method-get_layer) ( `index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | [get_layers](#method-get_layers) ( ) +void | [apply_export_overrides](#method-apply_export_overrides) ( ) +[Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) | [get_global_setting](#method-get_global_setting) ( `setting`: [StringName](https://docs.godotengine.org/en/latest/classes/class_stringname.html#class-stringname), `default`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) --- ## Method Descriptions @@ -28,47 +28,47 @@ Returns | Method - *No description available.* +Method that adds a node as a layer --- -**func [appply_export_overrides](#method-appply_export_overrides) ( ) ⇒ void** +**func [get_layer](#method-get_layer) ( `index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) ⇒ [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node)** - *No description available.* +Method that returns the given child --- -**func [get_global_setting](#method-get_global_setting) ( `setting`: [StringName](https://docs.godotengine.org/en/latest/classes/class_stringname.html#class-stringname), `default`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) ⇒ [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant)** +**func [get_layers](#method-get_layers) ( ) ⇒ [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array)** - *No description available.* +Method to return all the layers --- -**func [get_layer](#method-get_layer) ( `index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) ⇒ [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node)** +**func [apply_export_overrides](#method-apply_export_overrides) ( ) ⇒ void** - *No description available.* +Method that is called to load the export overrides. This happens when the style is first introduced, but also when switching to a different style using the same scene! --- -**func [get_layers](#method-get_layers) ( ) ⇒ [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array)** +**func [get_global_setting](#method-get_global_setting) ( `setting`: [StringName](https://docs.godotengine.org/en/latest/classes/class_stringname.html#class-stringname), `default`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) ⇒ [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant)** - *No description available.* +Returns a setting on this base. This is useful so that layers can share settings like base_color, etc. --- diff --git a/documentation/classes/class_dialogiclayoutlayer.md b/documentation/classes/class_dialogiclayoutlayer.md index 59aed41..5f3d313 100644 --- a/documentation/classes/class_dialogiclayoutlayer.md +++ b/documentation/classes/class_dialogiclayoutlayer.md @@ -14,9 +14,9 @@ Turn it off, if you want to modify the settings of the nodes yourself. ## Properties Name | Type | Default --- | --- | --- -[apply_overrides_on_ready](#property-apply_overrides_on_ready) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` [disabled](#property-disabled) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` -[this_folder](#property-this_folder) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | +[apply_overrides_on_ready](#property-apply_overrides_on_ready) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` +[this_folder](#property-this_folder) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `get_base_dir()` --- ## Methods @@ -29,7 +29,7 @@ Returns | Method -**var apply_overrides_on_ready = false** +**var disabled = false** @@ -39,7 +39,7 @@ Returns | Method -**var disabled = false** +**var apply_overrides_on_ready = false** @@ -49,7 +49,7 @@ Returns | Method -**var this_folder = ** +**var this_folder = get_base_dir()** diff --git a/documentation/classes/class_dialogicmusicevent.md b/documentation/classes/class_dialogicmusicevent.md index e9872dc..21185b7 100644 --- a/documentation/classes/class_dialogicmusicevent.md +++ b/documentation/classes/class_dialogicmusicevent.md @@ -12,30 +12,30 @@ ## Properties Name | Type | Default --- | --- | --- -[audio_bus](#property-audio_bus) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `"Master"` -[fade_length](#property-fade_length) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `0.0` [file_path](#property-file_path) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` -[loop](#property-loop) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `true` +[fade_length](#property-fade_length) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `0.0` [volume](#property-volume) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `0.0` +[audio_bus](#property-audio_bus) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` +[loop](#property-loop) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `true` --- ## Methods Returns | Method --- | --- -void | [build_event_editor](#method-build_event_editor) ( ) -[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_bus_suggestions](#method-get_bus_suggestions) ( ) [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_shortcode](#method-get_shortcode) ( ) [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) +void | [build_event_editor](#method-build_event_editor) ( ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_bus_suggestions](#method-get_bus_suggestions) ( ) --- ## Property Descriptions -**var audio_bus = "Master"** +**var file_path = ""** -The audio bus the music will be played at. +The file to play. If empty, the previous music will be faded out. --- @@ -51,31 +51,31 @@ The length of the fade. If 0 (by default) it's an instant change. -**var file_path = ""** +**var volume = 0.0** -The file to play. If empty, the previous music will be faded out. +The volume the music will be played at. --- -**var loop = true** +**var audio_bus = ""** -If true, the audio will loop, otherwise only play once. +The audio bus the music will be played at. --- -**var volume = 0.0** +**var loop = true** -The volume the music will be played at. +If true, the audio will loop, otherwise only play once. --- @@ -83,7 +83,7 @@ The volume the music will be played at. -**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** +**func [get_shortcode](#method-get_shortcode) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** @@ -93,7 +93,7 @@ The volume the music will be played at. -**func [get_bus_suggestions](#method-get_bus_suggestions) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** @@ -103,7 +103,7 @@ The volume the music will be played at. -**func [get_shortcode](#method-get_shortcode) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** @@ -113,7 +113,7 @@ The volume the music will be played at. -**func [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [get_bus_suggestions](#method-get_bus_suggestions) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** diff --git a/documentation/classes/class_dialogicnode_buttonsound.md b/documentation/classes/class_dialogicnode_buttonsound.md index 0790c7d..e9b618b 100644 --- a/documentation/classes/class_dialogicnode_buttonsound.md +++ b/documentation/classes/class_dialogicnode_buttonsound.md @@ -12,9 +12,9 @@ Node that is used for playing sound effects on hover/focus/press of sibling Dial ## Properties Name | Type | Default --- | --- | --- -[sound_focus](#property-sound_focus) | [AudioStream](https://docs.godotengine.org/en/latest/classes/class_audiostream.html#class-audiostream) | -[sound_hover](#property-sound_hover) | [AudioStream](https://docs.godotengine.org/en/latest/classes/class_audiostream.html#class-audiostream) | [sound_pressed](#property-sound_pressed) | [AudioStream](https://docs.godotengine.org/en/latest/classes/class_audiostream.html#class-audiostream) | +[sound_hover](#property-sound_hover) | [AudioStream](https://docs.godotengine.org/en/latest/classes/class_audiostream.html#class-audiostream) | +[sound_focus](#property-sound_focus) | [AudioStream](https://docs.godotengine.org/en/latest/classes/class_audiostream.html#class-audiostream) | --- ## Methods @@ -26,11 +26,11 @@ Returns | Method -**var sound_focus** +**var sound_pressed** -Sound to be played on focus. See for more. +Sound to be played if one of the sibling ChoiceButtons is pressed. If sibling ChoiceButton has a sound_pressed set, that is prioritized. --- @@ -46,11 +46,11 @@ Sound to be played on hover. See for more. -**var sound_pressed** +**var sound_focus** -Sound to be played if one of the sibling ChoiceButtons is pressed. If sibling ChoiceButton has a sound_pressed set, that is prioritized. +Sound to be played on focus. See for more. --- diff --git a/documentation/classes/class_dialogicnode_choicebutton.md b/documentation/classes/class_dialogicnode_choicebutton.md index 815f5ca..db2f7ec 100644 --- a/documentation/classes/class_dialogicnode_choicebutton.md +++ b/documentation/classes/class_dialogicnode_choicebutton.md @@ -18,10 +18,17 @@ If you don't set the `text_node`, the text will be set on this button instead. Name | Type | Default --- | --- | --- [choice_index](#property-choice_index) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `-1` -[sound_focus](#property-sound_focus) | [AudioStream](https://docs.godotengine.org/en/latest/classes/class_audiostream.html#class-audiostream) | -[sound_hover](#property-sound_hover) | [AudioStream](https://docs.godotengine.org/en/latest/classes/class_audiostream.html#class-audiostream) | [sound_pressed](#property-sound_pressed) | [AudioStream](https://docs.godotengine.org/en/latest/classes/class_audiostream.html#class-audiostream) | +[sound_hover](#property-sound_hover) | [AudioStream](https://docs.godotengine.org/en/latest/classes/class_audiostream.html#class-audiostream) | +[sound_focus](#property-sound_focus) | [AudioStream](https://docs.godotengine.org/en/latest/classes/class_audiostream.html#class-audiostream) | [text_node](#property-text_node) | [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) | +--- + +## Methods +Returns | Method +--- | --- +void | [set_choice_text](#method-set_choice_text) ( `new_text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +--- ## Property Descriptions @@ -36,11 +43,11 @@ Used to identify what choices to put on. If you leave it at -1, choices will be -**var sound_focus** +**var sound_pressed** -Can be set to play this sound when focused. Requires a sibling DialogicNode_ButtonSound node. +Can be set to play this sound when pressed. Requires a sibling DialogicNode_ButtonSound node. --- @@ -56,11 +63,11 @@ Can be set to play this sound when hovered. Requires a sibling DialogicNode_Butt -**var sound_pressed** +**var sound_focus** -Can be set to play this sound when pressed. Requires a sibling DialogicNode_ButtonSound node. +Can be set to play this sound when focused. Requires a sibling DialogicNode_ButtonSound node. --- @@ -74,3 +81,15 @@ If set, the text will be set on this node's `text` property instead. --- +## Method Descriptions + + + +**func [set_choice_text](#method-set_choice_text) ( `new_text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** + + + +Called when the text changes. + +--- + diff --git a/documentation/classes/class_dialogicnode_dialogtext.md b/documentation/classes/class_dialogicnode_dialogtext.md index a053f6a..30c8145 100644 --- a/documentation/classes/class_dialogicnode_dialogtext.md +++ b/documentation/classes/class_dialogicnode_dialogtext.md @@ -12,25 +12,25 @@ Dialogic node that can reveal text at a given (changeable speed). ## Properties Name | Type | Default --- | --- | --- -[active_speed](#property-active_speed) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `0.01` -[alignment](#property-alignment) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `0` -[base_visible_characters](#property-base_visible_characters) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `0` [enabled](#property-enabled) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `true` +[alignment](#property-alignment) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `0` +[textbox_root](#property-textbox_root) | [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) | [hide_when_empty](#property-hide_when_empty) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` +[start_hidden](#property-start_hidden) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `true` [revealing](#property-revealing) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` +[base_visible_characters](#property-base_visible_characters) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `0` +[active_speed](#property-active_speed) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `0.01` [speed_counter](#property-speed_counter) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `0.0` -[start_hidden](#property-start_hidden) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `true` -[textbox_root](#property-textbox_root) | [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) | --- ## Methods Returns | Method --- | --- +void | [reveal_text](#method-reveal_text) ( `_text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `keep_previous`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) +void | [set_speed](#method-set_speed) ( `delay_per_character`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) ) void | [continue_reveal](#method-continue_reveal) ( ) void | [finish_text](#method-finish_text) ( ) void | [on_gui_input](#method-on_gui_input) ( `event`: [InputEvent](https://docs.godotengine.org/en/latest/classes/class_inputevent.html#class-inputevent) ) -void | [reveal_text](#method-reveal_text) ( `_text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `keep_previous`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) -void | [set_speed](#method-set_speed) ( `delay_per_character`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) ) --- ## Constants @@ -64,7 +64,7 @@ Returns | Method ## Signals -**signal [continued_revealing_text](#signal-continued_revealing_text) ( `new_character`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) )** +**signal [started_revealing_text](#signal-started_revealing_text) ( )** @@ -74,7 +74,7 @@ Returns | Method -**signal [finished_revealing_text](#signal-finished_revealing_text) ( )** +**signal [continued_revealing_text](#signal-continued_revealing_text) ( `new_character`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) )** @@ -84,7 +84,7 @@ Returns | Method -**signal [started_revealing_text](#signal-started_revealing_text) ( )** +**signal [finished_revealing_text](#signal-finished_revealing_text) ( )** @@ -96,7 +96,7 @@ Returns | Method -**var active_speed = 0.01** +**var enabled = true** @@ -116,7 +116,7 @@ Returns | Method -**var base_visible_characters = 0** +**var textbox_root = ** @@ -126,7 +126,7 @@ Returns | Method -**var enabled = true** +**var hide_when_empty = false** @@ -136,7 +136,7 @@ Returns | Method -**var hide_when_empty = false** +**var start_hidden = true** @@ -156,7 +156,7 @@ Returns | Method -**var speed_counter = 0.0** +**var base_visible_characters = 0** @@ -166,7 +166,7 @@ Returns | Method -**var start_hidden = true** +**var active_speed = 0.01** @@ -176,7 +176,7 @@ Returns | Method -**var textbox_root = ** +**var speed_counter = 0.0** @@ -188,51 +188,51 @@ Returns | Method -**func [continue_reveal](#method-continue_reveal) ( ) ⇒ void** +**func [reveal_text](#method-reveal_text) ( `_text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `keep_previous`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ void** -Reveals one additional character. + *No description available.* --- -**func [finish_text](#method-finish_text) ( ) ⇒ void** +**func [set_speed](#method-set_speed) ( `delay_per_character`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) ) ⇒ void** -Reveals the entire text instantly. + *No description available.* --- -**func [on_gui_input](#method-on_gui_input) ( `event`: [InputEvent](https://docs.godotengine.org/en/latest/classes/class_inputevent.html#class-inputevent) ) ⇒ void** +**func [continue_reveal](#method-continue_reveal) ( ) ⇒ void** -Handle mouse input +Reveals one additional character. --- -**func [reveal_text](#method-reveal_text) ( `_text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `keep_previous`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ void** +**func [finish_text](#method-finish_text) ( ) ⇒ void** - *No description available.* +Reveals the entire text instantly. --- -**func [set_speed](#method-set_speed) ( `delay_per_character`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) ) ⇒ void** +**func [on_gui_input](#method-on_gui_input) ( `event`: [InputEvent](https://docs.godotengine.org/en/latest/classes/class_inputevent.html#class-inputevent) ) ⇒ void** - *No description available.* +Handle mouse input --- diff --git a/documentation/classes/class_dialogicnode_nextindicator.md b/documentation/classes/class_dialogicnode_nextindicator.md index 519e7c7..fe24217 100644 --- a/documentation/classes/class_dialogicnode_nextindicator.md +++ b/documentation/classes/class_dialogicnode_nextindicator.md @@ -12,12 +12,12 @@ Node that is shown when the text is fully revealed. The default implementation a ## Properties Name | Type | Default --- | --- | --- -[animation](#property-animation) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `0` [enabled](#property-enabled) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `true` -[show_on_autoadvance](#property-show_on_autoadvance) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` [show_on_questions](#property-show_on_questions) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` -[texture](#property-texture) | [Texture2D](https://docs.godotengine.org/en/latest/classes/class_texture2d.html#class-texture2d) | +[show_on_autoadvance](#property-show_on_autoadvance) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` +[animation](#property-animation) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `0` [texture_rect](#property-texture_rect) | [TextureRect](https://docs.godotengine.org/en/latest/classes/class_texturerect.html#class-texturerect) | +[texture](#property-texture) | [Texture2D](https://docs.godotengine.org/en/latest/classes/class_texture2d.html#class-texture2d) | [texture_size](#property-texture_size) | [Vector2](https://docs.godotengine.org/en/latest/classes/class_vector2.html#class-vector2) | `Vector2(32, 32)` [tween](#property-tween) | [Tween](https://docs.godotengine.org/en/latest/classes/class_tween.html#class-tween) | --- @@ -25,37 +25,45 @@ Name | Type | Default ## Methods Returns | Method --- | --- -void | [play_animation](#method-play_animation) ( `animation`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int), `time`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) ) +void | [play_animation](#method-play_animation) ( `current_animation`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int), `time`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) ) --- -## Property Descriptions - +## Constants -**var animation = 0** +**const BOUNCE = 0** -What animation should the indicator do. + *No description available.* --- +**const BLINK = 1** -**var enabled = true** + + + *No description available.* + +--- + + +**const NONE = 2** *No description available.* --- +## Property Descriptions -**var show_on_autoadvance = false** +**var enabled = true** -If true the next indicator will be shown even if dialogic will autocontinue. + *No description available.* --- @@ -71,11 +79,21 @@ If true the next indicator will also be shown if the text is a question. -**var texture = ** +**var show_on_autoadvance = false** -Set the image to use as the indicator. +If true the next indicator will be shown even if dialogic will autocontinue. + +--- + + + +**var animation = 0** + + + +What animation should the indicator do. --- @@ -91,6 +109,16 @@ Set the image to use as the indicator. +**var texture = ** + + + +Set the image to use as the indicator. + +--- + + + **var texture_size = Vector2(32, 32)** @@ -113,7 +141,7 @@ Set the image to use as the indicator. -**func [play_animation](#method-play_animation) ( `animation`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int), `time`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) ) ⇒ void** +**func [play_animation](#method-play_animation) ( `current_animation`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int), `time`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) ) ⇒ void** diff --git a/documentation/classes/class_dialogicnode_portraitcontainer.md b/documentation/classes/class_dialogicnode_portraitcontainer.md index 66beef6..b030778 100644 --- a/documentation/classes/class_dialogicnode_portraitcontainer.md +++ b/documentation/classes/class_dialogicnode_portraitcontainer.md @@ -8,31 +8,35 @@ # DialogicNode_PortraitContainer **Inherits:** [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control) -Node that defines a position for dialogic portraits and how to display portrait at that position. +Node that defines a position for dialogic portraits and how to display portraits at that position. ## Properties Name | Type | Default --- | --- | --- +[mode](#property-mode) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `0` +[container_ids](#property-container_ids) | [PackedStringArray](https://docs.godotengine.org/en/latest/classes/class_packedstringarray.html#class-packedstringarray) | `[...]` +[portrait_prefix](#property-portrait_prefix) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` +[size_mode](#property-size_mode) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `3` +[mirrored](#property-mirrored) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` +[origin_anchor](#property-origin_anchor) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `7` +[origin_offset](#property-origin_offset) | [Vector2](https://docs.godotengine.org/en/latest/classes/class_vector2.html#class-vector2) | `Vector2(0, 0)` +[pivot_mode](#property-pivot_mode) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `0` +[pivot_value](#property-pivot_value) | [Vector2](https://docs.godotengine.org/en/latest/classes/class_vector2.html#class-vector2) | `Vector2(0, 0)` [debug_character](#property-debug_character) | [DialogicCharacter](class_dialogiccharacter.md) | `null` -[debug_character_holder_node](#property-debug_character_holder_node) | [Node2D](https://docs.godotengine.org/en/latest/classes/class_node2d.html#class-node2d) | `null` [debug_character_portrait](#property-debug_character_portrait) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` +[debug_character_holder_node](#property-debug_character_holder_node) | [Node2D](https://docs.godotengine.org/en/latest/classes/class_node2d.html#class-node2d) | `null` [debug_character_scene_node](#property-debug_character_scene_node) | [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) | `null` [debug_origin](#property-debug_origin) | [Sprite2D](https://docs.godotengine.org/en/latest/classes/class_sprite2d.html#class-sprite2d) | `null` -[default_debug_character](#property-default_debug_character) | [Resource](https://docs.godotengine.org/en/latest/classes/class_resource.html#class-resource) | -[default_portrait_scene](#property-default_portrait_scene) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | -[mirrored](#property-mirrored) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` -[mode](#property-mode) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `0` -[origin_anchor](#property-origin_anchor) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `7` -[origin_offset](#property-origin_offset) | [Vector2](https://docs.godotengine.org/en/latest/classes/class_vector2.html#class-vector2) | `Vector2(0, 0)` -[portrait_prefix](#property-portrait_prefix) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` -[position_index](#property-position_index) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `0` -[size_mode](#property-size_mode) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `3` +[default_portrait_scene](#property-default_portrait_scene) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `path_join(...)` +[default_debug_character](#property-default_debug_character) | [Resource](https://docs.godotengine.org/en/latest/classes/class_resource.html#class-resource) | `load(...)` +[ignore_resize](#property-ignore_resize) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` --- ## Methods Returns | Method --- | --- -[Rect2](https://docs.godotengine.org/en/latest/classes/class_rect2.html#class-rect2) | [get_local_portrait_transform](#method-get_local_portrait_transform) ( `portrait_rect`: [Rect2](https://docs.godotengine.org/en/latest/classes/class_rect2.html#class-rect2), `character_scale`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `1.0` ) void | [update_portrait_transforms](#method-update_portrait_transforms) ( ) +[Rect2](https://docs.godotengine.org/en/latest/classes/class_rect2.html#class-rect2) | [get_local_portrait_transform](#method-get_local_portrait_transform) ( `portrait_rect`: [Rect2](https://docs.godotengine.org/en/latest/classes/class_rect2.html#class-rect2), `character_scale`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `1.0` ) +[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_container](#method-is_container) ( `id`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) --- ## Constants @@ -170,21 +174,18 @@ Returns | Method *No description available.* --- -## Property Descriptions - -**var debug_character = null** +**const AT_ORIGIN = 0** -A character that will be displayed in the editor, useful for getting the right size. + *No description available.* --- - -**var debug_character_holder_node = null** +**const PERCENTAGE = 1** @@ -193,18 +194,18 @@ A character that will be displayed in the editor, useful for getting the right s --- - -**var debug_character_portrait = ""** +**const PIXELS = 2** *No description available.* --- +## Property Descriptions -**var debug_character_scene_node = null** +**var mode = 0** @@ -214,31 +215,31 @@ A character that will be displayed in the editor, useful for getting the right s -**var debug_origin = null** +**var container_ids = [...]** - *No description available.* +The position this node corresponds to. --- -**var default_debug_character = ** +**var portrait_prefix = ""** - *No description available.* +Can be used to use a different portrait. E.g. "Faces/" would mean instead of "happy" it will use portrait "Faces/happy" --- -**var default_portrait_scene = ** +**var size_mode = 3** - *No description available.* +Defines how to affect the scale of the portrait --- @@ -254,7 +255,57 @@ If true, portraits will be mirrored in this position. -**var mode = 0** +**var origin_anchor = 7** + + + +The portrait will be placed relative to this point in the container. + +--- + + + +**var origin_offset = Vector2(0, 0)** + + + +An offset to apply to the origin. Rarely useful. + +--- + + + +**var pivot_mode = 0** + + + +Usually you want to rotate or scale around the portrait origin. For the moments where that is not the case, set the mode to PERCENTAGE or PIXELS and use `pivot_value`. + +--- + + + +**var pivot_value = Vector2(0, 0)** + + + +Only has an effect when `pivot_mode` is not AT_ORIGIN. Meaning depends on whether `pivot_mode` is PERCENTAGE or PIXELS. + +--- + + + +**var debug_character = null** + + + +A character that will be displayed in the editor, useful for getting the right size. + +--- + + + +**var debug_character_portrait = ""** @@ -264,51 +315,61 @@ If true, portraits will be mirrored in this position. -**var origin_anchor = 7** +**var debug_character_holder_node = null** -The portrait will be placed relative to this point in the container. + *No description available.* --- -**var origin_offset = Vector2(0, 0)** +**var debug_character_scene_node = null** -An offset to apply to the origin. Rarely useful. + *No description available.* --- -**var portrait_prefix = ""** +**var debug_origin = null** -Can be used to use a different portrait. E.g. "Faces/" would mean instead of "happy" it will use portrait "Faces/happy" + *No description available.* --- -**var position_index = 0** +**var default_portrait_scene = path_join(...)** -The position this node corresponds to. + *No description available.* --- -**var size_mode = 3** +**var default_debug_character = load(...)** -Defines how to affect the scale of the portrait + *No description available.* + +--- + + + +**var ignore_resize = false** + + + + *No description available.* --- @@ -316,6 +377,16 @@ Defines how to affect the scale of the portrait +**func [update_portrait_transforms](#method-update_portrait_transforms) ( ) ⇒ void** + + + + *No description available.* + +--- + + + **func [get_local_portrait_transform](#method-get_local_portrait_transform) ( `portrait_rect`: [Rect2](https://docs.godotengine.org/en/latest/classes/class_rect2.html#class-rect2), `character_scale`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `1.0` ) ⇒ [Rect2](https://docs.godotengine.org/en/latest/classes/class_rect2.html#class-rect2)** @@ -326,7 +397,7 @@ Returns a Rect2 with the position as the position and the scale as the size. -**func [update_portrait_transforms](#method-update_portrait_transforms) ( ) ⇒ void** +**func [is_container](#method-is_container) ( `id`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** diff --git a/documentation/classes/class_dialogicnode_textbubble.md b/documentation/classes/class_dialogicnode_textbubble.md deleted file mode 100644 index 724d815..0000000 --- a/documentation/classes/class_dialogicnode_textbubble.md +++ /dev/null @@ -1,200 +0,0 @@ - -
-
DialogicNode_TextBubble
-
- -*This contains the source code documentation of the class `DialogicNode_TextBubble`.* - -# DialogicNode_TextBubble -**Inherits:** [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control) - - -## Properties -Name | Type | Default ---- | --- | --- -[base_direction](#property-base_direction) | [Vector2](https://docs.godotengine.org/en/latest/classes/class_vector2.html#class-vector2) | -[base_position](#property-base_position) | [Vector2](https://docs.godotengine.org/en/latest/classes/class_vector2.html#class-vector2) | `Vector2(0, 0)` -[bubble_rect](#property-bubble_rect) | [Rect2](https://docs.godotengine.org/en/latest/classes/class_rect2.html#class-rect2) | `Rect2(0, 0, 2, 2)` -[character](#property-character) | [DialogicCharacter](class_dialogiccharacter.md) | `null` -[max_width](#property-max_width) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `300` -[padding](#property-padding) | [Vector2](https://docs.godotengine.org/en/latest/classes/class_vector2.html#class-vector2) | `Vector2(0, 0)` -[safe_zone](#property-safe_zone) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `50.0` -[speaker_node](#property-speaker_node) | [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) | `null` ---- - -## Methods -Returns | Method ---- | --- -void | [close](#method-close) ( ) -[Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control) | [get_bubble](#method-get_bubble) ( ) -[Container](https://docs.godotengine.org/en/latest/classes/class_container.html#class-container) | [get_choice_container](#method-get_choice_container) ( ) -[DialogicNode_DialogText](class_dialogicnode_dialogtext.md) | [get_dialog_text](#method-get_dialog_text) ( ) -[DialogicNode_NameLabel](class_dialogicnode_namelabel.md) | [get_name_label](#method-get_name_label) ( ) -[PanelContainer](https://docs.godotengine.org/en/latest/classes/class_panelcontainer.html#class-panelcontainer) | [get_name_label_panel](#method-get_name_label_panel) ( ) -[Line2D](https://docs.godotengine.org/en/latest/classes/class_line2d.html#class-line2d) | [get_tail](#method-get_tail) ( ) -void | [open](#method-open) ( ) ---- -## Property Descriptions - - - -**var base_direction = ** - - - - *No description available.* - ---- - - - -**var base_position = Vector2(0, 0)** - - - - *No description available.* - ---- - - - -**var bubble_rect = Rect2(0, 0, 2, 2)** - - - - *No description available.* - ---- - - - -**var character = null** - - - - *No description available.* - ---- - - - -**var max_width = 300** - - - - *No description available.* - ---- - - - -**var padding = Vector2(0, 0)** - - - - *No description available.* - ---- - - - -**var safe_zone = 50.0** - - - - *No description available.* - ---- - - - -**var speaker_node = null** - - - - *No description available.* - ---- - -## Method Descriptions - - - -**func [close](#method-close) ( ) ⇒ void** - - - - *No description available.* - ---- - - - -**func [get_bubble](#method-get_bubble) ( ) ⇒ [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control)** - - - - *No description available.* - ---- - - - -**func [get_choice_container](#method-get_choice_container) ( ) ⇒ [Container](https://docs.godotengine.org/en/latest/classes/class_container.html#class-container)** - - - - *No description available.* - ---- - - - -**func [get_dialog_text](#method-get_dialog_text) ( ) ⇒ [DialogicNode_DialogText](class_dialogicnode_dialogtext.md)** - - - - *No description available.* - ---- - - - -**func [get_name_label](#method-get_name_label) ( ) ⇒ [DialogicNode_NameLabel](class_dialogicnode_namelabel.md)** - - - - *No description available.* - ---- - - - -**func [get_name_label_panel](#method-get_name_label_panel) ( ) ⇒ [PanelContainer](https://docs.godotengine.org/en/latest/classes/class_panelcontainer.html#class-panelcontainer)** - - - - *No description available.* - ---- - - - -**func [get_tail](#method-get_tail) ( ) ⇒ [Line2D](https://docs.godotengine.org/en/latest/classes/class_line2d.html#class-line2d)** - - - - *No description available.* - ---- - - - -**func [open](#method-open) ( ) ⇒ void** - - - - *No description available.* - ---- - diff --git a/documentation/classes/class_dialogicnode_textinput.md b/documentation/classes/class_dialogicnode_textinput.md index 4cbcbf1..7e6febe 100644 --- a/documentation/classes/class_dialogicnode_textinput.md +++ b/documentation/classes/class_dialogicnode_textinput.md @@ -12,48 +12,48 @@ Node that will show when a text input field is reached. Should be connected to a ## Properties Name | Type | Default --- | --- | --- -[confirmation_button](#property-confirmation_button) | [NodePath](https://docs.godotengine.org/en/latest/classes/class_nodepath.html#class-nodepath) | [input_line_edit](#property-input_line_edit) | [NodePath](https://docs.godotengine.org/en/latest/classes/class_nodepath.html#class-nodepath) | [text_label](#property-text_label) | [NodePath](https://docs.godotengine.org/en/latest/classes/class_nodepath.html#class-nodepath) | +[confirmation_button](#property-confirmation_button) | [NodePath](https://docs.godotengine.org/en/latest/classes/class_nodepath.html#class-nodepath) | --- ## Methods Returns | Method --- | --- -void | [set_allow_empty](#method-set_allow_empty) ( `boolean`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) ) -void | [set_default](#method-set_default) ( `default`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -void | [set_placeholder](#method-set_placeholder) ( `placeholder`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) void | [set_text](#method-set_text) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +void | [set_placeholder](#method-set_placeholder) ( `placeholder`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +void | [set_default](#method-set_default) ( `default`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +void | [set_allow_empty](#method-set_allow_empty) ( `boolean`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) ) --- ## Property Descriptions -**var confirmation_button** +**var input_line_edit** -The Button to use. +The LineEdit to use. --- -**var input_line_edit** +**var text_label** -The LineEdit to use. +The Label to use. --- -**var text_label** +**var confirmation_button** -The Label to use. +The Button to use. --- @@ -61,7 +61,7 @@ The Label to use. -**func [set_allow_empty](#method-set_allow_empty) ( `boolean`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) ) ⇒ void** +**func [set_text](#method-set_text) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** @@ -71,7 +71,7 @@ The Label to use. -**func [set_default](#method-set_default) ( `default`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** +**func [set_placeholder](#method-set_placeholder) ( `placeholder`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** @@ -81,7 +81,7 @@ The Label to use. -**func [set_placeholder](#method-set_placeholder) ( `placeholder`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** +**func [set_default](#method-set_default) ( `default`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** @@ -91,7 +91,7 @@ The Label to use. -**func [set_text](#method-set_text) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** +**func [set_allow_empty](#method-set_allow_empty) ( `boolean`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) ) ⇒ void** diff --git a/documentation/classes/class_dialogicnode_typesounds.md b/documentation/classes/class_dialogicnode_typesounds.md index 082271c..6811e8b 100644 --- a/documentation/classes/class_dialogicnode_typesounds.md +++ b/documentation/classes/class_dialogicnode_typesounds.md @@ -12,19 +12,19 @@ Node that allows playing sounds when text characters are revealed. Should be the ## Properties Name | Type | Default --- | --- | --- -[RNG](#property-rng) | [RandomNumberGenerator](https://docs.godotengine.org/en/latest/classes/class_randomnumbergenerator.html#class-randomnumbergenerator) | -[base_pitch](#property-base_pitch) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | -[base_volume](#property-base_volume) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | -[characters_since_last_sound](#property-characters_since_last_sound) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `0` -[current_overwrite_data](#property-current_overwrite_data) | [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [enabled](#property-enabled) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `true` -[end_sound](#property-end_sound) | [AudioStream](https://docs.godotengine.org/en/latest/classes/class_audiostream.html#class-audiostream) | -[ignore_characters](#property-ignore_characters) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `" .,"` [mode](#property-mode) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `0` -[pitch_variance](#property-pitch_variance) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `0.0` +[sounds](#property-sounds) | [AudioStream[]](https://docs.godotengine.org/en/latest/classes/class_audiostream.html#class-audiostream) | `[]` +[end_sound](#property-end_sound) | [AudioStream](https://docs.godotengine.org/en/latest/classes/class_audiostream.html#class-audiostream) | [play_every_character](#property-play_every_character) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `1` -[sounds](#property-sounds) | [AudioStream[]](https://docs.godotengine.org/en/latest/classes/class_audiostream.html#class-audiostream) | +[pitch_variance](#property-pitch_variance) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `0.0` [volume_variance](#property-volume_variance) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `0.0` +[ignore_characters](#property-ignore_characters) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `" .,"` +[characters_since_last_sound](#property-characters_since_last_sound) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `0` +[base_pitch](#property-base_pitch) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `pitch_scale` +[base_volume](#property-base_volume) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `volume_db` +[RNG](#property-rng) | [RandomNumberGenerator](https://docs.godotengine.org/en/latest/classes/class_randomnumbergenerator.html#class-randomnumbergenerator) | `new()` +[current_overwrite_data](#property-current_overwrite_data) | [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | `{}` --- ## Methods @@ -65,71 +65,71 @@ Returns | Method -**var RNG = ** +**var enabled = true** - *No description available.* +Usefull if you want to change the sounds of different node's sounds --- -**var base_pitch = ** +**var mode = 0** - *No description available.* +If true, interrupts the current sound to play a new one --- -**var base_volume = ** +**var sounds = []** - *No description available.* +Array of sounds. Will pick a random one each time. --- -**var characters_since_last_sound = 0** +**var end_sound** - *No description available.* +A sound to be played as the last sound. --- -**var current_overwrite_data = ** +**var play_every_character = 1** - *No description available.* +Determines how many characters are between each sound. Default is 1 for playing it every character. --- -**var enabled = true** +**var pitch_variance = 0.0** -Usefull if you want to change the sounds of different node's sounds +Allows changing the pitch by a random value from (pitch - pitch_variance) to (pitch + pitch_variance) --- -**var end_sound** +**var volume_variance = 0.0** -A sound to be played as the last sound. +Allows changing the volume by a random value from (volume - volume_variance) to (volume + volume_variance) --- @@ -145,51 +145,51 @@ Characters that don't increase the 'characters_since_last_sound' variable, usefu -**var mode = 0** +**var characters_since_last_sound = 0** -If true, interrupts the current sound to play a new one + *No description available.* --- -**var pitch_variance = 0.0** +**var base_pitch = pitch_scale** -Allows changing the pitch by a random value from (pitch - pitch_variance) to (pitch + pitch_variance) + *No description available.* --- -**var play_every_character = 1** +**var base_volume = volume_db** -Determines how many characters are between each sound. Default is 1 for playing it every character. + *No description available.* --- -**var sounds = ** +**var RNG = new()** -Array of sounds. Will pick a random one each time. + *No description available.* --- -**var volume_variance = 0.0** +**var current_overwrite_data = {}** -Allows changing the volume by a random value from (volume - volume_variance) to (volume + volume_variance) + *No description available.* --- diff --git a/documentation/classes/class_dialogicportraitanimationutil.md b/documentation/classes/class_dialogicportraitanimationutil.md new file mode 100644 index 0000000..ee0836e --- /dev/null +++ b/documentation/classes/class_dialogicportraitanimationutil.md @@ -0,0 +1,98 @@ + +
+
DialogicPortraitAnimationUtil
+
+ +*This contains the source code documentation of the class `DialogicPortraitAnimationUtil`.* + +# DialogicPortraitAnimationUtil +**Inherits:** [RefCounted](https://docs.godotengine.org/en/latest/classes/class_refcounted.html#class-refcounted) + + +--- + +## Methods +Returns | Method +--- | --- +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [guess_animation](#method-guess_animation) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `type`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `-1` ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_portrait_animations_filtered](#method-get_portrait_animations_filtered) ( `type`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `-1` ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_suggestions](#method-get_suggestions) ( `_search_text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `current_value`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `empty_text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `"Default"`, `action`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `-1` ) +--- +## Constants + + +**const ALL = -1** + + + + *No description available.* + +--- + + +**const IN = 1** + + + + *No description available.* + +--- + + +**const OUT = 2** + + + + *No description available.* + +--- + + +**const ACTION = 3** + + + + *No description available.* + +--- + + +**const CROSSFADE = 4** + + + + *No description available.* + +--- +## Method Descriptions + + + +**func [guess_animation](#method-guess_animation) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `type`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `-1` ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** + + + + *No description available.* + +--- + + + +**func [get_portrait_animations_filtered](#method-get_portrait_animations_filtered) ( `type`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `-1` ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** + + + + *No description available.* + +--- + + + +**func [get_suggestions](#method-get_suggestions) ( `_search_text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `current_value`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `empty_text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `"Default"`, `action`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `-1` ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** + + + + *No description available.* + +--- + diff --git a/documentation/classes/class_dialogicpositionevent.md b/documentation/classes/class_dialogicpositionevent.md deleted file mode 100644 index fd83cca..0000000 --- a/documentation/classes/class_dialogicpositionevent.md +++ /dev/null @@ -1,138 +0,0 @@ - -
-
DialogicPositionEvent
-
- -*This contains the source code documentation of the class `DialogicPositionEvent`.* - -# DialogicPositionEvent -**Inherits:** [DialogicEvent](class_dialogicevent.md) - -# Settings -## Properties -Name | Type | Default ---- | --- | --- -[action](#property-action) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `0` -[movement_time](#property-movement_time) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `0.0` -[position](#property-position) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `0` -[vector](#property-vector) | [Vector2](https://docs.godotengine.org/en/latest/classes/class_vector2.html#class-vector2) | `Vector2(0, 0)` ---- - -## Methods -Returns | Method ---- | --- -void | [build_event_editor](#method-build_event_editor) ( ) -[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_shortcode](#method-get_shortcode) ( ) -[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) ---- -## Constants - - -**const SET_RELATIVE = 0** - - - - *No description available.* - ---- - - -**const SET_ABSOLUTE = 1** - - - - *No description available.* - ---- - - -**const RESET = 2** - - - - *No description available.* - ---- - - -**const RESET_ALL = 3** - - - - *No description available.* - ---- -## Property Descriptions - - - -**var action = 0** - - - -The type of action: SetRelative, SetAbsolute, Reset, ResetAll - ---- - - - -**var movement_time = 0.0** - - - -The time the tweening will take. - ---- - - - -**var position = 0** - - - -The position that should be affected - ---- - - - -**var vector = Vector2(0, 0)** - - - -A vector representing a relative change or an absolute position (for SetRelative and SetAbsolute) - ---- - -## Method Descriptions - - - -**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** - - - - *No description available.* - ---- - - - -**func [get_shortcode](#method-get_shortcode) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** - - - - *No description available.* - ---- - - - -**func [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** - - - - *No description available.* - ---- - diff --git a/documentation/classes/class_dialogicresourceutil.md b/documentation/classes/class_dialogicresourceutil.md index 480b8d6..6a5042b 100644 --- a/documentation/classes/class_dialogicresourceutil.md +++ b/documentation/classes/class_dialogicresourceutil.md @@ -12,45 +12,46 @@ ## Properties Name | Type | Default --- | --- | --- -[event_cache](#property-event_cache) | [DialogicEvent[]](https://docs.godotengine.org/en/latest/classes/class_dialogicevent.html#class-dialogicevent) | -[label_cache](#property-label_cache) | [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | -[special_resources](#property-special_resources) | [Dictionary[]](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | +[label_cache](#property-label_cache) | [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | `{}` +[event_cache](#property-event_cache) | [DialogicEvent[]](https://docs.godotengine.org/en/latest/classes/class_dialogicevent.html#class-dialogicevent) | `[]` +[special_resources](#property-special_resources) | [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | `{}` --- ## Methods Returns | Method --- | --- +void | [update](#method-update) ( ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_directory](#method-get_directory) ( `extension`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +void | [set_directory](#method-set_directory) ( `extension`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `directory`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) ) +void | [update_directory](#method-update_directory) ( `extension`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [add_resource_to_directory](#method-add_resource_to_directory) ( `file_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `directory`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) ) -void | [change_resource_path](#method-change_resource_path) ( `old_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `new_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_unique_identifier](#method-get_unique_identifier) ( `file_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[Resource](https://docs.godotengine.org/en/latest/classes/class_resource.html#class-resource) | [get_resource_from_identifier](#method-get_resource_from_identifier) ( `identifier`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `extension`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) void | [change_unique_identifier](#method-change_unique_identifier) ( `file_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `new_identifier`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_character_directory](#method-get_character_directory) ( ) -[DialogicCharacter](class_dialogiccharacter.md) | [get_character_resource](#method-get_character_resource) ( `character_identifier`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_directory](#method-get_directory) ( `extension`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | [get_event_cache](#method-get_event_cache) ( ) +void | [change_resource_path](#method-change_resource_path) ( `old_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `new_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +void | [remove_resource](#method-remove_resource) ( `file_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_identifier_unused](#method-is_identifier_unused) ( `extension`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `identifier`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_label_cache](#method-get_label_cache) ( ) -[Resource](https://docs.godotengine.org/en/latest/classes/class_resource.html#class-resource) | [get_resource_from_identifier](#method-get_resource_from_identifier) ( `identifier`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `extension`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +void | [set_label_cache](#method-set_label_cache) ( `cache`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) ) +void | [update_label_cache](#method-update_label_cache) ( ) +[Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | [get_event_cache](#method-get_event_cache) ( ) +[Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | [update_event_cache](#method-update_event_cache) ( ) +void | [update_special_resources](#method-update_special_resources) ( ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [list_special_resources](#method-list_special_resources) ( `type`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `filter`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) = `{}` ) +[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [match_resource_filter](#method-match_resource_filter) ( `dict`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary), `filter`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [guess_special_resource](#method-guess_special_resource) ( `type`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `default`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) = `{}`, `filter`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) = `{}`, `ignores`: [PackedStringArray](https://docs.godotengine.org/en/latest/classes/class_packedstringarray.html#class-packedstringarray) = `[]` ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_character_directory](#method-get_character_directory) ( ) [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_timeline_directory](#method-get_timeline_directory) ( ) [DialogicTimeline](class_dialogictimeline.md) | [get_timeline_resource](#method-get_timeline_resource) ( `timeline_identifier`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_unique_identifier](#method-get_unique_identifier) ( `file_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [guess_special_resource](#method-guess_special_resource) ( `type`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `default`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) -[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_identifier_unused](#method-is_identifier_unused) ( `extension`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `identifier`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[DialogicCharacter](class_dialogiccharacter.md) | [get_character_resource](#method-get_character_resource) ( `character_identifier`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | [list_resources_of_type](#method-list_resources_of_type) ( `extension`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | [list_special_resources_of_type](#method-list_special_resources_of_type) ( `type`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -void | [remove_resource](#method-remove_resource) ( `file_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | [scan_folder](#method-scan_folder) ( `path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `extension`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -void | [set_directory](#method-set_directory) ( `extension`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `directory`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) ) -void | [set_label_cache](#method-set_label_cache) ( `cache`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) ) -void | [update](#method-update) ( ) -void | [update_directory](#method-update_directory) ( `extension`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | [update_event_cache](#method-update_event_cache) ( ) -void | [update_label_cache](#method-update_label_cache) ( ) -void | [update_special_resources](#method-update_special_resources) ( ) --- ## Property Descriptions -**var event_cache = ** +**var label_cache = {}** @@ -60,7 +61,7 @@ Returns | Method -**var label_cache = ** +**var event_cache = []** @@ -70,7 +71,7 @@ Returns | Method -**var special_resources = ** +**var special_resources = {}** @@ -82,7 +83,7 @@ Returns | Method -**func [add_resource_to_directory](#method-add_resource_to_directory) ( `file_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `directory`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [update](#method-update) ( ) ⇒ void** @@ -92,7 +93,7 @@ Returns | Method -**func [change_resource_path](#method-change_resource_path) ( `old_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `new_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** +**func [get_directory](#method-get_directory) ( `extension`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** @@ -102,7 +103,7 @@ Returns | Method -**func [change_unique_identifier](#method-change_unique_identifier) ( `file_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `new_identifier`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** +**func [set_directory](#method-set_directory) ( `extension`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `directory`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) ) ⇒ void** @@ -112,7 +113,7 @@ Returns | Method -**func [get_character_directory](#method-get_character_directory) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [update_directory](#method-update_directory) ( `extension`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** @@ -122,7 +123,7 @@ Returns | Method -**func [get_character_resource](#method-get_character_resource) ( `character_identifier`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [DialogicCharacter](class_dialogiccharacter.md)** +**func [add_resource_to_directory](#method-add_resource_to_directory) ( `file_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `directory`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** @@ -132,27 +133,27 @@ Returns | Method -**func [get_directory](#method-get_directory) ( `extension`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [get_unique_identifier](#method-get_unique_identifier) ( `file_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** - *No description available.* +Returns the unique identifier for the given resource path. Returns an empty string if no identifier was found. --- -**func [get_event_cache](#method-get_event_cache) ( ) ⇒ [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array)** +**func [get_resource_from_identifier](#method-get_resource_from_identifier) ( `identifier`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `extension`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Resource](https://docs.godotengine.org/en/latest/classes/class_resource.html#class-resource)** -Dialogic keeps a list that has each event once. This allows retrieval of that list. +Returns the resource associated with the given unique identifier. The expected extension is needed to use the right directory. --- -**func [get_label_cache](#method-get_label_cache) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [change_unique_identifier](#method-change_unique_identifier) ( `file_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `new_identifier`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** @@ -162,17 +163,17 @@ Dialogic keeps a list that has each event once. This allows retrieval of that li -**func [get_resource_from_identifier](#method-get_resource_from_identifier) ( `identifier`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `extension`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Resource](https://docs.godotengine.org/en/latest/classes/class_resource.html#class-resource)** +**func [change_resource_path](#method-change_resource_path) ( `old_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `new_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** -Returns the resource associated with the given unique identifier. The expected extension is needed to use the right directory. + *No description available.* --- -**func [get_timeline_directory](#method-get_timeline_directory) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [remove_resource](#method-remove_resource) ( `file_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** @@ -182,7 +183,7 @@ Returns the resource associated with the given unique identifier. The expected e -**func [get_timeline_resource](#method-get_timeline_resource) ( `timeline_identifier`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [DialogicTimeline](class_dialogictimeline.md)** +**func [is_identifier_unused](#method-is_identifier_unused) ( `extension`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `identifier`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** @@ -192,17 +193,17 @@ Returns the resource associated with the given unique identifier. The expected e -**func [get_unique_identifier](#method-get_unique_identifier) ( `file_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [get_label_cache](#method-get_label_cache) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** -Returns the unique identifier for the given resource path. Returns an empty string if no identifier was found. + *No description available.* --- -**func [guess_special_resource](#method-guess_special_resource) ( `type`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `default`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [set_label_cache](#method-set_label_cache) ( `cache`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) ) ⇒ void** @@ -212,7 +213,7 @@ Returns the unique identifier for the given resource path. Returns an empty stri -**func [is_identifier_unused](#method-is_identifier_unused) ( `extension`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `identifier`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [update_label_cache](#method-update_label_cache) ( ) ⇒ void** @@ -222,7 +223,17 @@ Returns the unique identifier for the given resource path. Returns an empty stri -**func [list_resources_of_type](#method-list_resources_of_type) ( `extension`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array)** +**func [get_event_cache](#method-get_event_cache) ( ) ⇒ [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array)** + + + +Dialogic keeps a list that has each event once. This allows retrieval of that list. + +--- + + + +**func [update_event_cache](#method-update_event_cache) ( ) ⇒ [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array)** @@ -232,7 +243,7 @@ Returns the unique identifier for the given resource path. Returns an empty stri -**func [list_special_resources_of_type](#method-list_special_resources_of_type) ( `type`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array)** +**func [update_special_resources](#method-update_special_resources) ( ) ⇒ void** @@ -242,7 +253,7 @@ Returns the unique identifier for the given resource path. Returns an empty stri -**func [remove_resource](#method-remove_resource) ( `file_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** +**func [list_special_resources](#method-list_special_resources) ( `type`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `filter`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) = `{}` ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** @@ -252,7 +263,7 @@ Returns the unique identifier for the given resource path. Returns an empty stri -**func [scan_folder](#method-scan_folder) ( `path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `extension`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array)** +**func [match_resource_filter](#method-match_resource_filter) ( `dict`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary), `filter`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** @@ -262,7 +273,7 @@ Returns the unique identifier for the given resource path. Returns an empty stri -**func [set_directory](#method-set_directory) ( `extension`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `directory`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) ) ⇒ void** +**func [guess_special_resource](#method-guess_special_resource) ( `type`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `default`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) = `{}`, `filter`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) = `{}`, `ignores`: [PackedStringArray](https://docs.godotengine.org/en/latest/classes/class_packedstringarray.html#class-packedstringarray) = `[]` ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** @@ -272,7 +283,7 @@ Returns the unique identifier for the given resource path. Returns an empty stri -**func [set_label_cache](#method-set_label_cache) ( `cache`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) ) ⇒ void** +**func [get_character_directory](#method-get_character_directory) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** @@ -282,7 +293,7 @@ Returns the unique identifier for the given resource path. Returns an empty stri -**func [update](#method-update) ( ) ⇒ void** +**func [get_timeline_directory](#method-get_timeline_directory) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** @@ -292,7 +303,7 @@ Returns the unique identifier for the given resource path. Returns an empty stri -**func [update_directory](#method-update_directory) ( `extension`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** +**func [get_timeline_resource](#method-get_timeline_resource) ( `timeline_identifier`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [DialogicTimeline](class_dialogictimeline.md)** @@ -302,7 +313,7 @@ Returns the unique identifier for the given resource path. Returns an empty stri -**func [update_event_cache](#method-update_event_cache) ( ) ⇒ [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array)** +**func [get_character_resource](#method-get_character_resource) ( `character_identifier`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [DialogicCharacter](class_dialogiccharacter.md)** @@ -312,7 +323,7 @@ Returns the unique identifier for the given resource path. Returns an empty stri -**func [update_label_cache](#method-update_label_cache) ( ) ⇒ void** +**func [list_resources_of_type](#method-list_resources_of_type) ( `extension`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array)** @@ -322,7 +333,7 @@ Returns the unique identifier for the given resource path. Returns an empty stri -**func [update_special_resources](#method-update_special_resources) ( ) ⇒ void** +**func [scan_folder](#method-scan_folder) ( `path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `extension`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array)** diff --git a/documentation/classes/class_dialogicreturnevent.md b/documentation/classes/class_dialogicreturnevent.md index c9a42d6..731e5bc 100644 --- a/documentation/classes/class_dialogicreturnevent.md +++ b/documentation/classes/class_dialogicreturnevent.md @@ -14,26 +14,26 @@ ## Methods Returns | Method --- | --- -void | [build_event_editor](#method-build_event_editor) ( ) -void | [from_text](#method-from_text) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_valid_event](#method-is_valid_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [to_text](#method-to_text) ( ) +void | [from_text](#method-from_text) ( `_string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_valid_event](#method-is_valid_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +void | [build_event_editor](#method-build_event_editor) ( ) --- ## Method Descriptions -**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** +**func [to_text](#method-to_text) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** - *No description available.* +############################################################################## SAVING/LOADING ############################################################################## --- -**func [from_text](#method-from_text) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** +**func [from_text](#method-from_text) ( `_string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** @@ -53,11 +53,11 @@ Returns | Method -**func [to_text](#method-to_text) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** -############################################################################## SAVING/LOADING ############################################################################## + *No description available.* --- diff --git a/documentation/classes/class_dialogicsaveevent.md b/documentation/classes/class_dialogicsaveevent.md index 847bc4e..5d363d4 100644 --- a/documentation/classes/class_dialogicsaveevent.md +++ b/documentation/classes/class_dialogicsaveevent.md @@ -18,9 +18,9 @@ Name | Type | Default ## Methods Returns | Method --- | --- -void | [build_event_editor](#method-build_event_editor) ( ) [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_shortcode](#method-get_shortcode) ( ) [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) +void | [build_event_editor](#method-build_event_editor) ( ) --- ## Property Descriptions @@ -38,7 +38,7 @@ The name of the slot to save to. Learn more in the saving subsystem. If empty, t -**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** +**func [get_shortcode](#method-get_shortcode) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** @@ -48,7 +48,7 @@ The name of the slot to save to. Learn more in the saving subsystem. If empty, t -**func [get_shortcode](#method-get_shortcode) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** @@ -58,7 +58,7 @@ The name of the slot to save to. Learn more in the saving subsystem. If empty, t -**func [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** diff --git a/documentation/classes/class_dialogicsettingevent.md b/documentation/classes/class_dialogicsettingevent.md index db9d34d..8778fc0 100644 --- a/documentation/classes/class_dialogicsettingevent.md +++ b/documentation/classes/class_dialogicsettingevent.md @@ -12,20 +12,20 @@ ## Properties Name | Type | Default --- | --- | --- -[mode](#property-mode) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `0` [name](#property-name) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` [value](#property-value) | [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) | `""` +[mode](#property-mode) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `0` --- ## Methods Returns | Method --- | --- -void | [build_event_editor](#method-build_event_editor) ( ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [to_text](#method-to_text) ( ) void | [from_text](#method-from_text) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_settings_suggestions](#method-get_settings_suggestions) ( `filter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_value_suggestions](#method-get_value_suggestions) ( `filter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_valid_event](#method-is_valid_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [to_text](#method-to_text) ( ) +void | [build_event_editor](#method-build_event_editor) ( ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_settings_suggestions](#method-get_settings_suggestions) ( `filter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_value_suggestions](#method-get_value_suggestions) ( `_filter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) --- ## Constants @@ -95,27 +95,27 @@ Returns | Method -**var mode = 0** +**var name = ""** - *No description available.* +The name of the setting to save to. --- -**var name = ""** +**var value = ""** -The name of the setting to save to. + *No description available.* --- -**var value = ""** +**var mode = 0** @@ -127,7 +127,7 @@ The name of the setting to save to. -**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** +**func [to_text](#method-to_text) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** @@ -147,7 +147,7 @@ The name of the setting to save to. -**func [get_settings_suggestions](#method-get_settings_suggestions) ( `filter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [is_valid_event](#method-is_valid_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** @@ -157,7 +157,7 @@ The name of the setting to save to. -**func [get_value_suggestions](#method-get_value_suggestions) ( `filter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** @@ -167,7 +167,7 @@ The name of the setting to save to. -**func [is_valid_event](#method-is_valid_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [get_settings_suggestions](#method-get_settings_suggestions) ( `filter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** @@ -177,7 +177,7 @@ The name of the setting to save to. -**func [to_text](#method-to_text) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [get_value_suggestions](#method-get_value_suggestions) ( `_filter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** diff --git a/documentation/classes/class_dialogicsidebar.md b/documentation/classes/class_dialogicsidebar.md new file mode 100644 index 0000000..7cc3735 --- /dev/null +++ b/documentation/classes/class_dialogicsidebar.md @@ -0,0 +1,225 @@ + +
+
DialogicSidebar
+
+ +*This contains the source code documentation of the class `DialogicSidebar`.* + +# DialogicSidebar +**Inherits:** [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control) + +############################################################################## RESOURCE LIST ############################################################################## +## Properties +Name | Type | Default +--- | --- | --- +[editors_manager](#property-editors_manager) | [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) | `get_parent()` +[resource_tree](#property-resource_tree) | [Tree](https://docs.godotengine.org/en/latest/classes/class_tree.html#class-tree) | +[current_resource_list](#property-current_resource_list) | [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | `[]` +[sort_mode](#property-sort_mode) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `0` +--- + +## Methods +Returns | Method +--- | --- +[PackedStringArray](https://docs.godotengine.org/en/latest/classes/class_packedstringarray.html#class-packedstringarray) | [clean_resource_list](#method-clean_resource_list) ( `resources_list`: [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) = `[]` ) +void | [update_resource_list](#method-update_resource_list) ( `resources_list`: [PackedStringArray](https://docs.godotengine.org/en/latest/classes/class_packedstringarray.html#class-packedstringarray) = `[]` ) +[TreeItem](https://docs.godotengine.org/en/latest/classes/class_treeitem.html#class-treeitem) | [add_item](#method-add_item) ( `item`: [DialogicSidebar.ResourceListItem](class_dialogicsidebar.resourcelistitem.md), `parent`: [TreeItem](https://docs.godotengine.org/en/latest/classes/class_treeitem.html#class-treeitem), `current_file`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) +[TreeItem](https://docs.godotengine.org/en/latest/classes/class_treeitem.html#class-treeitem) | [add_folder_item](#method-add_folder_item) ( `label`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `parent`: [TreeItem](https://docs.godotengine.org/en/latest/classes/class_treeitem.html#class-treeitem) ) +void | [set_unsaved_indicator](#method-set_unsaved_indicator) ( `saved`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true` ) +void | [update_content_list](#method-update_content_list) ( `list`: [PackedStringArray](https://docs.godotengine.org/en/latest/classes/class_packedstringarray.html#class-packedstringarray) ) +void | [remove_item_from_list](#method-remove_item_from_list) ( `item`: [TreeItem](https://docs.godotengine.org/en/latest/classes/class_treeitem.html#class-treeitem) ) +void | [edit_resource](#method-edit_resource) ( `resource_item`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) +--- +## Constants + + +**const TYPE = 0** + + + + *No description available.* + +--- + + +**const FOLDER = 1** + + + + *No description available.* + +--- + + +**const PATH = 2** + + + + *No description available.* + +--- + + +**const NONE = 3** + + + + *No description available.* + +--- + +## Signals + + +**signal [file_activated](#signal-file_activated) ( `file_path`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) )** + + + + *No description available.* + +--- + + + +**signal [content_item_activated](#signal-content_item_activated) ( `item_name`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) )** + + + + *No description available.* + +--- + + + +**signal [show_sidebar](#signal-show_sidebar) ( `show`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) )** + + + + *No description available.* + +--- + +## Property Descriptions + + + +**var editors_manager = get_parent()** + + + + *No description available.* + +--- + + + +**var resource_tree = ** + + + + *No description available.* + +--- + + + +**var current_resource_list = []** + + + + *No description available.* + +--- + + + +**var sort_mode = 0** + + + + *No description available.* + +--- + +## Method Descriptions + + + +**func [clean_resource_list](#method-clean_resource_list) ( `resources_list`: [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) = `[]` ) ⇒ [PackedStringArray](https://docs.godotengine.org/en/latest/classes/class_packedstringarray.html#class-packedstringarray)** + + + + *No description available.* + +--- + + + +**func [update_resource_list](#method-update_resource_list) ( `resources_list`: [PackedStringArray](https://docs.godotengine.org/en/latest/classes/class_packedstringarray.html#class-packedstringarray) = `[]` ) ⇒ void** + + + + *No description available.* + +--- + + + +**func [add_item](#method-add_item) ( `item`: [DialogicSidebar.ResourceListItem](class_dialogicsidebar.resourcelistitem.md), `parent`: [TreeItem](https://docs.godotengine.org/en/latest/classes/class_treeitem.html#class-treeitem), `current_file`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ [TreeItem](https://docs.godotengine.org/en/latest/classes/class_treeitem.html#class-treeitem)** + + + + *No description available.* + +--- + + + +**func [add_folder_item](#method-add_folder_item) ( `label`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `parent`: [TreeItem](https://docs.godotengine.org/en/latest/classes/class_treeitem.html#class-treeitem) ) ⇒ [TreeItem](https://docs.godotengine.org/en/latest/classes/class_treeitem.html#class-treeitem)** + + + + *No description available.* + +--- + + + +**func [set_unsaved_indicator](#method-set_unsaved_indicator) ( `saved`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true` ) ⇒ void** + + + + *No description available.* + +--- + + + +**func [update_content_list](#method-update_content_list) ( `list`: [PackedStringArray](https://docs.godotengine.org/en/latest/classes/class_packedstringarray.html#class-packedstringarray) ) ⇒ void** + + + + *No description available.* + +--- + + + +**func [remove_item_from_list](#method-remove_item_from_list) ( `item`: [TreeItem](https://docs.godotengine.org/en/latest/classes/class_treeitem.html#class-treeitem) ) ⇒ void** + + + + *No description available.* + +--- + + + +**func [edit_resource](#method-edit_resource) ( `resource_item`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) ⇒ void** + + + + *No description available.* + +--- + diff --git a/documentation/classes/class_dialogicsidebar.resourcelistitem.md b/documentation/classes/class_dialogicsidebar.resourcelistitem.md new file mode 100644 index 0000000..c1cca86 --- /dev/null +++ b/documentation/classes/class_dialogicsidebar.resourcelistitem.md @@ -0,0 +1,112 @@ + +
+
DialogicSidebar.ResourceListItem
+
+ +*This contains the source code documentation of the class `DialogicSidebar.ResourceListItem`.* + +# DialogicSidebar.ResourceListItem +**Inherits:** [Object](https://docs.godotengine.org/en/latest/classes/class_object.html#class-object) + + +## Properties +Name | Type | Default +--- | --- | --- +[text](#property-text) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | +[index](#property-index) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `-1` +[icon](#property-icon) | [Texture](https://docs.godotengine.org/en/latest/classes/class_texture.html#class-texture) | +[metadata](#property-metadata) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | +[tooltip](#property-tooltip) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | +--- + +## Methods +Returns | Method +--- | --- +void | [add_to_item_list](#method-add_to_item_list) ( `item_list`: [ItemList](https://docs.godotengine.org/en/latest/classes/class_itemlist.html#class-itemlist), `current_file`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_parent_directory](#method-get_parent_directory) ( ) +void | [current_file](#method-current_file) ( `sidebar`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `resource_list`: [ItemList](https://docs.godotengine.org/en/latest/classes/class_itemlist.html#class-itemlist), `current_file`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +--- +## Property Descriptions + + + +**var text** + + + + *No description available.* + +--- + + + +**var index = -1** + + + + *No description available.* + +--- + + + +**var icon** + + + + *No description available.* + +--- + + + +**var metadata** + + + + *No description available.* + +--- + + + +**var tooltip** + + + + *No description available.* + +--- + +## Method Descriptions + + + +**func [add_to_item_list](#method-add_to_item_list) ( `item_list`: [ItemList](https://docs.godotengine.org/en/latest/classes/class_itemlist.html#class-itemlist), `current_file`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** + + + + *No description available.* + +--- + + + +**func [get_parent_directory](#method-get_parent_directory) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** + + + + *No description available.* + +--- + + + +**func [current_file](#method-current_file) ( `sidebar`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `resource_list`: [ItemList](https://docs.godotengine.org/en/latest/classes/class_itemlist.html#class-itemlist), `current_file`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** + + + + *No description available.* + +--- + diff --git a/documentation/classes/class_dialogicsignalevent.md b/documentation/classes/class_dialogicsignalevent.md index 59c7c17..a8d81ee 100644 --- a/documentation/classes/class_dialogicsignalevent.md +++ b/documentation/classes/class_dialogicsignalevent.md @@ -12,16 +12,16 @@ ## Properties Name | Type | Default --- | --- | --- -[argument](#property-argument) | [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) | `""` [argument_type](#property-argument_type) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `0` +[argument](#property-argument) | [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) | `""` --- ## Methods Returns | Method --- | --- -void | [build_event_editor](#method-build_event_editor) ( ) [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_shortcode](#method-get_shortcode) ( ) [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) +void | [build_event_editor](#method-build_event_editor) ( ) --- ## Constants @@ -46,21 +46,21 @@ Returns | Method -**var argument = ""** +**var argument_type = 0** -The argument that will be provided with the signal. + *No description available.* --- -**var argument_type = 0** +**var argument = ""** - *No description available.* +The argument that will be provided with the signal. --- @@ -68,7 +68,7 @@ The argument that will be provided with the signal. -**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** +**func [get_shortcode](#method-get_shortcode) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** @@ -78,7 +78,7 @@ The argument that will be provided with the signal. -**func [get_shortcode](#method-get_shortcode) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** @@ -88,7 +88,7 @@ The argument that will be provided with the signal. -**func [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** diff --git a/documentation/classes/class_dialogicsoundevent.md b/documentation/classes/class_dialogicsoundevent.md index e722b8a..c5f8d81 100644 --- a/documentation/classes/class_dialogicsoundevent.md +++ b/documentation/classes/class_dialogicsoundevent.md @@ -12,59 +12,59 @@ ## Properties Name | Type | Default --- | --- | --- -[audio_bus](#property-audio_bus) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `"Master"` [file_path](#property-file_path) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` -[loop](#property-loop) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` [volume](#property-volume) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `0.0` +[audio_bus](#property-audio_bus) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` +[loop](#property-loop) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` --- ## Methods Returns | Method --- | --- -void | [build_event_editor](#method-build_event_editor) ( ) -[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_bus_suggestions](#method-get_bus_suggestions) ( ) [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_shortcode](#method-get_shortcode) ( ) [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) +void | [build_event_editor](#method-build_event_editor) ( ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_bus_suggestions](#method-get_bus_suggestions) ( ) --- ## Property Descriptions -**var audio_bus = "Master"** +**var file_path = ""** -The bus to play the sound on. +The path to the file to play. --- -**var file_path = ""** +**var volume = 0.0** -The path to the file to play. +The volume to play the sound at. --- -**var loop = false** +**var audio_bus = ""** -If true, the sound will loop infinitely. Not recommended (as there is no way to stop it). +The bus to play the sound on. --- -**var volume = 0.0** +**var loop = false** -The volume to play the sound at. +If true, the sound will loop infinitely. Not recommended (as there is no way to stop it). --- @@ -72,7 +72,7 @@ The volume to play the sound at. -**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** +**func [get_shortcode](#method-get_shortcode) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** @@ -82,7 +82,7 @@ The volume to play the sound at. -**func [get_bus_suggestions](#method-get_bus_suggestions) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** @@ -92,7 +92,7 @@ The volume to play the sound at. -**func [get_shortcode](#method-get_shortcode) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** @@ -102,7 +102,7 @@ The volume to play the sound at. -**func [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [get_bus_suggestions](#method-get_bus_suggestions) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** diff --git a/documentation/classes/class_dialogicstyle.md b/documentation/classes/class_dialogicstyle.md index 43de118..0f55992 100644 --- a/documentation/classes/class_dialogicstyle.md +++ b/documentation/classes/class_dialogicstyle.md @@ -12,40 +12,40 @@ A style represents a collection of layers and settings. A style can inherit from ## Properties Name | Type | Default --- | --- | --- -[base_overrides](#property-base_overrides) | [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | -[base_scene](#property-base_scene) | [PackedScene](https://docs.godotengine.org/en/latest/classes/class_packedscene.html#class-packedscene) | `null` -[inherits](#property-inherits) | [DialogicStyle](class_dialogicstyle.md) | `null` -[layers](#property-layers) | [DialogicStyleLayer[]](https://docs.godotengine.org/en/latest/classes/class_dialogicstylelayer.html#class-dialogicstylelayer) | [name](#property-name) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `"Style"` +[inherits](#property-inherits) | [DialogicStyle](class_dialogicstyle.md) | `null` +[base_scene](#property-base_scene) | [PackedScene](https://docs.godotengine.org/en/latest/classes/class_packedscene.html#class-packedscene) | `null` +[base_overrides](#property-base_overrides) | [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | `{}` +[layers](#property-layers) | [DialogicStyleLayer[]](https://docs.godotengine.org/en/latest/classes/class_dialogicstylelayer.html#class-dialogicstylelayer) | `[]` --- ## Methods Returns | Method --- | --- -void | [add_layer](#method-add_layer) ( `scene`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `overrides`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) = `` ) -[DialogicStyle](class_dialogicstyle.md) | [clone](#method-clone) ( ) -void | [delete_layer](#method-delete_layer) ( `layer_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) [PackedScene](https://docs.godotengine.org/en/latest/classes/class_packedscene.html#class-packedscene) | [get_base_scene](#method-get_base_scene) ( ) -[DialogicStyle](class_dialogicstyle.md) | [get_inheritance_root](#method-get_inheritance_root) ( ) +[PackedStringArray](https://docs.godotengine.org/en/latest/classes/class_packedstringarray.html#class-packedstringarray) | [get_layer_list](#method-get_layer_list) ( ) [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | [get_layer_count](#method-get_layer_count) ( ) [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_layer_info](#method-get_layer_info) ( `index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_layer_inherited_info](#method-get_layer_inherited_info) ( `index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int), `inherited_only`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) -[PackedStringArray](https://docs.godotengine.org/en/latest/classes/class_packedstringarray.html#class-packedstringarray) | [get_layer_list](#method-get_layer_list) ( ) -[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [has_layer](#method-has_layer) ( `index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) -[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [inherits_anything](#method-inherits_anything) ( ) -[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [merge_layer_infos](#method-merge_layer_infos) ( `layer_a`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary), `layer_b`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) ) +void | [add_layer](#method-add_layer) ( `scene`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `overrides`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) = `{}` ) +void | [delete_layer](#method-delete_layer) ( `layer_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) void | [move_layer](#method-move_layer) ( `from_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int), `to_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) -void | [prepare](#method-prepare) ( ) -void | [realize_inheritance](#method-realize_inheritance) ( ) -void | [remove_layer_setting](#method-remove_layer_setting) ( `layer`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int), `setting`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) void | [set_layer_scene](#method-set_layer_scene) ( `layer_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int), `scene`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) void | [set_layer_setting](#method-set_layer_setting) ( `layer`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int), `setting`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `value`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) +void | [remove_layer_setting](#method-remove_layer_setting) ( `layer`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int), `setting`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [merge_layer_infos](#method-merge_layer_infos) ( `layer_a`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary), `layer_b`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) ) +[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [has_layer](#method-has_layer) ( `index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) +[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [inherits_anything](#method-inherits_anything) ( ) +[DialogicStyle](class_dialogicstyle.md) | [get_inheritance_root](#method-get_inheritance_root) ( ) +void | [realize_inheritance](#method-realize_inheritance) ( ) +[DialogicStyle](class_dialogicstyle.md) | [clone](#method-clone) ( ) +void | [prepare](#method-prepare) ( ) --- ## Property Descriptions -**var base_overrides = ** +**var name = "Style"** @@ -55,7 +55,7 @@ Returns | Method -**var base_scene = null** +**var inherits = null** @@ -65,7 +65,7 @@ Returns | Method -**var inherits = null** +**var base_scene = null** @@ -75,7 +75,7 @@ Returns | Method -**var layers = ** +**var base_overrides = {}** @@ -85,7 +85,7 @@ Returns | Method -**var name = "Style"** +**var layers = []** @@ -97,27 +97,27 @@ Returns | Method -**func [add_layer](#method-add_layer) ( `scene`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `overrides`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) = `` ) ⇒ void** +**func [get_base_scene](#method-get_base_scene) ( ) ⇒ [PackedScene](https://docs.godotengine.org/en/latest/classes/class_packedscene.html#class-packedscene)** - *No description available.* +This always returns the inheritance root's scene! --- -**func [clone](#method-clone) ( ) ⇒ [DialogicStyle](class_dialogicstyle.md)** +**func [get_layer_list](#method-get_layer_list) ( ) ⇒ [PackedStringArray](https://docs.godotengine.org/en/latest/classes/class_packedstringarray.html#class-packedstringarray)** - *No description available.* +This always returns the full inherited roots layers! --- -**func [delete_layer](#method-delete_layer) ( `layer_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) ⇒ void** +**func [get_layer_count](#method-get_layer_count) ( ) ⇒ [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int)** @@ -127,17 +127,17 @@ Returns | Method -**func [get_base_scene](#method-get_base_scene) ( ) ⇒ [PackedScene](https://docs.godotengine.org/en/latest/classes/class_packedscene.html#class-packedscene)** +**func [get_layer_info](#method-get_layer_info) ( `index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** -This always returns the inheritance root's scene! + *No description available.* --- -**func [get_inheritance_root](#method-get_inheritance_root) ( ) ⇒ [DialogicStyle](class_dialogicstyle.md)** +**func [get_layer_inherited_info](#method-get_layer_inherited_info) ( `index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int), `inherited_only`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** @@ -147,7 +147,7 @@ This always returns the inheritance root's scene! -**func [get_layer_count](#method-get_layer_count) ( ) ⇒ [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int)** +**func [add_layer](#method-add_layer) ( `scene`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `overrides`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) = `{}` ) ⇒ void** @@ -157,7 +157,7 @@ This always returns the inheritance root's scene! -**func [get_layer_info](#method-get_layer_info) ( `index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [delete_layer](#method-delete_layer) ( `layer_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) ⇒ void** @@ -167,7 +167,7 @@ This always returns the inheritance root's scene! -**func [get_layer_inherited_info](#method-get_layer_inherited_info) ( `index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int), `inherited_only`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [move_layer](#method-move_layer) ( `from_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int), `to_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) ⇒ void** @@ -177,17 +177,17 @@ This always returns the inheritance root's scene! -**func [get_layer_list](#method-get_layer_list) ( ) ⇒ [PackedStringArray](https://docs.godotengine.org/en/latest/classes/class_packedstringarray.html#class-packedstringarray)** +**func [set_layer_scene](#method-set_layer_scene) ( `layer_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int), `scene`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** -This always returns the full inherited roots layers! + *No description available.* --- -**func [has_layer](#method-has_layer) ( `index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [set_layer_setting](#method-set_layer_setting) ( `layer`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int), `setting`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `value`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) ⇒ void** @@ -197,7 +197,7 @@ This always returns the full inherited roots layers! -**func [inherits_anything](#method-inherits_anything) ( ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [remove_layer_setting](#method-remove_layer_setting) ( `layer`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int), `setting`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** @@ -217,7 +217,7 @@ This merges two layers (mainly their overrides). Layer a has priority! -**func [move_layer](#method-move_layer) ( `from_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int), `to_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) ⇒ void** +**func [has_layer](#method-has_layer) ( `index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** @@ -227,7 +227,7 @@ This merges two layers (mainly their overrides). Layer a has priority! -**func [prepare](#method-prepare) ( ) ⇒ void** +**func [inherits_anything](#method-inherits_anything) ( ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** @@ -237,7 +237,7 @@ This merges two layers (mainly their overrides). Layer a has priority! -**func [realize_inheritance](#method-realize_inheritance) ( ) ⇒ void** +**func [get_inheritance_root](#method-get_inheritance_root) ( ) ⇒ [DialogicStyle](class_dialogicstyle.md)** @@ -247,7 +247,7 @@ This merges two layers (mainly their overrides). Layer a has priority! -**func [remove_layer_setting](#method-remove_layer_setting) ( `layer`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int), `setting`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** +**func [realize_inheritance](#method-realize_inheritance) ( ) ⇒ void** @@ -257,7 +257,7 @@ This merges two layers (mainly their overrides). Layer a has priority! -**func [set_layer_scene](#method-set_layer_scene) ( `layer_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int), `scene`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** +**func [clone](#method-clone) ( ) ⇒ [DialogicStyle](class_dialogicstyle.md)** @@ -267,7 +267,7 @@ This merges two layers (mainly their overrides). Layer a has priority! -**func [set_layer_setting](#method-set_layer_setting) ( `layer`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int), `setting`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `value`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) ⇒ void** +**func [prepare](#method-prepare) ( ) ⇒ void** diff --git a/documentation/classes/class_dialogicstyleevent.md b/documentation/classes/class_dialogicstyleevent.md index 68e5bf3..b575ec2 100644 --- a/documentation/classes/class_dialogicstyleevent.md +++ b/documentation/classes/class_dialogicstyleevent.md @@ -18,10 +18,10 @@ Name | Type | Default ## Methods Returns | Method --- | --- -void | [build_event_editor](#method-build_event_editor) ( ) [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_shortcode](#method-get_shortcode) ( ) [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) -[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_style_suggestions](#method-get_style_suggestions) ( `filter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) +void | [build_event_editor](#method-build_event_editor) ( ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_style_suggestions](#method-get_style_suggestions) ( `_filter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) --- ## Property Descriptions @@ -39,27 +39,27 @@ The name of the style to change to. Can be set on the DialogicNode_Style. -**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** +**func [get_shortcode](#method-get_shortcode) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** - *No description available.* +############################################################################## SAVING/LOADING ############################################################################## --- -**func [get_shortcode](#method-get_shortcode) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** -############################################################################## SAVING/LOADING ############################################################################## + *No description available.* --- -**func [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** @@ -69,7 +69,7 @@ The name of the style to change to. Can be set on the DialogicNode_Style. -**func [get_style_suggestions](#method-get_style_suggestions) ( `filter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [get_style_suggestions](#method-get_style_suggestions) ( `_filter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** diff --git a/documentation/classes/class_dialogicstylelayer.md b/documentation/classes/class_dialogicstylelayer.md index edabd3e..94aa3ed 100644 --- a/documentation/classes/class_dialogicstylelayer.md +++ b/documentation/classes/class_dialogicstylelayer.md @@ -12,13 +12,13 @@ ## Properties Name | Type | Default --- | --- | --- -[overrides](#property-overrides) | [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [scene](#property-scene) | [PackedScene](https://docs.godotengine.org/en/latest/classes/class_packedscene.html#class-packedscene) | `null` +[overrides](#property-overrides) | [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | `{}` ## Property Descriptions -**var overrides = ** +**var scene = null** @@ -28,7 +28,7 @@ Name | Type | Default -**var scene = null** +**var overrides = {}** diff --git a/documentation/classes/class_dialogicsubsystem.md b/documentation/classes/class_dialogicsubsystem.md index 4eb8e03..38e8f12 100644 --- a/documentation/classes/class_dialogicsubsystem.md +++ b/documentation/classes/class_dialogicsubsystem.md @@ -18,10 +18,11 @@ Name | Type | Default ## Methods Returns | Method --- | --- -void | [clear_game_state](#method-clear_game_state) ( `clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) -void | [load_game_state](#method-load_game_state) ( `load_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) -void | [pause](#method-pause) ( ) void | [post_install](#method-post_install) ( ) +void | [clear_game_state](#method-clear_game_state) ( `_clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) +void | [load_game_state](#method-load_game_state) ( `_load_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) +void | [save_game_state](#method-save_game_state) ( ) +void | [pause](#method-pause) ( ) void | [resume](#method-resume) ( ) --- ## Constants @@ -59,7 +60,7 @@ Returns | Method -**func [clear_game_state](#method-clear_game_state) ( `clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** +**func [post_install](#method-post_install) ( ) ⇒ void** @@ -69,7 +70,7 @@ Returns | Method -**func [load_game_state](#method-load_game_state) ( `load_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** +**func [clear_game_state](#method-clear_game_state) ( `_clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** @@ -79,7 +80,7 @@ Returns | Method -**func [pause](#method-pause) ( ) ⇒ void** +**func [load_game_state](#method-load_game_state) ( `_load_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** @@ -89,7 +90,17 @@ Returns | Method -**func [post_install](#method-post_install) ( ) ⇒ void** +**func [save_game_state](#method-save_game_state) ( ) ⇒ void** + + + + *No description available.* + +--- + + + +**func [pause](#method-pause) ( ) ⇒ void** diff --git a/documentation/classes/class_dialogictextevent.md b/documentation/classes/class_dialogictextevent.md index 8ab456c..52a04cd 100644 --- a/documentation/classes/class_dialogictextevent.md +++ b/documentation/classes/class_dialogictextevent.md @@ -12,37 +12,36 @@ ## Properties Name | Type | Default --- | --- | --- +[text](#property-text) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` [character](#property-character) | [DialogicCharacter](class_dialogiccharacter.md) | `null` -[character_identifier](#property-character_identifier) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | -[completion_text_character_getter_regex](#property-completion_text_character_getter_regex) | [RegEx](https://docs.godotengine.org/en/latest/classes/class_regex.html#class-regex) | -[completion_text_effects](#property-completion_text_effects) | [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [portrait](#property-portrait) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` -[regex](#property-regex) | [RegEx](https://docs.godotengine.org/en/latest/classes/class_regex.html#class-regex) | -[split_regex](#property-split_regex) | [RegEx](https://docs.godotengine.org/en/latest/classes/class_regex.html#class-regex) | +[character_identifier](#property-character_identifier) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | +[regex](#property-regex) | [RegEx](https://docs.godotengine.org/en/latest/classes/class_regex.html#class-regex) | `create_from_string(...)` +[split_regex](#property-split_regex) | [RegEx](https://docs.godotengine.org/en/latest/classes/class_regex.html#class-regex) | `create_from_string(...)` [state](#property-state) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `1` -[text](#property-text) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` -[text_effect_color](#property-text_effect_color) | [Color](https://docs.godotengine.org/en/latest/classes/class_color.html#class-color) | `Color(0.537255, 0.509804, 0.462745, 1)` +[completion_text_character_getter_regex](#property-completion_text_character_getter_regex) | [RegEx](https://docs.godotengine.org/en/latest/classes/class_regex.html#class-regex) | `new()` +[completion_text_effects](#property-completion_text_effects) | [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | `{}` [text_effects](#property-text_effects) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` -[text_effects_regex](#property-text_effects_regex) | [RegEx](https://docs.godotengine.org/en/latest/classes/class_regex.html#class-regex) | -[text_random_word_regex](#property-text_random_word_regex) | [RegEx](https://docs.godotengine.org/en/latest/classes/class_regex.html#class-regex) | +[text_effects_regex](#property-text_effects_regex) | [RegEx](https://docs.godotengine.org/en/latest/classes/class_regex.html#class-regex) | `new()` +[text_random_word_regex](#property-text_random_word_regex) | [RegEx](https://docs.godotengine.org/en/latest/classes/class_regex.html#class-regex) | `new()` +[text_effect_color](#property-text_effect_color) | [Color](https://docs.godotengine.org/en/latest/classes/class_color.html#class-color) | `Color(0.537255, 0.509804, 0.462745, 1)` --- ## Methods Returns | Method --- | --- +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [to_text](#method-to_text) ( ) +void | [from_text](#method-from_text) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_valid_event](#method-is_valid_event) ( `_string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_string_full_event](#method-is_string_full_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) void | [build_event_editor](#method-build_event_editor) ( ) +[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [should_show_portrait_selector](#method-should_show_portrait_selector) ( ) [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [do_any_characters_exist](#method-do_any_characters_exist) ( ) -void | [end_text_event](#method-end_text_event) ( ) -void | [from_text](#method-from_text) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_character_suggestions](#method-get_character_suggestions) ( `search_text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_portrait_suggestions](#method-get_portrait_suggestions) ( `search_text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) -[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [has_no_portraits](#method-has_no_portraits) ( ) -[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_string_full_event](#method-is_string_full_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_valid_event](#method-is_valid_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +void | [suggest_bbcode](#method-suggest_bbcode) ( `TextNode`: [CodeEdit](https://docs.godotengine.org/en/latest/classes/class_codeedit.html#class-codeedit) ) void | [load_text_effects](#method-load_text_effects) ( ) -void | [suggest_bbcode](#method-suggest_bbcode) ( `text`: [CodeEdit](https://docs.godotengine.org/en/latest/classes/class_codeedit.html#class-codeedit) ) -[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [to_text](#method-to_text) ( ) --- ## Constants @@ -88,57 +87,47 @@ Returns | Method -**var character = null** - - - -If this is not null, the given character (as a resource) will be associated with this event. The DialogicNode_NameLabel will show the characters display_name. If a typing sound is setup, it will play. - ---- - - - -**var character_identifier** +**var text = ""** -Used to set the character resource from the unique name identifier and vice versa +This is the content of the text event. It is supposed to be displayed by a DialogicNode_DialogText node. That means you can use bbcode, but also some custom commands. --- -**var completion_text_character_getter_regex = ** +**var character = null** - *No description available.* +If this is not null, the given character (as a resource) will be associated with this event. The DialogicNode_NameLabel will show the characters display_name. If a typing sound is setup, it will play. --- -**var completion_text_effects = ** +**var portrait = ""** - *No description available.* +If a character is set, this setting can change the portrait of that character. --- -**var portrait = ""** +**var character_identifier** -If a character is set, this setting can change the portrait of that character. +Used to set the character resource from the unique name identifier and vice versa --- -**var regex = ** +**var regex = create_from_string(...)** @@ -148,7 +137,7 @@ If a character is set, this setting can change the portrait of that character. -**var split_regex = ** +**var split_regex = create_from_string(...)** @@ -168,17 +157,17 @@ If a character is set, this setting can change the portrait of that character. -**var text = ""** +**var completion_text_character_getter_regex = new()** -This is the content of the text event. It is supposed to be displayed by a DialogicNode_DialogText node. That means you can use bbcode, but also some custom commands. + *No description available.* --- -**var text_effect_color = Color(0.537255, 0.509804, 0.462745, 1)** +**var completion_text_effects = {}** @@ -198,7 +187,7 @@ This is the content of the text event. It is supposed to be displayed by a Dialo -**var text_effects_regex = ** +**var text_effects_regex = new()** @@ -208,7 +197,7 @@ This is the content of the text event. It is supposed to be displayed by a Dialo -**var text_random_word_regex = ** +**var text_random_word_regex = new()** @@ -216,11 +205,9 @@ This is the content of the text event. It is supposed to be displayed by a Dialo --- -## Method Descriptions - -**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** +**var text_effect_color = Color(0.537255, 0.509804, 0.462745, 1)** @@ -228,9 +215,11 @@ This is the content of the text event. It is supposed to be displayed by a Dialo --- +## Method Descriptions + -**func [do_any_characters_exist](#method-do_any_characters_exist) ( ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [to_text](#method-to_text) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** @@ -240,7 +229,7 @@ This is the content of the text event. It is supposed to be displayed by a Dialo -**func [end_text_event](#method-end_text_event) ( ) ⇒ void** +**func [from_text](#method-from_text) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** @@ -250,7 +239,7 @@ This is the content of the text event. It is supposed to be displayed by a Dialo -**func [from_text](#method-from_text) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** +**func [is_valid_event](#method-is_valid_event) ( `_string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** @@ -260,7 +249,7 @@ This is the content of the text event. It is supposed to be displayed by a Dialo -**func [get_character_suggestions](#method-get_character_suggestions) ( `search_text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [is_string_full_event](#method-is_string_full_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** @@ -270,7 +259,7 @@ This is the content of the text event. It is supposed to be displayed by a Dialo -**func [get_portrait_suggestions](#method-get_portrait_suggestions) ( `search_text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** @@ -280,7 +269,7 @@ This is the content of the text event. It is supposed to be displayed by a Dialo -**func [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** @@ -290,7 +279,7 @@ This is the content of the text event. It is supposed to be displayed by a Dialo -**func [has_no_portraits](#method-has_no_portraits) ( ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [should_show_portrait_selector](#method-should_show_portrait_selector) ( ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** @@ -300,7 +289,7 @@ This is the content of the text event. It is supposed to be displayed by a Dialo -**func [is_string_full_event](#method-is_string_full_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [do_any_characters_exist](#method-do_any_characters_exist) ( ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** @@ -310,7 +299,7 @@ This is the content of the text event. It is supposed to be displayed by a Dialo -**func [is_valid_event](#method-is_valid_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [get_character_suggestions](#method-get_character_suggestions) ( `search_text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** @@ -320,7 +309,7 @@ This is the content of the text event. It is supposed to be displayed by a Dialo -**func [load_text_effects](#method-load_text_effects) ( ) ⇒ void** +**func [get_portrait_suggestions](#method-get_portrait_suggestions) ( `search_text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** @@ -330,7 +319,7 @@ This is the content of the text event. It is supposed to be displayed by a Dialo -**func [suggest_bbcode](#method-suggest_bbcode) ( `text`: [CodeEdit](https://docs.godotengine.org/en/latest/classes/class_codeedit.html#class-codeedit) ) ⇒ void** +**func [suggest_bbcode](#method-suggest_bbcode) ( `TextNode`: [CodeEdit](https://docs.godotengine.org/en/latest/classes/class_codeedit.html#class-codeedit) ) ⇒ void** @@ -340,7 +329,7 @@ This is the content of the text event. It is supposed to be displayed by a Dialo -**func [to_text](#method-to_text) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [load_text_effects](#method-load_text_effects) ( ) ⇒ void** diff --git a/documentation/classes/class_dialogictextinputevent.md b/documentation/classes/class_dialogictextinputevent.md index bb33559..90d38f7 100644 --- a/documentation/classes/class_dialogictextinputevent.md +++ b/documentation/classes/class_dialogictextinputevent.md @@ -12,40 +12,40 @@ ## Properties Name | Type | Default --- | --- | --- -[allow_empty](#property-allow_empty) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` -[default](#property-default) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` -[placeholder](#property-placeholder) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` [text](#property-text) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `"Please enter some text:"` [variable](#property-variable) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` +[placeholder](#property-placeholder) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` +[default](#property-default) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` +[allow_empty](#property-allow_empty) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` --- ## Methods Returns | Method --- | --- -void | [build_event_editor](#method-build_event_editor) ( ) [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_shortcode](#method-get_shortcode) ( ) [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) +void | [build_event_editor](#method-build_event_editor) ( ) [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_var_suggestions](#method-get_var_suggestions) ( `filter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) --- ## Property Descriptions -**var allow_empty = false** +**var text = "Please enter some text:"** -If true, the player can continue if nothing is entered. +The promt to be shown. --- -**var default = ""** +**var variable = ""** -The value that should be in the line edit by default. +The name/path of the variable to set. --- @@ -61,21 +61,21 @@ The placeholder text to show in the line edit. -**var text = "Please enter some text:"** +**var default = ""** -The promt to be shown. +The value that should be in the line edit by default. --- -**var variable = ""** +**var allow_empty = false** -The name/path of the variable to set. +If true, the player can continue if nothing is entered. --- @@ -83,7 +83,7 @@ The name/path of the variable to set. -**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** +**func [get_shortcode](#method-get_shortcode) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** @@ -93,7 +93,7 @@ The name/path of the variable to set. -**func [get_shortcode](#method-get_shortcode) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** @@ -103,7 +103,7 @@ The name/path of the variable to set. -**func [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** diff --git a/documentation/classes/class_dialogictimeline.md b/documentation/classes/class_dialogictimeline.md index d7a5c59..59cc633 100644 --- a/documentation/classes/class_dialogictimeline.md +++ b/documentation/classes/class_dialogictimeline.md @@ -12,24 +12,24 @@ Resource that defines a list of events. It can store them as text and load them ## Properties Name | Type | Default --- | --- | --- -[events](#property-events) | [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | +[events](#property-events) | [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | `[]` [events_processed](#property-events_processed) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` --- ## Methods Returns | Method --- | --- -[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [as_text](#method-as_text) ( ) -void | [clean](#method-clean) ( ) -void | [from_text](#method-from_text) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) | [get_event](#method-get_event) ( `index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) +void | [from_text](#method-from_text) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [as_text](#method-as_text) ( ) void | [process](#method-process) ( ) +void | [clean](#method-clean) ( ) --- ## Property Descriptions -**var events = ** +**var events = []** @@ -51,51 +51,51 @@ Returns | Method -**func [as_text](#method-as_text) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [get_event](#method-get_event) ( `index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) ⇒ [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant)** -Stores all events in their text format and returns them as a string +Helper method --- -**func [clean](#method-clean) ( ) ⇒ void** +**func [from_text](#method-from_text) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** -This method makes sure that all events in a timeline are correctly reset +Parses the lines as seperate events and insert them in an array, so they can be converted to DialogicEvent's when processed later --- -**func [from_text](#method-from_text) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** +**func [as_text](#method-as_text) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** -Parses the lines as seperate events and insert them in an array, so they can be converted to DialogicEvent's when processed later +Stores all events in their text format and returns them as a string --- -**func [get_event](#method-get_event) ( `index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) ⇒ [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant)** +**func [process](#method-process) ( ) ⇒ void** -Helper method +Method that loads all the event resources from the strings, if it wasn't done before --- -**func [process](#method-process) ( ) ⇒ void** +**func [clean](#method-clean) ( ) ⇒ void** -Method that loads all the event resources from the strings, if it wasn't done before +This method makes sure that all events in a timeline are correctly reset --- diff --git a/documentation/classes/class_dialogicutil.md b/documentation/classes/class_dialogicutil.md index 0b1a008..b0053ad 100644 --- a/documentation/classes/class_dialogicutil.md +++ b/documentation/classes/class_dialogicutil.md @@ -14,41 +14,46 @@ Script that container helper methods for both editor and game execution. Used wh ## Methods Returns | Method --- | --- -void | [apply_scene_export_overrides](#method-apply_scene_export_overrides) ( `node`: [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node), `export_overrides`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary), `apply`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true` ) +[float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | [get_editor_scale](#method-get_editor_scale) ( ) +[Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) | [get_dialogic_plugin](#method-get_dialogic_plugin) ( ) [DialogicGameHandler](class_dialogicgamehandler.md) | [autoload](#method-autoload) ( ) -[Color](https://docs.godotengine.org/en/latest/classes/class_color.html#class-color) | [get_color](#method-get_color) ( `value`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | [listdir](#method-listdir) ( `path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `files_only`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true`, `_throw_error`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true`, `full_file_path`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false`, `include_imports`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_module_path](#method-get_module_path) ( `name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `builtin`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true` ) +[DialogicIndexer[]](https://docs.godotengine.org/en/latest/classes/class_dialogicindexer.html#class-dialogicindexer) | [get_indexers](#method-get_indexers) ( `include_custom`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true`, `force_reload`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [pretty_name](#method-pretty_name) ( `file_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +void | [set_editor_setting](#method-set_editor_setting) ( `setting`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `value`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) +[Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) | [get_editor_setting](#method-get_editor_setting) ( `setting`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `default`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) = `null` ) [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_color_palette](#method-get_color_palette) ( `default`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) -[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_custom_event_defaults](#method-get_custom_event_defaults) ( `event_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[PackedScene](https://docs.godotengine.org/en/latest/classes/class_packedscene.html#class-packedscene) | [get_default_layout_base](#method-get_default_layout_base) ( ) -[DialogicStyle](class_dialogicstyle.md) | [get_default_style](#method-get_default_style) ( ) +[Color](https://docs.godotengine.org/en/latest/classes/class_color.html#class-color) | [get_color](#method-get_color) ( `value`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_physics_timer](#method-is_physics_timer) ( ) +void | [update_timer_process_callback](#method-update_timer_process_callback) ( `timer`: [Timer](https://docs.godotengine.org/en/latest/classes/class_timer.html#class-timer) ) +void | [multitween](#method-multitween) ( `tweened_value`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant), `item`: [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node), `property`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `part`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_next_translation_id](#method-get_next_translation_id) ( ) [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_default_variables](#method-get_default_variables) ( ) -[Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) | [get_dialogic_plugin](#method-get_dialogic_plugin) ( ) -[float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | [get_editor_scale](#method-get_editor_scale) ( ) -[Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) | [get_editor_setting](#method-get_editor_setting) ( `setting`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `default`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) = `null` ) +[Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | [list_variables](#method-list_variables) ( `dict`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary), `path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `type`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) +[int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | [get_variable_value_type](#method-get_variable_value_type) ( `value`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) +[int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | [get_variable_type](#method-get_variable_type) ( `path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `dict`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) = `{}` ) +[PackedScene](https://docs.godotengine.org/en/latest/classes/class_packedscene.html#class-packedscene) | [get_default_layout_base](#method-get_default_layout_base) ( ) [DialogicStyle](class_dialogicstyle.md) | [get_fallback_style](#method-get_fallback_style) ( ) -[DialogicIndexer[]](https://docs.godotengine.org/en/latest/classes/class_dialogicindexer.html#class-dialogicindexer) | [get_indexers](#method-get_indexers) ( `include_custom`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true`, `force_reload`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) -[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_module_path](#method-get_module_path) ( `name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `builtin`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true` ) -[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_next_translation_id](#method-get_next_translation_id) ( ) -[Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | [get_portrait_animation_scripts](#method-get_portrait_animation_scripts) ( `type`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0`, `include_custom`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true` ) -[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_scene_export_defaults](#method-get_scene_export_defaults) ( `node`: [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) ) +[DialogicStyle](class_dialogicstyle.md) | [get_default_style](#method-get_default_style) ( ) [DialogicStyle](class_dialogicstyle.md) | [get_style_by_name](#method-get_style_by_name) ( `name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | [get_variable_type](#method-get_variable_type) ( `path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `dict`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) = `` ) -[int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | [get_variable_value_type](#method-get_variable_value_type) ( `value`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) -[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_physics_timer](#method-is_physics_timer) ( ) -[Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | [list_variables](#method-list_variables) ( `dict`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary), `path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `type`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) -[Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | [listdir](#method-listdir) ( `path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `files_only`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true`, `throw_error`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true`, `full_file_path`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false`, `include_imports`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) -[Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) | [logical_convert](#method-logical_convert) ( `value`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) -[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [pretty_name](#method-pretty_name) ( `script`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -void | [set_editor_setting](#method-set_editor_setting) ( `setting`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `value`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) +void | [apply_scene_export_overrides](#method-apply_scene_export_overrides) ( `node`: [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node), `export_overrides`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary), `apply`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true` ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_scene_export_defaults](#method-get_scene_export_defaults) ( `node`: [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [make_file_custom](#method-make_file_custom) ( `original_file`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `target_folder`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `new_file_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `new_folder_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [customize_file](#method-customize_file) ( `original_file`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `target_file`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control) | [setup_script_property_edit_node](#method-setup_script_property_edit_node) ( `property_info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary), `value`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant), `property_changed`: [Callable](https://docs.godotengine.org/en/latest/classes/class_callable.html#class-callable) ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_custom_event_defaults](#method-get_custom_event_defaults) ( `event_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [str_to_bool](#method-str_to_bool) ( `boolstring`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) | [logical_convert](#method-logical_convert) ( `value`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [str_to_hash_set](#method-str_to_hash_set) ( `source`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -void | [update_timer_process_callback](#method-update_timer_process_callback) ( `timer`: [Timer](https://docs.godotengine.org/en/latest/classes/class_timer.html#class-timer) ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_character_suggestions](#method-get_character_suggestions) ( `_search_text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `current_value`: [DialogicCharacter](class_dialogiccharacter.md) = `null`, `allow_none`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true`, `allow_all`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false`, `editor_node`: [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) = `null` ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_portrait_suggestions](#method-get_portrait_suggestions) ( `search_text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `character`: [DialogicCharacter](class_dialogiccharacter.md), `allow_empty`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false`, `empty_text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `"Don\'t Change"` ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_portrait_position_suggestions](#method-get_portrait_position_suggestions) ( `search_text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) --- ## Constants -**const ALL = 0** +**const ANY = 0** @@ -57,7 +62,7 @@ Returns | Method --- -**const IN = 1** +**const STRING = 1** @@ -66,7 +71,7 @@ Returns | Method --- -**const OUT = 2** +**const FLOAT = 2** @@ -75,7 +80,7 @@ Returns | Method --- -**const ACTION = 3** +**const INT = 3** @@ -84,54 +89,68 @@ Returns | Method --- -**const ANY = 0** +**const BOOL = 4** *No description available.* --- +## Method Descriptions -**const STRING = 1** +**func [get_editor_scale](#method-get_editor_scale) ( ) ⇒ [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float)** - *No description available.* + +This method should be used instead of EditorInterface.get_editor_scale(), because if you use that it will run perfectly fine from the editor, but crash when the game is exported. --- -**const FLOAT = 2** +**func [get_dialogic_plugin](#method-get_dialogic_plugin) ( ) ⇒ [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node)** - *No description available.* + +Although this does in fact always return a EditorPlugin node, that class is apparently not present in export and referencing it here creates a crash. --- -**const INT = 3** + +**func [autoload](#method-autoload) ( ) ⇒ [DialogicGameHandler](class_dialogicgamehandler.md)** - *No description available.* +Returns the autoload when in-game. --- -**const BOOL = 4** + +**func [listdir](#method-listdir) ( `path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `files_only`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true`, `_throw_error`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true`, `full_file_path`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false`, `include_imports`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array)** + + + +############################################################################## + +--- + + + +**func [get_module_path](#method-get_module_path) ( `name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `builtin`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true` ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** *No description available.* --- -## Method Descriptions -**func [apply_scene_export_overrides](#method-apply_scene_export_overrides) ( `node`: [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node), `export_overrides`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary), `apply`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true` ) ⇒ void** +**func [get_indexers](#method-get_indexers) ( `include_custom`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true`, `force_reload`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ [DialogicIndexer[]](https://docs.godotengine.org/en/latest/classes/class_dialogicindexer.html#class-dialogicindexer)** @@ -141,17 +160,17 @@ Returns | Method -**func [autoload](#method-autoload) ( ) ⇒ [DialogicGameHandler](class_dialogicgamehandler.md)** +**func [pretty_name](#method-pretty_name) ( `file_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** -Returns the autoload when in-game. +Turns a `file_path` from `some_file.png` to `Some File`. --- -**func [get_color](#method-get_color) ( `value`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Color](https://docs.godotengine.org/en/latest/classes/class_color.html#class-color)** +**func [set_editor_setting](#method-set_editor_setting) ( `setting`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `value`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) ⇒ void** @@ -161,7 +180,7 @@ Returns the autoload when in-game. -**func [get_color_palette](#method-get_color_palette) ( `default`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [get_editor_setting](#method-get_editor_setting) ( `setting`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `default`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) = `null` ) ⇒ [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant)** @@ -171,7 +190,7 @@ Returns the autoload when in-game. -**func [get_custom_event_defaults](#method-get_custom_event_defaults) ( `event_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [get_color_palette](#method-get_color_palette) ( `default`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** @@ -181,7 +200,7 @@ Returns the autoload when in-game. -**func [get_default_layout_base](#method-get_default_layout_base) ( ) ⇒ [PackedScene](https://docs.godotengine.org/en/latest/classes/class_packedscene.html#class-packedscene)** +**func [get_color](#method-get_color) ( `value`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Color](https://docs.godotengine.org/en/latest/classes/class_color.html#class-color)** @@ -191,17 +210,17 @@ Returns the autoload when in-game. -**func [get_default_style](#method-get_default_style) ( ) ⇒ [DialogicStyle](class_dialogicstyle.md)** +**func [is_physics_timer](#method-is_physics_timer) ( ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** - *No description available.* +############################################################################## --- -**func [get_default_variables](#method-get_default_variables) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [update_timer_process_callback](#method-update_timer_process_callback) ( `timer`: [Timer](https://docs.godotengine.org/en/latest/classes/class_timer.html#class-timer) ) ⇒ void** @@ -211,27 +230,27 @@ Returns the autoload when in-game. -**func [get_dialogic_plugin](#method-get_dialogic_plugin) ( ) ⇒ [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node)** +**func [multitween](#method-multitween) ( `tweened_value`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant), `item`: [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node), `property`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `part`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** -Although this does in fact always return a EditorPlugin node, that class is apparently not present in export and referencing it here creates a crash. +############################################################################## --- -**func [get_editor_scale](#method-get_editor_scale) ( ) ⇒ [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float)** +**func [get_next_translation_id](#method-get_next_translation_id) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** -############################################################################## + *No description available.* --- -**func [get_editor_setting](#method-get_editor_setting) ( `setting`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `default`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) = `null` ) ⇒ [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant)** +**func [get_default_variables](#method-get_default_variables) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** @@ -241,7 +260,7 @@ Although this does in fact always return a EditorPlugin node, that class is appa -**func [get_fallback_style](#method-get_fallback_style) ( ) ⇒ [DialogicStyle](class_dialogicstyle.md)** +**func [list_variables](#method-list_variables) ( `dict`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary), `path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `type`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array)** @@ -251,7 +270,7 @@ Although this does in fact always return a EditorPlugin node, that class is appa -**func [get_indexers](#method-get_indexers) ( `include_custom`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true`, `force_reload`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ [DialogicIndexer[]](https://docs.godotengine.org/en/latest/classes/class_dialogicindexer.html#class-dialogicindexer)** +**func [get_variable_value_type](#method-get_variable_value_type) ( `value`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) ⇒ [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int)** @@ -261,7 +280,7 @@ Although this does in fact always return a EditorPlugin node, that class is appa -**func [get_module_path](#method-get_module_path) ( `name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `builtin`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true` ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [get_variable_type](#method-get_variable_type) ( `path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `dict`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) = `{}` ) ⇒ [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int)** @@ -271,7 +290,7 @@ Although this does in fact always return a EditorPlugin node, that class is appa -**func [get_next_translation_id](#method-get_next_translation_id) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [get_default_layout_base](#method-get_default_layout_base) ( ) ⇒ [PackedScene](https://docs.godotengine.org/en/latest/classes/class_packedscene.html#class-packedscene)** @@ -281,7 +300,7 @@ Although this does in fact always return a EditorPlugin node, that class is appa -**func [get_portrait_animation_scripts](#method-get_portrait_animation_scripts) ( `type`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0`, `include_custom`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true` ) ⇒ [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array)** +**func [get_fallback_style](#method-get_fallback_style) ( ) ⇒ [DialogicStyle](class_dialogicstyle.md)** @@ -291,7 +310,7 @@ Although this does in fact always return a EditorPlugin node, that class is appa -**func [get_scene_export_defaults](#method-get_scene_export_defaults) ( `node`: [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [get_default_style](#method-get_default_style) ( ) ⇒ [DialogicStyle](class_dialogicstyle.md)** @@ -311,7 +330,7 @@ Although this does in fact always return a EditorPlugin node, that class is appa -**func [get_variable_type](#method-get_variable_type) ( `path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `dict`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) = `` ) ⇒ [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int)** +**func [apply_scene_export_overrides](#method-apply_scene_export_overrides) ( `node`: [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node), `export_overrides`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary), `apply`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true` ) ⇒ void** @@ -321,7 +340,7 @@ Although this does in fact always return a EditorPlugin node, that class is appa -**func [get_variable_value_type](#method-get_variable_value_type) ( `value`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) ⇒ [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int)** +**func [get_scene_export_defaults](#method-get_scene_export_defaults) ( `node`: [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** @@ -331,17 +350,17 @@ Although this does in fact always return a EditorPlugin node, that class is appa -**func [is_physics_timer](#method-is_physics_timer) ( ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [make_file_custom](#method-make_file_custom) ( `original_file`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `target_folder`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `new_file_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `new_folder_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** -############################################################################## + *No description available.* --- -**func [list_variables](#method-list_variables) ( `dict`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary), `path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `type`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array)** +**func [customize_file](#method-customize_file) ( `original_file`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `target_file`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** @@ -351,17 +370,17 @@ Although this does in fact always return a EditorPlugin node, that class is appa -**func [listdir](#method-listdir) ( `path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `files_only`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true`, `throw_error`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true`, `full_file_path`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false`, `include_imports`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array)** +**func [setup_script_property_edit_node](#method-setup_script_property_edit_node) ( `property_info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary), `value`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant), `property_changed`: [Callable](https://docs.godotengine.org/en/latest/classes/class_callable.html#class-callable) ) ⇒ [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control)** -############################################################################## + *No description available.* --- -**func [logical_convert](#method-logical_convert) ( `value`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) ⇒ [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant)** +**func [get_custom_event_defaults](#method-get_custom_event_defaults) ( `event_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** @@ -371,7 +390,7 @@ Although this does in fact always return a EditorPlugin node, that class is appa -**func [pretty_name](#method-pretty_name) ( `script`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [str_to_bool](#method-str_to_bool) ( `boolstring`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** @@ -381,7 +400,7 @@ Although this does in fact always return a EditorPlugin node, that class is appa -**func [set_editor_setting](#method-set_editor_setting) ( `setting`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `value`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) ⇒ void** +**func [logical_convert](#method-logical_convert) ( `value`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) ⇒ [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant)** @@ -391,17 +410,17 @@ Although this does in fact always return a EditorPlugin node, that class is appa -**func [setup_script_property_edit_node](#method-setup_script_property_edit_node) ( `property_info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary), `value`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant), `property_changed`: [Callable](https://docs.godotengine.org/en/latest/classes/class_callable.html#class-callable) ) ⇒ [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control)** +**func [str_to_hash_set](#method-str_to_hash_set) ( `source`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** - *No description available.* +Takes `source` and builds a dictionary of keys only. The values are `null`. --- -**func [str_to_bool](#method-str_to_bool) ( `boolstring`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [get_character_suggestions](#method-get_character_suggestions) ( `_search_text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `current_value`: [DialogicCharacter](class_dialogiccharacter.md) = `null`, `allow_none`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true`, `allow_all`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false`, `editor_node`: [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) = `null` ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** @@ -411,17 +430,17 @@ Although this does in fact always return a EditorPlugin node, that class is appa -**func [str_to_hash_set](#method-str_to_hash_set) ( `source`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [get_portrait_suggestions](#method-get_portrait_suggestions) ( `search_text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `character`: [DialogicCharacter](class_dialogiccharacter.md), `allow_empty`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false`, `empty_text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `"Don\'t Change"` ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** -Takes `source` and builds a dictionary of keys only. The values are `null`. + *No description available.* --- -**func [update_timer_process_callback](#method-update_timer_process_callback) ( `timer`: [Timer](https://docs.godotengine.org/en/latest/classes/class_timer.html#class-timer) ) ⇒ void** +**func [get_portrait_position_suggestions](#method-get_portrait_position_suggestions) ( `search_text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** diff --git a/documentation/classes/class_dialogicvariableevent.md b/documentation/classes/class_dialogicvariableevent.md index 8b12300..76453fa 100644 --- a/documentation/classes/class_dialogicvariableevent.md +++ b/documentation/classes/class_dialogicvariableevent.md @@ -14,20 +14,20 @@ Name | Type | Default --- | --- | --- [name](#property-name) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` [operation](#property-operation) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `0` -[random_max](#property-random_max) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `100` -[random_min](#property-random_min) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `0` [value](#property-value) | [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) | `""` +[random_min](#property-random_min) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `0` +[random_max](#property-random_max) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `100` --- ## Methods Returns | Method --- | --- -void | [build_event_editor](#method-build_event_editor) ( ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [to_text](#method-to_text) ( ) void | [from_text](#method-from_text) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_value_suggestions](#method-get_value_suggestions) ( `filter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_var_suggestions](#method-get_var_suggestions) ( `filter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_valid_event](#method-is_valid_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [to_text](#method-to_text) ( ) +void | [build_event_editor](#method-build_event_editor) ( ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_var_suggestions](#method-get_var_suggestions) ( `filter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_value_suggestions](#method-get_value_suggestions) ( `_filter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) void | [update_editor_warning](#method-update_editor_warning) ( ) --- ## Constants @@ -154,11 +154,11 @@ The operation to perform. -**var random_max = 100** +**var value = ""** - *No description available.* +The value that is used. Can be a variable as well. --- @@ -174,11 +174,11 @@ If true, a random number between and is used instead of . -**var value = ""** +**var random_max = 100** -The value that is used. Can be a variable as well. + *No description available.* --- @@ -186,7 +186,7 @@ The value that is used. Can be a variable as well. -**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** +**func [to_text](#method-to_text) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** @@ -206,7 +206,7 @@ The value that is used. Can be a variable as well. -**func [get_value_suggestions](#method-get_value_suggestions) ( `filter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [is_valid_event](#method-is_valid_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** @@ -216,7 +216,7 @@ The value that is used. Can be a variable as well. -**func [get_var_suggestions](#method-get_var_suggestions) ( `filter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** @@ -226,7 +226,7 @@ The value that is used. Can be a variable as well. -**func [is_valid_event](#method-is_valid_event) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [get_var_suggestions](#method-get_var_suggestions) ( `filter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** @@ -236,7 +236,7 @@ The value that is used. Can be a variable as well. -**func [to_text](#method-to_text) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [get_value_suggestions](#method-get_value_suggestions) ( `_filter`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** diff --git a/documentation/classes/class_dialogicvisualeditorfield.md b/documentation/classes/class_dialogicvisualeditorfield.md index c8f8af6..0f240ec 100644 --- a/documentation/classes/class_dialogicvisualeditorfield.md +++ b/documentation/classes/class_dialogicvisualeditorfield.md @@ -12,8 +12,8 @@ ## Properties Name | Type | Default --- | --- | --- -[event_resource](#property-event_resource) | [DialogicEvent](class_dialogicevent.md) | `null` [property_name](#property-property_name) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` +[event_resource](#property-event_resource) | [DialogicEvent](class_dialogicevent.md) | `null` --- ## Methods @@ -38,7 +38,7 @@ Returns | Method -**var event_resource = null** +**var property_name = ""** @@ -48,7 +48,7 @@ Returns | Method -**var property_name = ""** +**var event_resource = null** diff --git a/documentation/classes/class_dialogicvisualeditorfieldnumber.md b/documentation/classes/class_dialogicvisualeditorfieldnumber.md index bafe1e3..c597b00 100644 --- a/documentation/classes/class_dialogicvisualeditorfieldnumber.md +++ b/documentation/classes/class_dialogicvisualeditorfieldnumber.md @@ -13,24 +13,24 @@ Name | Type | Default --- | --- | --- [allow_string](#property-allow_string) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` +[step](#property-step) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `0.1` [enforce_step](#property-enforce_step) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `true` -[max](#property-max) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `999.0` -[min](#property-min) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `0.0` +[min](#property-min) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `inf_neg` +[max](#property-max) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `inf` +[value](#property-value) | [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) | `0.0` [prefix](#property-prefix) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` -[step](#property-step) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `0.1` [suffix](#property-suffix) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` -[value](#property-value) | [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) | `0.0` --- ## Methods Returns | Method --- | --- [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | [get_value](#method-get_value) ( ) -void | [update_prefix](#method-update_prefix) ( `to_prefix`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -void | [update_suffix](#method-update_suffix) ( `to_suffix`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -void | [use_decibel_mode](#method-use_decibel_mode) ( `value_step`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `` ) void | [use_float_mode](#method-use_float_mode) ( `value_step`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.1` ) void | [use_int_mode](#method-use_int_mode) ( `value_step`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `1.0` ) +void | [use_decibel_mode](#method-use_decibel_mode) ( `value_step`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `step` ) +void | [update_prefix](#method-update_prefix) ( `to_prefix`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +void | [update_suffix](#method-update_suffix) ( `to_suffix`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) --- ## Property Descriptions @@ -46,7 +46,7 @@ Returns | Method -**var enforce_step = true** +**var step = 0.1** @@ -56,7 +56,7 @@ Returns | Method -**var max = 999.0** +**var enforce_step = true** @@ -66,7 +66,7 @@ Returns | Method -**var min = 0.0** +**var min = inf_neg** @@ -76,7 +76,7 @@ Returns | Method -**var prefix = ""** +**var max = inf** @@ -86,7 +86,7 @@ Returns | Method -**var step = 0.1** +**var value = 0.0** @@ -96,7 +96,7 @@ Returns | Method -**var suffix = ""** +**var prefix = ""** @@ -106,7 +106,7 @@ Returns | Method -**var value = 0.0** +**var suffix = ""** @@ -128,7 +128,7 @@ Returns | Method -**func [update_prefix](#method-update_prefix) ( `to_prefix`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** +**func [use_float_mode](#method-use_float_mode) ( `value_step`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.1` ) ⇒ void** @@ -138,7 +138,7 @@ Returns | Method -**func [update_suffix](#method-update_suffix) ( `to_suffix`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** +**func [use_int_mode](#method-use_int_mode) ( `value_step`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `1.0` ) ⇒ void** @@ -148,7 +148,7 @@ Returns | Method -**func [use_decibel_mode](#method-use_decibel_mode) ( `value_step`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `` ) ⇒ void** +**func [use_decibel_mode](#method-use_decibel_mode) ( `value_step`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `step` ) ⇒ void** @@ -158,7 +158,7 @@ Returns | Method -**func [use_float_mode](#method-use_float_mode) ( `value_step`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.1` ) ⇒ void** +**func [update_prefix](#method-update_prefix) ( `to_prefix`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** @@ -168,7 +168,7 @@ Returns | Method -**func [use_int_mode](#method-use_int_mode) ( `value_step`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `1.0` ) ⇒ void** +**func [update_suffix](#method-update_suffix) ( `to_suffix`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** diff --git a/documentation/classes/class_dialogicvoiceevent.md b/documentation/classes/class_dialogicvoiceevent.md index d8217b2..11af39a 100644 --- a/documentation/classes/class_dialogicvoiceevent.md +++ b/documentation/classes/class_dialogicvoiceevent.md @@ -12,47 +12,47 @@ ## Properties Name | Type | Default --- | --- | --- -[audio_bus](#property-audio_bus) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `"Master"` [file_path](#property-file_path) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` [volume](#property-volume) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `0.0` +[audio_bus](#property-audio_bus) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `"Master"` --- ## Methods Returns | Method --- | --- -void | [build_event_editor](#method-build_event_editor) ( ) [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_shortcode](#method-get_shortcode) ( ) [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) +void | [build_event_editor](#method-build_event_editor) ( ) --- ## Property Descriptions -**var audio_bus = "Master"** +**var file_path = ""** -The audio bus to play the sound on. +The path to the sound file. --- -**var file_path = ""** +**var volume = 0.0** -The path to the sound file. +The volume the sound will be played at. --- -**var volume = 0.0** +**var audio_bus = "Master"** -The volume the sound will be played at. +The audio bus to play the sound on. --- @@ -60,7 +60,7 @@ The volume the sound will be played at. -**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** +**func [get_shortcode](#method-get_shortcode) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** @@ -70,7 +70,7 @@ The volume the sound will be played at. -**func [get_shortcode](#method-get_shortcode) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** @@ -80,7 +80,7 @@ The volume the sound will be played at. -**func [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** diff --git a/documentation/classes/class_dialogicwaitevent.md b/documentation/classes/class_dialogicwaitevent.md index 8e068b4..b4e195d 100644 --- a/documentation/classes/class_dialogicwaitevent.md +++ b/documentation/classes/class_dialogicwaitevent.md @@ -12,36 +12,36 @@ ## Properties Name | Type | Default --- | --- | --- -[hide_text](#property-hide_text) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `true` [time](#property-time) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `1.0` +[hide_text](#property-hide_text) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `true` --- ## Methods Returns | Method --- | --- -void | [build_event_editor](#method-build_event_editor) ( ) [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_shortcode](#method-get_shortcode) ( ) [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) +void | [build_event_editor](#method-build_event_editor) ( ) --- ## Property Descriptions -**var hide_text = true** +**var time = 1.0** -If true the text box will be hidden while the event waits. +The time in seconds that the event will stop before continuing. --- -**var time = 1.0** +**var hide_text = true** -The time in seconds that the event will stop before continuing. +If true the text box will be hidden while the event waits. --- @@ -49,7 +49,7 @@ The time in seconds that the event will stop before continuing. -**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** +**func [get_shortcode](#method-get_shortcode) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** @@ -59,7 +59,7 @@ The time in seconds that the event will stop before continuing. -**func [get_shortcode](#method-get_shortcode) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** @@ -69,7 +69,7 @@ The time in seconds that the event will stop before continuing. -**func [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** diff --git a/documentation/classes/class_dialogicwaitinputevent.md b/documentation/classes/class_dialogicwaitinputevent.md index 2f7075d..64acc1c 100644 --- a/documentation/classes/class_dialogicwaitinputevent.md +++ b/documentation/classes/class_dialogicwaitinputevent.md @@ -18,9 +18,9 @@ Name | Type | Default ## Methods Returns | Method --- | --- -void | [build_event_editor](#method-build_event_editor) ( ) [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_shortcode](#method-get_shortcode) ( ) [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) +void | [build_event_editor](#method-build_event_editor) ( ) --- ## Property Descriptions @@ -38,7 +38,7 @@ Returns | Method -**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** +**func [get_shortcode](#method-get_shortcode) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** @@ -48,7 +48,7 @@ Returns | Method -**func [get_shortcode](#method-get_shortcode) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** @@ -58,7 +58,7 @@ Returns | Method -**func [get_shortcode_parameters](#method-get_shortcode_parameters) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [build_event_editor](#method-build_event_editor) ( ) ⇒ void** diff --git a/documentation/classes/subsystem_animation.md b/documentation/classes/subsystem_animation.md index 820c553..cbfdd15 100644 --- a/documentation/classes/subsystem_animation.md +++ b/documentation/classes/subsystem_animation.md @@ -18,9 +18,11 @@ Name | Type | Default ## Methods Returns | Method --- | --- -void | [animation_finished](#method-animation_finished) ( `arg`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) +void | [clear_game_state](#method-clear_game_state) ( `_clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_animating](#method-is_animating) ( ) void | [start_animating](#method-start_animating) ( ) +void | [animation_finished](#method-animation_finished) ( `_arg`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) +void | [stop_animation](#method-stop_animation) ( ) --- ## Signals @@ -34,6 +36,16 @@ Returns | Method --- + + +**signal [animation_interrupted](#signal-animation_interrupted) ( )** + + + + *No description available.* + +--- + ## Property Descriptions @@ -50,7 +62,7 @@ Returns | Method -**func [animation_finished](#method-animation_finished) ( `arg`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ void** +**func [clear_game_state](#method-clear_game_state) ( `_clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** @@ -78,3 +90,23 @@ Returns | Method --- + + +**func [animation_finished](#method-animation_finished) ( `_arg`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ void** + + + + *No description available.* + +--- + + + +**func [stop_animation](#method-stop_animation) ( ) ⇒ void** + + + + *No description available.* + +--- + diff --git a/documentation/classes/subsystem_audio.md b/documentation/classes/subsystem_audio.md index 6d6bcbf..7f9002b 100644 --- a/documentation/classes/subsystem_audio.md +++ b/documentation/classes/subsystem_audio.md @@ -15,23 +15,24 @@ This subsystem has many different helper methods for managing audio in your time ## Properties Name | Type | Default --- | --- | --- -[base_music_player](#property-base_music_player) | [AudioStreamPlayer](https://docs.godotengine.org/en/latest/classes/class_audiostreamplayer.html#class-audiostreamplayer) | -[base_sound_player](#property-base_sound_player) | [AudioStreamPlayer](https://docs.godotengine.org/en/latest/classes/class_audiostreamplayer.html#class-audiostreamplayer) | +[base_music_player](#property-base_music_player) | [AudioStreamPlayer](https://docs.godotengine.org/en/latest/classes/class_audiostreamplayer.html#class-audiostreamplayer) | `new()` +[current_music_player](#property-current_music_player) | [AudioStreamPlayer](https://docs.godotengine.org/en/latest/classes/class_audiostreamplayer.html#class-audiostreamplayer) | +[base_sound_player](#property-base_sound_player) | [AudioStreamPlayer](https://docs.godotengine.org/en/latest/classes/class_audiostreamplayer.html#class-audiostreamplayer) | `new()` --- ## Methods Returns | Method --- | --- -void | [clear_game_state](#method-clear_game_state) ( `clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) -[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [has_music](#method-has_music) ( ) -void | [interpolate_volume_linearly](#method-interpolate_volume_linearly) ( `value`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float), `node`: [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) ) -[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_music_playing_resource](#method-is_music_playing_resource) ( `resource_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +void | [clear_game_state](#method-clear_game_state) ( `_clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) void | [load_game_state](#method-load_game_state) ( `load_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) void | [pause](#method-pause) ( ) -void | [play_sound](#method-play_sound) ( `path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `volume`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.0`, `audio_bus`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `"Master"`, `loop`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) void | [resume](#method-resume) ( ) +void | [update_music](#method-update_music) ( `path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `volume`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.0`, `audio_bus`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `fade_time`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.0`, `loop`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true` ) +[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [has_music](#method-has_music) ( ) +void | [play_sound](#method-play_sound) ( `path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `volume`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.0`, `audio_bus`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `loop`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) void | [stop_all_sounds](#method-stop_all_sounds) ( ) -void | [update_music](#method-update_music) ( `path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `volume`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.0`, `audio_bus`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `"Master"`, `fade_time`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.0`, `loop`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true` ) +void | [interpolate_volume_linearly](#method-interpolate_volume_linearly) ( `value`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float), `node`: [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) ) +[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_music_playing_resource](#method-is_music_playing_resource) ( `resource_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) --- ## Signals @@ -75,7 +76,7 @@ Key | Value Type | Value -**var base_music_player = ** +**var base_music_player = new()** @@ -85,7 +86,17 @@ Audio player base duplicated to play background music. Background music is long -**var base_sound_player = ** +**var current_music_player** + + + +Reference to the last used music player. + +--- + + + +**var base_sound_player = new()** @@ -97,7 +108,7 @@ Audio player base, that will be duplicated to play sound effects. Sound effects -**func [clear_game_state](#method-clear_game_state) ( `clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** +**func [clear_game_state](#method-clear_game_state) ( `_clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** @@ -107,57 +118,57 @@ Clears the state on this subsystem and stops all audio. If you want to stop sou -**func [has_music](#method-has_music) ( ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [load_game_state](#method-load_game_state) ( `load_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** -Whether music is playing. +Loads the state on this subsystem from the current state info. --- -**func [interpolate_volume_linearly](#method-interpolate_volume_linearly) ( `value`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float), `node`: [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) ) ⇒ void** +**func [pause](#method-pause) ( ) ⇒ void** -Converts a linear loudness value to decibel and sets that volume to the given `node`. +Pauses playing audio. --- -**func [is_music_playing_resource](#method-is_music_playing_resource) ( `resource_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [resume](#method-resume) ( ) ⇒ void** -Returns whether the currently playing audio resource is the same as this event's `resource_path`. +Resumes playing audio. --- -**func [load_game_state](#method-load_game_state) ( `load_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** +**func [update_music](#method-update_music) ( `path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `volume`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.0`, `audio_bus`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `fade_time`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.0`, `loop`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true` ) ⇒ void** -Loads the state on this subsystem from the current state info. +Updates the background music. Will fade out previous music. --- -**func [pause](#method-pause) ( ) ⇒ void** +**func [has_music](#method-has_music) ( ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** -Pauses playing audio. +Whether music is playing. --- -**func [play_sound](#method-play_sound) ( `path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `volume`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.0`, `audio_bus`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `"Master"`, `loop`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ void** +**func [play_sound](#method-play_sound) ( `path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `volume`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.0`, `audio_bus`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `loop`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ void** @@ -167,31 +178,31 @@ Plays a given sound file. -**func [resume](#method-resume) ( ) ⇒ void** +**func [stop_all_sounds](#method-stop_all_sounds) ( ) ⇒ void** -Resumes playing audio. +Stops all audio. --- -**func [stop_all_sounds](#method-stop_all_sounds) ( ) ⇒ void** +**func [interpolate_volume_linearly](#method-interpolate_volume_linearly) ( `value`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float), `node`: [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) ) ⇒ void** -Stops all audio. +Converts a linear loudness value to decibel and sets that volume to the given `node`. --- -**func [update_music](#method-update_music) ( `path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `volume`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.0`, `audio_bus`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `"Master"`, `fade_time`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.0`, `loop`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true` ) ⇒ void** +**func [is_music_playing_resource](#method-is_music_playing_resource) ( `resource_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** -Updates the background music. Will fade out previous music. +Returns whether the currently playing audio resource is the same as this event's `resource_path`. --- diff --git a/documentation/classes/subsystem_backgrounds.md b/documentation/classes/subsystem_backgrounds.md index 36e1bba..ea71c6d 100644 --- a/documentation/classes/subsystem_backgrounds.md +++ b/documentation/classes/subsystem_backgrounds.md @@ -15,18 +15,18 @@ This subsystem has many different helper methods for managing backgrounds. For i ## Properties Name | Type | Default --- | --- | --- -[default_background_scene](#property-default_background_scene) | [PackedScene](https://docs.godotengine.org/en/latest/classes/class_packedscene.html#class-packedscene) | -[default_transition](#property-default_transition) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | +[default_background_scene](#property-default_background_scene) | [PackedScene](https://docs.godotengine.org/en/latest/classes/class_packedscene.html#class-packedscene) | `load(...)` +[default_transition](#property-default_transition) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `path_join(...)` --- ## Methods Returns | Method --- | --- -[SubViewportContainer](https://docs.godotengine.org/en/latest/classes/class_subviewportcontainer.html#class-subviewportcontainer) | [add_background_node](#method-add_background_node) ( `scene`: [PackedScene](https://docs.godotengine.org/en/latest/classes/class_packedscene.html#class-packedscene), `parent`: [DialogicNode_BackgroundHolder](class_dialogicnode_backgroundholder.md) ) void | [clear_game_state](#method-clear_game_state) ( `_clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) -[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [has_background](#method-has_background) ( ) void | [load_game_state](#method-load_game_state) ( `_load_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) -void | [update_background](#method-update_background) ( `scene`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `fade_time`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.0`, `transition_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = ``, `force`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) +void | [update_background](#method-update_background) ( `scene`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `fade_time`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.0`, `transition_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `default_transition`, `force`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) +[SubViewportContainer](https://docs.godotengine.org/en/latest/classes/class_subviewportcontainer.html#class-subviewportcontainer) | [add_background_node](#method-add_background_node) ( `scene`: [PackedScene](https://docs.godotengine.org/en/latest/classes/class_packedscene.html#class-packedscene), `parent`: [DialogicNode_BackgroundHolder](class_dialogicnode_backgroundholder.md) ) +[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [has_background](#method-has_background) ( ) --- ## Signals @@ -52,7 +52,7 @@ Key | Value Type | Value -**var default_background_scene = ** +**var default_background_scene = load(...)** @@ -62,7 +62,7 @@ The default background scene Dialogic will use. -**var default_transition = ** +**var default_transition = path_join(...)** @@ -74,51 +74,51 @@ The default transition Dialogic will use. -**func [add_background_node](#method-add_background_node) ( `scene`: [PackedScene](https://docs.godotengine.org/en/latest/classes/class_packedscene.html#class-packedscene), `parent`: [DialogicNode_BackgroundHolder](class_dialogicnode_backgroundholder.md) ) ⇒ [SubViewportContainer](https://docs.godotengine.org/en/latest/classes/class_subviewportcontainer.html#class-subviewportcontainer)** +**func [clear_game_state](#method-clear_game_state) ( `_clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** -Adds sub-viewport with the given background scene as child to Dialogic scene. +Empties the current background state. --- -**func [clear_game_state](#method-clear_game_state) ( `_clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** +**func [load_game_state](#method-load_game_state) ( `_load_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** -Empties the current background state. +Loads the background state from the current state info. --- -**func [has_background](#method-has_background) ( ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [update_background](#method-update_background) ( `scene`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `fade_time`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.0`, `transition_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `default_transition`, `force`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ void** -Whether a background is set. +Method that adds a given scene as child of the DialogicNode_BackgroundHolder. It will call [_update_background()] on that scene with the given argument . It will call [_fade_in()] on that scene with the given fade time. Will call fade_out on previous backgrounds scene. If the scene is the same as the last background you can bypass another instantiating and use the same scene. To do so implement [_should_do_background_update()] on the custom background scene. Then [_update_background()] will be called directly on that previous scene. --- -**func [load_game_state](#method-load_game_state) ( `_load_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** +**func [add_background_node](#method-add_background_node) ( `scene`: [PackedScene](https://docs.godotengine.org/en/latest/classes/class_packedscene.html#class-packedscene), `parent`: [DialogicNode_BackgroundHolder](class_dialogicnode_backgroundholder.md) ) ⇒ [SubViewportContainer](https://docs.godotengine.org/en/latest/classes/class_subviewportcontainer.html#class-subviewportcontainer)** -Loads the background state from the current state info. +Adds sub-viewport with the given background scene as child to Dialogic scene. --- -**func [update_background](#method-update_background) ( `scene`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `fade_time`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.0`, `transition_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = ``, `force`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ void** +**func [has_background](#method-has_background) ( ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** -Method that adds a given scene as child of the DialogicNode_BackgroundHolder. It will call [_update_background()] on that scene with the given argument . It will call [_fade_in()] on that scene with the given fade time. Will call fade_out on previous backgrounds scene. If the scene is the same as the last background you can bypass another instantiating and use the same scene. To do so implement [_should_do_background_update()] on the custom background scene. Then [_update_background()] will be called directly on that previous scene. +Whether a background is set. --- diff --git a/documentation/classes/subsystem_choices.md b/documentation/classes/subsystem_choices.md index b1b61af..ea1909b 100644 --- a/documentation/classes/subsystem_choices.md +++ b/documentation/classes/subsystem_choices.md @@ -12,24 +12,25 @@ Subsystem that manages showing and activating of choices. ## Properties Name | Type | Default --- | --- | --- -[autofocus_first_choice](#property-autofocus_first_choice) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `true` +[last_question_info](#property-last_question_info) | [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | `{}` +[reveal_delay](#property-reveal_delay) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `0.0` +[reveal_by_input](#property-reveal_by_input) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` [block_delay](#property-block_delay) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `0.2` +[autofocus_first_choice](#property-autofocus_first_choice) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `true` [default_false_behaviour](#property-default_false_behaviour) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `0` [hotkey_behaviour](#property-hotkey_behaviour) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `0` -[last_question_info](#property-last_question_info) | [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | -[reveal_by_input](#property-reveal_by_input) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` -[reveal_delay](#property-reveal_delay) | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | `0.0` --- ## Methods Returns | Method --- | --- -void | [clear_game_state](#method-clear_game_state) ( `clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) -[Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | [get_current_choice_indexes](#method-get_current_choice_indexes) ( ) +void | [clear_game_state](#method-clear_game_state) ( `_clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) void | [hide_all_choices](#method-hide_all_choices) ( ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_current_question_info](#method-get_current_question_info) ( ) +void | [show_current_question](#method-show_current_question) ( `instant`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true` ) +[DialogicNode_ChoiceButton](class_dialogicnode_choicebutton.md) | [get_choice_button_node](#method-get_choice_button_node) ( `button_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) +[Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | [get_current_choice_indexes](#method-get_current_choice_indexes) ( ) [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_question](#method-is_question) ( `index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) -void | [show_choice](#method-show_choice) ( `button_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int), `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `enabled`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool), `event_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) -void | [show_current_choices](#method-show_current_choices) ( `instant`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true` ) --- ## Constants @@ -82,7 +83,7 @@ Returns | Method -**signal [choices_shown](#signal-choices_shown) ( `info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) )** +**signal [question_shown](#signal-question_shown) ( `info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) )** @@ -94,71 +95,71 @@ Returns | Method -**var autofocus_first_choice = true** +**var last_question_info = {}** -If true, the first (top-most) choice will be focused +Contains information on the latest question. --- -**var block_delay = 0.2** +**var reveal_delay = 0.0** -The delay between the choices becoming visible and being clickable. Can prevent accidental selection. +The delay between the text finishing revealing and the choices appearing --- -**var default_false_behaviour = 0** +**var reveal_by_input = false** -The behaviour of choices with a false condition and else_action set to DEFAULT. +If true the player has to click to reveal choices when they are reached --- -**var hotkey_behaviour = 0** +**var block_delay = 0.2** -Will add some hotkeys to the choices if different then HotkeyBehaviour.NONE. +The delay between the choices becoming visible and being clickable. Can prevent accidental selection. --- -**var last_question_info = ** +**var autofocus_first_choice = true** -Contains information on the latest question. +If true, the first (top-most) choice will be focused --- -**var reveal_by_input = false** +**var default_false_behaviour = 0** -If true the player has to click to reveal choices when they are reached +The behaviour of choices with a false condition and else_action set to DEFAULT. --- -**var reveal_delay = 0.0** +**var hotkey_behaviour = 0** -The delay between the text finishing revealing and the choices appearing +Will add some hotkeys to the choices if different then HotkeyBehaviour.NONE. --- @@ -166,7 +167,7 @@ The delay between the text finishing revealing and the choices appearing -**func [clear_game_state](#method-clear_game_state) ( `clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** +**func [clear_game_state](#method-clear_game_state) ( `_clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** @@ -176,27 +177,37 @@ The delay between the text finishing revealing and the choices appearing -**func [get_current_choice_indexes](#method-get_current_choice_indexes) ( ) ⇒ [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array)** +**func [hide_all_choices](#method-hide_all_choices) ( ) ⇒ void** - *No description available.* +Hides all choice buttons. --- -**func [hide_all_choices](#method-hide_all_choices) ( ) ⇒ void** +**func [get_current_question_info](#method-get_current_question_info) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** -Hides all choice buttons. +Collects information on all the choices of the current question. The result is a dictionary like this: {'choices': [ {'event_index':10, 'button_index':1, 'disabled':false, 'text':"My Choice", 'visible':true}, {'event_index':15, 'button_index':2, 'disabled':false, 'text':"My Choice2", 'visible':true}, ] --- -**func [is_question](#method-is_question) ( `index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [show_current_question](#method-show_current_question) ( `instant`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true` ) ⇒ void** + + + +Lists all current choices and shows buttons. + +--- + + + +**func [get_choice_button_node](#method-get_choice_button_node) ( `button_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) ⇒ [DialogicNode_ChoiceButton](class_dialogicnode_choicebutton.md)** @@ -206,21 +217,21 @@ Hides all choice buttons. -**func [show_choice](#method-show_choice) ( `button_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int), `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `enabled`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool), `event_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) ⇒ void** +**func [get_current_choice_indexes](#method-get_current_choice_indexes) ( ) ⇒ [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array)** -Adds a button with the given text that leads to the given event. + *No description available.* --- -**func [show_current_choices](#method-show_current_choices) ( `instant`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true` ) ⇒ void** +**func [is_question](#method-is_question) ( `index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** -Lists all current choices and shows buttons. + *No description available.* --- diff --git a/documentation/classes/subsystem_containers.md b/documentation/classes/subsystem_containers.md new file mode 100644 index 0000000..e9351ef --- /dev/null +++ b/documentation/classes/subsystem_containers.md @@ -0,0 +1,212 @@ + +
+
Containers
+
+ +*This contains the source code documentation of the class `subsystem_Containers`.* + +# subsystem_Containers +**Inherits:** [DialogicSubsystem](class_dialogicsubsystem.md) + +################################################################################################## +## Properties +Name | Type | Default +--- | --- | --- +[transform_regex](#property-transform_regex) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `"(?position|pos|size|siz|rotation|rot)\\W*=(?((?!(pos|siz|rot)).)*)"` +--- + +## Methods +Returns | Method +--- | --- +[DialogicNode_PortraitContainer](class_dialogicnode_portraitcontainer.md) | [get_container](#method-get_container) ( `position_id`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[DialogicNode_PortraitContainer[]](https://docs.godotengine.org/en/latest/classes/class_dialogicnode_portraitcontainer.html#class-dialogicnode_portraitcontainer) | [get_containers](#method-get_containers) ( `position_id`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[CanvasItem](https://docs.godotengine.org/en/latest/classes/class_canvasitem.html#class-canvasitem) | [get_container_container](#method-get_container_container) ( ) +[DialogicNode_PortraitContainer](class_dialogicnode_portraitcontainer.md) | [add_container](#method-add_container) ( `position_id`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +void | [move_container](#method-move_container) ( `container`: [DialogicNode_PortraitContainer](class_dialogicnode_portraitcontainer.md), `destination`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `tween`: [Tween](https://docs.godotengine.org/en/latest/classes/class_tween.html#class-tween) = `null`, `time`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `1.0` ) +void | [copy_container_setup](#method-copy_container_setup) ( `from`: [DialogicNode_PortraitContainer](class_dialogicnode_portraitcontainer.md), `to`: [DialogicNode_PortraitContainer](class_dialogicnode_portraitcontainer.md) ) +void | [translate_container](#method-translate_container) ( `container`: [DialogicNode_PortraitContainer](class_dialogicnode_portraitcontainer.md), `translation`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant), `relative`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false`, `tween`: [Tween](https://docs.godotengine.org/en/latest/classes/class_tween.html#class-tween) = `null`, `time`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `1.0` ) +void | [rotate_container](#method-rotate_container) ( `container`: [DialogicNode_PortraitContainer](class_dialogicnode_portraitcontainer.md), `rotation`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float), `relative`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false`, `tween`: [Tween](https://docs.godotengine.org/en/latest/classes/class_tween.html#class-tween) = `null`, `time`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `1.0` ) +void | [resize_container](#method-resize_container) ( `container`: [DialogicNode_PortraitContainer](class_dialogicnode_portraitcontainer.md), `rect_size`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant), `relative`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false`, `tween`: [Tween](https://docs.godotengine.org/en/latest/classes/class_tween.html#class-tween) = `null`, `time`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `1.0` ) +void | [save_position_container](#method-save_position_container) ( `container`: [DialogicNode_PortraitContainer](class_dialogicnode_portraitcontainer.md) ) +[DialogicNode_PortraitContainer](class_dialogicnode_portraitcontainer.md) | [load_position_container](#method-load_position_container) ( `position_id`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[Vector2](https://docs.godotengine.org/en/latest/classes/class_vector2.html#class-vector2) | [str_to_vector](#method-str_to_vector) ( `input`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `base_vector`: [Vector2](https://docs.godotengine.org/en/latest/classes/class_vector2.html#class-vector2) = `Vector2(0, 0)` ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [vector_to_str](#method-vector_to_str) ( `vec`: [Vector2](https://docs.godotengine.org/en/latest/classes/class_vector2.html#class-vector2) ) +void | [reset_all_containers](#method-reset_all_containers) ( `time`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.0`, `tween`: [Tween](https://docs.godotengine.org/en/latest/classes/class_tween.html#class-tween) = `null` ) +void | [reset_container](#method-reset_container) ( `container`: [DialogicNode_PortraitContainer](class_dialogicnode_portraitcontainer.md), `time`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.0`, `tween`: [Tween](https://docs.godotengine.org/en/latest/classes/class_tween.html#class-tween) = `null` ) +--- + +## Signals + + +**signal [position_changed](#signal-position_changed) ( `info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) )** + + + + *No description available.* + +--- + +## Property Descriptions + + + +**var transform_regex = "(?position|pos|size|siz|rotation|rot)\\W*=(?((?!(pos|siz|rot)).)*)"** + + + + *No description available.* + +--- + +## Method Descriptions + + + +**func [get_container](#method-get_container) ( `position_id`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [DialogicNode_PortraitContainer](class_dialogicnode_portraitcontainer.md)** + + + + *No description available.* + +--- + + + +**func [get_containers](#method-get_containers) ( `position_id`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [DialogicNode_PortraitContainer[]](https://docs.godotengine.org/en/latest/classes/class_dialogicnode_portraitcontainer.html#class-dialogicnode_portraitcontainer)** + + + + *No description available.* + +--- + + + +**func [get_container_container](#method-get_container_container) ( ) ⇒ [CanvasItem](https://docs.godotengine.org/en/latest/classes/class_canvasitem.html#class-canvasitem)** + + + + *No description available.* + +--- + + + +**func [add_container](#method-add_container) ( `position_id`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [DialogicNode_PortraitContainer](class_dialogicnode_portraitcontainer.md)** + + + +Creates a new portrait container node. It will copy it's size and most settings from the first p_container in the tree. It will be added as a sibling of the first p_container in the tree. + +--- + + + +**func [move_container](#method-move_container) ( `container`: [DialogicNode_PortraitContainer](class_dialogicnode_portraitcontainer.md), `destination`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `tween`: [Tween](https://docs.godotengine.org/en/latest/classes/class_tween.html#class-tween) = `null`, `time`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `1.0` ) ⇒ void** + + + +Moves the to the (using and ). The destination can be a position_id (e.g. "center") or translation, roataion and scale. When moving to a preset container, then some more will be "copied" (e.g. anchors, etc.) + +--- + + + +**func [copy_container_setup](#method-copy_container_setup) ( `from`: [DialogicNode_PortraitContainer](class_dialogicnode_portraitcontainer.md), `to`: [DialogicNode_PortraitContainer](class_dialogicnode_portraitcontainer.md) ) ⇒ void** + + + + *No description available.* + +--- + + + +**func [translate_container](#method-translate_container) ( `container`: [DialogicNode_PortraitContainer](class_dialogicnode_portraitcontainer.md), `translation`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant), `relative`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false`, `tween`: [Tween](https://docs.godotengine.org/en/latest/classes/class_tween.html#class-tween) = `null`, `time`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `1.0` ) ⇒ void** + + + +Translates the given container. The given translation should be the target position of the ORIGIN point, not the container! + +--- + + + +**func [rotate_container](#method-rotate_container) ( `container`: [DialogicNode_PortraitContainer](class_dialogicnode_portraitcontainer.md), `rotation`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float), `relative`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false`, `tween`: [Tween](https://docs.godotengine.org/en/latest/classes/class_tween.html#class-tween) = `null`, `time`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `1.0` ) ⇒ void** + + + + *No description available.* + +--- + + + +**func [resize_container](#method-resize_container) ( `container`: [DialogicNode_PortraitContainer](class_dialogicnode_portraitcontainer.md), `rect_size`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant), `relative`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false`, `tween`: [Tween](https://docs.godotengine.org/en/latest/classes/class_tween.html#class-tween) = `null`, `time`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `1.0` ) ⇒ void** + + + + *No description available.* + +--- + + + +**func [save_position_container](#method-save_position_container) ( `container`: [DialogicNode_PortraitContainer](class_dialogicnode_portraitcontainer.md) ) ⇒ void** + + + + *No description available.* + +--- + + + +**func [load_position_container](#method-load_position_container) ( `position_id`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [DialogicNode_PortraitContainer](class_dialogicnode_portraitcontainer.md)** + + + + *No description available.* + +--- + + + +**func [str_to_vector](#method-str_to_vector) ( `input`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `base_vector`: [Vector2](https://docs.godotengine.org/en/latest/classes/class_vector2.html#class-vector2) = `Vector2(0, 0)` ) ⇒ [Vector2](https://docs.godotengine.org/en/latest/classes/class_vector2.html#class-vector2)** + + + + *No description available.* + +--- + + + +**func [vector_to_str](#method-vector_to_str) ( `vec`: [Vector2](https://docs.godotengine.org/en/latest/classes/class_vector2.html#class-vector2) ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** + + + + *No description available.* + +--- + + + +**func [reset_all_containers](#method-reset_all_containers) ( `time`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.0`, `tween`: [Tween](https://docs.godotengine.org/en/latest/classes/class_tween.html#class-tween) = `null` ) ⇒ void** + + + + *No description available.* + +--- + + + +**func [reset_container](#method-reset_container) ( `container`: [DialogicNode_PortraitContainer](class_dialogicnode_portraitcontainer.md), `time`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.0`, `tween`: [Tween](https://docs.godotengine.org/en/latest/classes/class_tween.html#class-tween) = `null` ) ⇒ void** + + + + *No description available.* + +--- + diff --git a/documentation/classes/subsystem_expression.md b/documentation/classes/subsystem_expression.md index 70cbf1e..f82790a 100644 --- a/documentation/classes/subsystem_expression.md +++ b/documentation/classes/subsystem_expression.md @@ -9,22 +9,39 @@ **Inherits:** [DialogicSubsystem](class_dialogicsubsystem.md) ################################################################################################## +## Properties +Name | Type | Default +--- | --- | --- +[condition_modifier_regex](#property-condition_modifier_regex) | [RegEx](https://docs.godotengine.org/en/latest/classes/class_regex.html#class-regex) | `create_from_string(...)` --- ## Methods Returns | Method --- | --- -[int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | [d_len](#method-d_len) ( `arg`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) +[Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) | [execute_string](#method-execute_string) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `default`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) = `null`, `no_warning`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) +[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [execute_condition](#method-execute_condition) ( `condition`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [modifier_condition](#method-modifier_condition) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | [d_range](#method-d_range) ( `a1`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant), `a2`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) = `null`, `a3`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) = `null`, `a4`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) = `null` ) +[int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | [d_len](#method-d_len) ( `arg`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [d_regex](#method-d_regex) ( `input`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `pattern`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `offset`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0`, `end`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `-1` ) -[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [execute_condition](#method-execute_condition) ( `condition`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) | [execute_string](#method-execute_string) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `default`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) = `null`, `no_warning`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) --- +## Property Descriptions + + + +**var condition_modifier_regex = create_from_string(...)** + + + + *No description available.* + +--- + ## Method Descriptions -**func [d_len](#method-d_len) ( `arg`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) ⇒ [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int)** +**func [execute_string](#method-execute_string) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `default`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) = `null`, `no_warning`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant)** @@ -34,17 +51,17 @@ Returns | Method -**func [d_range](#method-d_range) ( `a1`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant), `a2`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) = `null`, `a3`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) = `null`, `a4`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) = `null` ) ⇒ [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array)** +**func [execute_condition](#method-execute_condition) ( `condition`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** -################################################################################################## + *No description available.* --- -**func [d_regex](#method-d_regex) ( `input`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `pattern`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `offset`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0`, `end`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `-1` ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [modifier_condition](#method-modifier_condition) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** @@ -54,7 +71,17 @@ Returns | Method -**func [execute_condition](#method-execute_condition) ( `condition`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [d_range](#method-d_range) ( `a1`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant), `a2`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) = `null`, `a3`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) = `null`, `a4`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) = `null` ) ⇒ [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array)** + + + +################################################################################################## + +--- + + + +**func [d_len](#method-d_len) ( `arg`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) ⇒ [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int)** @@ -64,7 +91,7 @@ Returns | Method -**func [execute_string](#method-execute_string) ( `string`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `default`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) = `null`, `no_warning`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant)** +**func [d_regex](#method-d_regex) ( `input`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `pattern`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `offset`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0`, `end`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `-1` ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** diff --git a/documentation/classes/subsystem_glossary.md b/documentation/classes/subsystem_glossary.md index 5a4d603..bc2c9f1 100644 --- a/documentation/classes/subsystem_glossary.md +++ b/documentation/classes/subsystem_glossary.md @@ -12,19 +12,19 @@ Subsystem that handles glossaries. ## Properties Name | Type | Default --- | --- | --- -[color_overrides](#property-color_overrides) | [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | +[glossaries](#property-glossaries) | [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | `[]` [enabled](#property-enabled) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `true` -[glossaries](#property-glossaries) | [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | +[color_overrides](#property-color_overrides) | [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | `{}` --- ## Methods Returns | Method --- | --- -void | [add_glossary](#method-add_glossary) ( `path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) void | [clear_game_state](#method-clear_game_state) ( `_clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [parse_glossary](#method-parse_glossary) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +void | [add_glossary](#method-add_glossary) ( `path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) [DialogicGlossary](class_dialogicglossary.md) | [find_glossary](#method-find_glossary) ( `entry_key`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_entry](#method-get_entry) ( `entry_key`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [parse_glossary](#method-parse_glossary) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [translate](#method-translate) ( `tr_base`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `property`: [StringName](https://docs.godotengine.org/en/latest/classes/class_stringname.html#class-stringname), `fallback_entry`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) ) --- ## Constants @@ -41,11 +41,11 @@ Returns | Method -**var color_overrides = ** +**var glossaries = []** -Any key in this dictionary will overwrite the color for any item with that name. +List of glossary resources that are used. --- @@ -61,11 +61,11 @@ If false, no parsing will be done. -**var glossaries = ** +**var color_overrides = {}** -List of glossary resources that are used. +Any key in this dictionary will overwrite the color for any item with that name. --- @@ -73,7 +73,7 @@ List of glossary resources that are used. -**func [add_glossary](#method-add_glossary) ( `path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** +**func [clear_game_state](#method-clear_game_state) ( `_clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** @@ -83,7 +83,7 @@ List of glossary resources that are used. -**func [clear_game_state](#method-clear_game_state) ( `_clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** +**func [parse_glossary](#method-parse_glossary) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** @@ -93,31 +93,31 @@ List of glossary resources that are used. -**func [find_glossary](#method-find_glossary) ( `entry_key`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [DialogicGlossary](class_dialogicglossary.md)** +**func [add_glossary](#method-add_glossary) ( `path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** -Iterates over all glossaries and returns the first one that matches the `entry_key`. Runtime complexity: O(n), where n is the number of glossaries. + *No description available.* --- -**func [get_entry](#method-get_entry) ( `entry_key`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [find_glossary](#method-find_glossary) ( `entry_key`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [DialogicGlossary](class_dialogicglossary.md)** -Returns the first match for a given entry key. If translation is available and enabled, it will be translated +Iterates over all glossaries and returns the first one that matches the `entry_key`. Runtime complexity: O(n), where n is the number of glossaries. --- -**func [parse_glossary](#method-parse_glossary) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [get_entry](#method-get_entry) ( `entry_key`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** - *No description available.* +Returns the first match for a given entry key. If translation is available and enabled, it will be translated --- diff --git a/documentation/classes/subsystem_history.md b/documentation/classes/subsystem_history.md index 1f9d113..7d01b95 100644 --- a/documentation/classes/subsystem_history.md +++ b/documentation/classes/subsystem_history.md @@ -12,39 +12,44 @@ Subsystem that manages history storing. ## Properties Name | Type | Default --- | --- | --- -[full_event_history_content](#property-full_event_history_content) | [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | +[simple_history_enabled](#property-simple_history_enabled) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` +[simple_history_save](#property-simple_history_save) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` +[simple_history_content](#property-simple_history_content) | [Dictionary[]](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | `[]` [full_event_history_enabled](#property-full_event_history_enabled) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` -[save_visited_history_on_autosave](#property-save_visited_history_on_autosave) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` -[save_visited_history_on_save](#property-save_visited_history_on_save) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` -[simple_history_content](#property-simple_history_content) | [Dictionary[]](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | -[simple_history_enabled](#property-simple_history_enabled) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `true` -[visited_event_history_content](#property-visited_event_history_content) | [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | +[full_event_history_save](#property-full_event_history_save) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` +[full_event_history_content](#property-full_event_history_content) | [DialogicEvent[]](https://docs.godotengine.org/en/latest/classes/class_dialogicevent.html#class-dialogicevent) | `[]` [visited_event_history_enabled](#property-visited_event_history_enabled) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` +[visited_event_history_content](#property-visited_event_history_content) | [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | `{}` [visited_event_save_key](#property-visited_event_save_key) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `"visited_event_history_content"` +[save_visited_history_on_autosave](#property-save_visited_history_on_autosave) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` +[save_visited_history_on_save](#property-save_visited_history_on_save) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` --- ## Methods Returns | Method --- | --- +void | [post_install](#method-post_install) ( ) +void | [clear_game_state](#method-clear_game_state) ( `clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) +void | [load_game_state](#method-load_game_state) ( `load_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) +void | [save_game_state](#method-save_game_state) ( ) +void | [open_history](#method-open_history) ( ) void | [close_history](#method-close_history) ( ) -[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_saved_visited_history](#method-get_saved_visited_history) ( ) +void | [store_simple_history_entry](#method-store_simple_history_entry) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `event_type`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `extra_info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) = `{}` ) [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | [get_simple_history](#method-get_simple_history) ( ) -[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [has_event_been_visited](#method-has_event_been_visited) ( `event_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = ``, `timeline`: [DialogicTimeline](class_dialogictimeline.md) = `` ) +void | [store_full_event](#method-store_full_event) ( `event`: [DialogicEvent](class_dialogicevent.md) ) +void | [mark_event_as_visited](#method-mark_event_as_visited) ( `event_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = ``, `timeline`: [DialogicTimeline](class_dialogictimeline.md) = `` ) [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [has_last_event_been_visited](#method-has_last_event_been_visited) ( ) +[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [has_event_been_visited](#method-has_event_been_visited) ( `event_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = ``, `timeline`: [DialogicTimeline](class_dialogictimeline.md) = `` ) +void | [save_visited_history](#method-save_visited_history) ( ) void | [load_visited_history](#method-load_visited_history) ( ) -void | [mark_event_as_visited](#method-mark_event_as_visited) ( `_event`: [DialogicEvent](class_dialogicevent.md) ) -void | [open_history](#method-open_history) ( ) -void | [post_install](#method-post_install) ( ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_saved_visited_history](#method-get_saved_visited_history) ( ) void | [reset_visited_history](#method-reset_visited_history) ( `reset_property`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true` ) -void | [save_visited_history](#method-save_visited_history) ( ) -void | [store_full_event](#method-store_full_event) ( `event`: [DialogicEvent](class_dialogicevent.md) ) -void | [store_simple_history_entry](#method-store_simple_history_entry) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `event_type`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `extra_info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) = `` ) --- ## Signals -**signal [close_requested](#signal-close_requested) ( )** +**signal [open_requested](#signal-open_requested) ( )** @@ -54,17 +59,17 @@ Returns | Method -**signal [full_event_history_changed](#signal-full_event_history_changed) ( )** +**signal [close_requested](#signal-close_requested) ( )** - Emitted if a new event has been inserted into the full event history. + *No description available.* --- -**signal [open_requested](#signal-open_requested) ( )** +**signal [simple_history_changed](#signal-simple_history_changed) ( )** @@ -74,31 +79,31 @@ Returns | Method -**signal [simple_history_changed](#signal-simple_history_changed) ( )** +**signal [full_event_history_changed](#signal-full_event_history_changed) ( )** - *No description available.* + Emitted if a new event has been inserted into the full event history. --- -**signal [unvisited_event](#signal-unvisited_event) ( )** +**signal [visited_event](#signal-visited_event) ( )** - Emitted if an encountered timeline event has not been visited before. + Emitted if an encountered timeline event has been inserted into the visited event history. This will trigger only once per unique event instance. --- -**signal [visited_event](#signal-visited_event) ( )** +**signal [unvisited_event](#signal-unvisited_event) ( )** - Emitted if an encountered timeline event has been inserted into the visited event history. This will trigger only once per unique event instance. + Emitted if an encountered timeline event has not been visited before. --- @@ -106,47 +111,47 @@ Returns | Method -**var full_event_history_content = ** +**var simple_history_enabled = false** -The full history of all Dialogic events encountered. Requires `full_event_history_enabled` to be true. +Simple history that stores limited information Used for the history display --- -**var full_event_history_enabled = false** +**var simple_history_save = false** -Whether to keep a history of every Dialogic event encountered. + *No description available.* --- -**var save_visited_history_on_autosave = false** +**var simple_history_content = []** -Whether to automatically save the already-visited history on auto-save. + *No description available.* --- -**var save_visited_history_on_save = false** +**var full_event_history_enabled = false** -Whether to automatically save the already-visited history on manual save. +Whether to keep a history of every Dialogic event encountered. --- -**var simple_history_content = ** +**var full_event_history_save = false** @@ -156,31 +161,31 @@ Whether to automatically save the already-visited history on manual save. -**var simple_history_enabled = true** +**var full_event_history_content = []** -Simple history that stores limited information Used for the history display +The full history of all Dialogic events encountered. Requires `full_event_history_enabled` to be true. --- -**var visited_event_history_content = ** +**var visited_event_history_enabled = false** -A history of visited Dialogic events. +Read text history Stores which text events and choices have already been visited --- -**var visited_event_history_enabled = false** +**var visited_event_history_content = {}** -Read text history Stores which text events and choices have already been visited +A history of visited Dialogic events. --- @@ -194,11 +199,31 @@ Used to store `visited_event_history_content` in the global info file. You can c --- + + +**var save_visited_history_on_autosave = false** + + + +Whether to automatically save the already-visited history on auto-save. + +--- + + + +**var save_visited_history_on_save = false** + + + +Whether to automatically save the already-visited history on manual save. + +--- + ## Method Descriptions -**func [close_history](#method-close_history) ( ) ⇒ void** +**func [post_install](#method-post_install) ( ) ⇒ void** @@ -208,17 +233,17 @@ Used to store `visited_event_history_content` in the global info file. You can c -**func [get_saved_visited_history](#method-get_saved_visited_history) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [clear_game_state](#method-clear_game_state) ( `clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** -Returns the saved already-visited history from the global info save file. If none exist in the global info file, returns an empty dictionary. Relies on the [Save](subsystem_save.md) subsystem. + *No description available.* --- -**func [get_simple_history](#method-get_simple_history) ( ) ⇒ [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array)** +**func [load_game_state](#method-load_game_state) ( `load_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** @@ -228,37 +253,37 @@ Returns the saved already-visited history from the global info save file. If non -**func [has_event_been_visited](#method-has_event_been_visited) ( `event_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = ``, `timeline`: [DialogicTimeline](class_dialogictimeline.md) = `` ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [save_game_state](#method-save_game_state) ( ) ⇒ void** -If called with with no arguments, the method will return whether the last encountered event was visited before. Otherwise, if `event_index` and `timeline` are passed, the method will check if the event from that given timeline has been visited yet. If no `timeline` is passed, the current timeline will be used. If there is no current timeline, `false` will be returned. If no `event_index` is passed, the current event index will be used. + *No description available.* --- -**func [has_last_event_been_visited](#method-has_last_event_been_visited) ( ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [open_history](#method-open_history) ( ) ⇒ void** -Whether the last event has been visited for the first time or not. This will return `true` exactly once for each unique timeline event instance. + *No description available.* --- -**func [load_visited_history](#method-load_visited_history) ( ) ⇒ void** +**func [close_history](#method-close_history) ( ) ⇒ void** -Loads the seen events from the global info save file. Calling this when a game gets loaded may be useful. Relies on the [Save](subsystem_save.md) subsystem. + *No description available.* --- -**func [mark_event_as_visited](#method-mark_event_as_visited) ( `_event`: [DialogicEvent](class_dialogicevent.md) ) ⇒ void** +**func [store_simple_history_entry](#method-store_simple_history_entry) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `event_type`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `extra_info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) = `{}` ) ⇒ void** @@ -268,7 +293,7 @@ Loads the seen events from the global info save file. Calling this when a game g -**func [open_history](#method-open_history) ( ) ⇒ void** +**func [get_simple_history](#method-get_simple_history) ( ) ⇒ [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array)** @@ -278,21 +303,41 @@ Loads the seen events from the global info save file. Calling this when a game g -**func [post_install](#method-post_install) ( ) ⇒ void** +**func [store_full_event](#method-store_full_event) ( `event`: [DialogicEvent](class_dialogicevent.md) ) ⇒ void** - *No description available.* +Called on each event. --- -**func [reset_visited_history](#method-reset_visited_history) ( `reset_property`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true` ) ⇒ void** +**func [mark_event_as_visited](#method-mark_event_as_visited) ( `event_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = ``, `timeline`: [DialogicTimeline](class_dialogictimeline.md) = `` ) ⇒ void** -Resets the already-visited history in the global info save file. If `reset_property` is true, it will also reset the already-visited history in the Dialogic Autoload. Relies on the [Save](subsystem_save.md) subsystem. +Called if an event is marked as visited. + +--- + + + +**func [has_last_event_been_visited](#method-has_last_event_been_visited) ( ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** + + + +Whether the last event has been visited for the first time or not. This will return `true` exactly once for each unique timeline event instance. + +--- + + + +**func [has_event_been_visited](#method-has_event_been_visited) ( `event_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = ``, `timeline`: [DialogicTimeline](class_dialogictimeline.md) = `` ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** + + + +If called with with no arguments, the method will return whether the last encountered event was visited before. Otherwise, if `event_index` and `timeline` are passed, the method will check if the event from that given timeline has been visited yet. If no `timeline` is passed, the current timeline will be used. If there is no current timeline, `false` will be returned. If no `event_index` is passed, the current event index will be used. --- @@ -308,21 +353,31 @@ Saves all seen events to the global info file. This can be useful when the playe -**func [store_full_event](#method-store_full_event) ( `event`: [DialogicEvent](class_dialogicevent.md) ) ⇒ void** +**func [load_visited_history](#method-load_visited_history) ( ) ⇒ void** -Called on each event. +Loads the seen events from the global info save file. Calling this when a game gets loaded may be useful. Relies on the [Save](subsystem_save.md) subsystem. --- -**func [store_simple_history_entry](#method-store_simple_history_entry) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `event_type`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `extra_info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) = `` ) ⇒ void** +**func [get_saved_visited_history](#method-get_saved_visited_history) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** - *No description available.* +Returns the saved already-visited history from the global info save file. If none exist in the global info file, returns an empty dictionary. Relies on the [Save](subsystem_save.md) subsystem. + +--- + + + +**func [reset_visited_history](#method-reset_visited_history) ( `reset_property`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true` ) ⇒ void** + + + +Resets the already-visited history in the global info save file. If `reset_property` is true, it will also reset the already-visited history in the Dialogic Autoload. Relies on the [Save](subsystem_save.md) subsystem. --- diff --git a/documentation/classes/subsystem_input.md b/documentation/classes/subsystem_input.md index b6e80b5..1f1a7f6 100644 --- a/documentation/classes/subsystem_input.md +++ b/documentation/classes/subsystem_input.md @@ -15,39 +15,40 @@ This subsystem can be accessed via GDScript: `Dialogic.Inputs`. ## Properties Name | Type | Default --- | --- | --- +[input_block_timer](#property-input_block_timer) | [Timer](https://docs.godotengine.org/en/latest/classes/class_timer.html#class-timer) | `new()` [action_was_consumed](#property-action_was_consumed) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` -[auto_advance](#property-auto_advance) | [DialogicAutoAdvance](class_dialogicautoadvance.md) | `null` [auto_skip](#property-auto_skip) | [DialogicAutoSkip](class_dialogicautoskip.md) | `null` -[input_block_timer](#property-input_block_timer) | [Timer](https://docs.godotengine.org/en/latest/classes/class_timer.html#class-timer) | +[auto_advance](#property-auto_advance) | [DialogicAutoAdvance](class_dialogicautoadvance.md) | `null` [manual_advance](#property-manual_advance) | [DialogicManualAdvance](class_dialogicmanualadvance.md) | `null` --- ## Methods Returns | Method --- | --- -void | [block_input](#method-block_input) ( `time`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.1` ) void | [clear_game_state](#method-clear_game_state) ( `_clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) -void | [effect_autoadvance](#method-effect_autoadvance) ( `text_node`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `skipped`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool), `argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -void | [effect_input](#method-effect_input) ( `text_node`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `skipped`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool), `argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -void | [effect_noskip](#method-effect_noskip) ( `text_node`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `skipped`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool), `argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +void | [pause](#method-pause) ( ) +void | [resume](#method-resume) ( ) +void | [post_install](#method-post_install) ( ) void | [handle_input](#method-handle_input) ( ) +[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_input_pressed](#method-is_input_pressed) ( `event`: [InputEvent](https://docs.godotengine.org/en/latest/classes/class_inputevent.html#class-inputevent), `exact`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) void | [handle_node_gui_input](#method-handle_node_gui_input) ( `event`: [InputEvent](https://docs.godotengine.org/en/latest/classes/class_inputevent.html#class-inputevent) ) [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_input_blocked](#method-is_input_blocked) ( ) -void | [pause](#method-pause) ( ) -void | [post_install](#method-post_install) ( ) -void | [resume](#method-resume) ( ) -void | [start_autoskip_timer](#method-start_autoskip_timer) ( ) +void | [block_input](#method-block_input) ( `time`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.1` ) void | [stop_timers](#method-stop_timers) ( ) +void | [start_autoskip_timer](#method-start_autoskip_timer) ( ) +void | [effect_input](#method-effect_input) ( `_text_node`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `skipped`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool), `_argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +void | [effect_noskip](#method-effect_noskip) ( `text_node`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `skipped`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool), `argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +void | [effect_autoadvance](#method-effect_autoadvance) ( `_text_node`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `_skipped`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool), `argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) --- ## Signals -**signal [autoskip_timer_finished](#signal-autoskip_timer_finished) ( )** +**signal [dialogic_action_priority](#signal-dialogic_action_priority) ( )** - Whenever the Auto-Skip timer finishes, this signal is emitted. Configure Auto-Skip settings via `auto_skip`. + *No description available.* --- @@ -63,11 +64,11 @@ Returns | Method -**signal [dialogic_action_priority](#signal-dialogic_action_priority) ( )** +**signal [autoskip_timer_finished](#signal-autoskip_timer_finished) ( )** - *No description available.* + Whenever the Auto-Skip timer finishes, this signal is emitted. Configure Auto-Skip settings via `auto_skip`. --- @@ -75,7 +76,7 @@ Returns | Method -**var action_was_consumed = false** +**var input_block_timer = new()** @@ -85,7 +86,7 @@ Returns | Method -**var auto_advance = null** +**var action_was_consumed = false** @@ -105,7 +106,7 @@ Returns | Method -**var input_block_timer = ** +**var auto_advance = null** @@ -127,7 +128,7 @@ Returns | Method -**func [block_input](#method-block_input) ( `time`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.1` ) ⇒ void** +**func [clear_game_state](#method-clear_game_state) ( `_clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** @@ -137,7 +138,7 @@ Returns | Method -**func [clear_game_state](#method-clear_game_state) ( `_clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** +**func [pause](#method-pause) ( ) ⇒ void** @@ -147,7 +148,7 @@ Returns | Method -**func [effect_autoadvance](#method-effect_autoadvance) ( `text_node`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `skipped`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool), `argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** +**func [resume](#method-resume) ( ) ⇒ void** @@ -157,7 +158,7 @@ Returns | Method -**func [effect_input](#method-effect_input) ( `text_node`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `skipped`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool), `argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** +**func [post_install](#method-post_install) ( ) ⇒ void** @@ -167,7 +168,7 @@ Returns | Method -**func [effect_noskip](#method-effect_noskip) ( `text_node`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `skipped`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool), `argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** +**func [handle_input](#method-handle_input) ( ) ⇒ void** @@ -177,7 +178,7 @@ Returns | Method -**func [handle_input](#method-handle_input) ( ) ⇒ void** +**func [is_input_pressed](#method-is_input_pressed) ( `event`: [InputEvent](https://docs.godotengine.org/en/latest/classes/class_inputevent.html#class-inputevent), `exact`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** @@ -207,7 +208,7 @@ This is called from the gui_input of the InputCatcher and DialogText nodes -**func [pause](#method-pause) ( ) ⇒ void** +**func [block_input](#method-block_input) ( `time`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.1` ) ⇒ void** @@ -217,7 +218,7 @@ This is called from the gui_input of the InputCatcher and DialogText nodes -**func [post_install](#method-post_install) ( ) ⇒ void** +**func [stop_timers](#method-stop_timers) ( ) ⇒ void** @@ -227,7 +228,17 @@ This is called from the gui_input of the InputCatcher and DialogText nodes -**func [resume](#method-resume) ( ) ⇒ void** +**func [start_autoskip_timer](#method-start_autoskip_timer) ( ) ⇒ void** + + + +This method will advance the timeline based on Auto-Skip settings. The state, whether Auto-Skip is enabled, is ignored. + +--- + + + +**func [effect_input](#method-effect_input) ( `_text_node`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `skipped`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool), `_argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** @@ -237,17 +248,17 @@ This is called from the gui_input of the InputCatcher and DialogText nodes -**func [start_autoskip_timer](#method-start_autoskip_timer) ( ) ⇒ void** +**func [effect_noskip](#method-effect_noskip) ( `text_node`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `skipped`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool), `argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** -This method will advance the timeline based on Auto-Skip settings. The state, whether Auto-Skip is enabled, is ignored. + *No description available.* --- -**func [stop_timers](#method-stop_timers) ( ) ⇒ void** +**func [effect_autoadvance](#method-effect_autoadvance) ( `_text_node`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `_skipped`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool), `argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** diff --git a/documentation/classes/subsystem_jump.md b/documentation/classes/subsystem_jump.md index 71f4be9..4d6f698 100644 --- a/documentation/classes/subsystem_jump.md +++ b/documentation/classes/subsystem_jump.md @@ -14,20 +14,20 @@ ## Methods Returns | Method --- | --- -void | [clear_game_state](#method-clear_game_state) ( `clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) -[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_last_label_identifier](#method-get_last_label_identifier) ( ) -[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_last_label_name](#method-get_last_label_name) ( ) -[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_jump_stack_empty](#method-is_jump_stack_empty) ( ) +void | [clear_game_state](#method-clear_game_state) ( `_clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) +void | [load_game_state](#method-load_game_state) ( `_load_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) void | [jump_to_label](#method-jump_to_label) ( `label`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -void | [load_game_state](#method-load_game_state) ( `load_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) void | [push_to_jump_stack](#method-push_to_jump_stack) ( ) void | [resume_from_last_jump](#method-resume_from_last_jump) ( ) +[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_jump_stack_empty](#method-is_jump_stack_empty) ( ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_last_label_identifier](#method-get_last_label_identifier) ( ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_last_label_name](#method-get_last_label_name) ( ) --- ## Signals -**signal [jumped_to_label](#signal-jumped_to_label) ( `info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) )** +**signal [switched_timeline](#signal-switched_timeline) ( `info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) )** @@ -37,7 +37,7 @@ Returns | Method -**signal [passed_label](#signal-passed_label) ( `info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) )** +**signal [jumped_to_label](#signal-jumped_to_label) ( `info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) )** @@ -57,7 +57,7 @@ Returns | Method -**signal [switched_timeline](#signal-switched_timeline) ( `info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) )** +**signal [passed_label](#signal-passed_label) ( `info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) )** @@ -69,7 +69,7 @@ Returns | Method -**func [clear_game_state](#method-clear_game_state) ( `clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** +**func [clear_game_state](#method-clear_game_state) ( `_clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** @@ -79,27 +79,27 @@ Returns | Method -**func [get_last_label_identifier](#method-get_last_label_identifier) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [load_game_state](#method-load_game_state) ( `_load_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** -Returns the identifier name of the last passed label + *No description available.* --- -**func [get_last_label_name](#method-get_last_label_name) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [jump_to_label](#method-jump_to_label) ( `label`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** -Returns the display name of the last passed label (translated if translation are enabled) + *No description available.* --- -**func [is_jump_stack_empty](#method-is_jump_stack_empty) ( ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [push_to_jump_stack](#method-push_to_jump_stack) ( ) ⇒ void** @@ -109,7 +109,7 @@ Returns the display name of the last passed label (translated if translation are -**func [jump_to_label](#method-jump_to_label) ( `label`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** +**func [resume_from_last_jump](#method-resume_from_last_jump) ( ) ⇒ void** @@ -119,7 +119,7 @@ Returns the display name of the last passed label (translated if translation are -**func [load_game_state](#method-load_game_state) ( `load_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** +**func [is_jump_stack_empty](#method-is_jump_stack_empty) ( ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** @@ -129,21 +129,21 @@ Returns the display name of the last passed label (translated if translation are -**func [push_to_jump_stack](#method-push_to_jump_stack) ( ) ⇒ void** +**func [get_last_label_identifier](#method-get_last_label_identifier) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** - *No description available.* +Returns the identifier name of the last passed label --- -**func [resume_from_last_jump](#method-resume_from_last_jump) ( ) ⇒ void** +**func [get_last_label_name](#method-get_last_label_name) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** - *No description available.* +Returns the display name of the last passed label (translated if translation are enabled) --- diff --git a/documentation/classes/subsystem_portraits.md b/documentation/classes/subsystem_portraits.md index c66978e..39ba829 100644 --- a/documentation/classes/subsystem_portraits.md +++ b/documentation/classes/subsystem_portraits.md @@ -8,43 +8,41 @@ # subsystem_Portraits **Inherits:** [DialogicSubsystem](class_dialogicsubsystem.md) -Subsystem that manages portraits and portrait positions. +Emitted when a portrait starts animating. ## Properties Name | Type | Default --- | --- | --- -[default_portrait_scene](#property-default_portrait_scene) | [PackedScene](https://docs.godotengine.org/en/latest/classes/class_packedscene.html#class-packedscene) | +[default_portrait_scene](#property-default_portrait_scene) | [PackedScene](https://docs.godotengine.org/en/latest/classes/class_packedscene.html#class-packedscene) | `load(...)` --- ## Methods Returns | Method --- | --- -[Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) | [add_character](#method-add_character) ( `character`: [DialogicCharacter](class_dialogiccharacter.md), `portrait`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `position_idx`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) -void | [add_portrait_position](#method-add_portrait_position) ( `position_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int), `position`: [Vector2](https://docs.godotengine.org/en/latest/classes/class_vector2.html#class-vector2) ) -[DialogicAnimation](class_dialogicanimation.md) | [animate_character](#method-animate_character) ( `character`: [DialogicCharacter](class_dialogiccharacter.md), `animation_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `length`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float), `repeats`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `1` ) -void | [change_character_extradata](#method-change_character_extradata) ( `character`: [DialogicCharacter](class_dialogiccharacter.md), `extra_data`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) +void | [clear_game_state](#method-clear_game_state) ( `_clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) +void | [load_game_state](#method-load_game_state) ( `_load_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) +void | [pause](#method-pause) ( ) +void | [resume](#method-resume) ( ) +[DialogicPortrait](class_dialogicportrait.md) | [get_character_portrait](#method-get_character_portrait) ( `character`: [DialogicCharacter](class_dialogiccharacter.md) ) +[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [z_sort_portrait_containers](#method-z_sort_portrait_containers) ( `con1`: [DialogicNode_PortraitContainer](class_dialogicnode_portraitcontainer.md), `con2`: [DialogicNode_PortraitContainer](class_dialogicnode_portraitcontainer.md) ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_valid_portrait](#method-get_valid_portrait) ( `character`: [DialogicCharacter](class_dialogiccharacter.md), `portrait`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) | [join_character](#method-join_character) ( `character`: [DialogicCharacter](class_dialogiccharacter.md), `portrait`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `position_id`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `mirrored`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false`, `z_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0`, `extra_data`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `animation_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `animation_length`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.0`, `animation_wait`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) +[Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) | [add_character](#method-add_character) ( `character`: [DialogicCharacter](class_dialogiccharacter.md), `container`: [DialogicNode_PortraitContainer](class_dialogicnode_portraitcontainer.md), `portrait`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `position_id`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +void | [change_character_portrait](#method-change_character_portrait) ( `character`: [DialogicCharacter](class_dialogiccharacter.md), `portrait`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `fade_animation`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `"DEFAULT"`, `fade_length`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `-1.0` ) void | [change_character_mirror](#method-change_character_mirror) ( `character`: [DialogicCharacter](class_dialogiccharacter.md), `mirrored`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false`, `force`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) -void | [change_character_portrait](#method-change_character_portrait) ( `character`: [DialogicCharacter](class_dialogiccharacter.md), `portrait`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `update_transform`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true` ) void | [change_character_z_index](#method-change_character_z_index) ( `character`: [DialogicCharacter](class_dialogiccharacter.md), `z_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int), `update_zindex`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true` ) -void | [change_speaker](#method-change_speaker) ( `speaker`: [DialogicCharacter](class_dialogiccharacter.md) = `null`, `portrait`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) -void | [clear_game_state](#method-clear_game_state) ( `clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) -[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_character_info](#method-get_character_info) ( `character`: [DialogicCharacter](class_dialogiccharacter.md) ) -[DialogicCharacter[]](https://docs.godotengine.org/en/latest/classes/class_dialogiccharacter.html#class-dialogiccharacter) | [get_joined_characters](#method-get_joined_characters) ( ) -[DialogicNode_PortraitContainer](class_dialogicnode_portraitcontainer.md) | [get_portrait_container](#method-get_portrait_container) ( `postion_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) -[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_valid_portrait](#method-get_valid_portrait) ( `character`: [DialogicCharacter](class_dialogiccharacter.md), `portrait`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_character_joined](#method-is_character_joined) ( `character`: [DialogicCharacter](class_dialogiccharacter.md) ) -[Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) | [join_character](#method-join_character) ( `character`: [DialogicCharacter](class_dialogiccharacter.md), `portrait`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `position_idx`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int), `mirrored`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false`, `z_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0`, `extra_data`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `animation_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `animation_length`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.0`, `animation_wait`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) -void | [leave_all_characters](#method-leave_all_characters) ( `animation_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `animation_length`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.0`, `animation_wait`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) +void | [change_character_extradata](#method-change_character_extradata) ( `character`: [DialogicCharacter](class_dialogiccharacter.md), `extra_data`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) +[DialogicAnimation](class_dialogicanimation.md) | [animate_character](#method-animate_character) ( `character`: [DialogicCharacter](class_dialogiccharacter.md), `animation_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `length`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float), `repeats`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `1`, `is_reversed`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) +void | [move_character](#method-move_character) ( `character`: [DialogicCharacter](class_dialogiccharacter.md), `position_id`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `time`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.0`, `easing`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `2`, `trans`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `1` ) void | [leave_character](#method-leave_character) ( `character`: [DialogicCharacter](class_dialogiccharacter.md), `animation_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `animation_length`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.0`, `animation_wait`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) -void | [load_game_state](#method-load_game_state) ( `load_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) -void | [move_character](#method-move_character) ( `character`: [DialogicCharacter](class_dialogiccharacter.md), `position_idx`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int), `time`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.0` ) -void | [move_portrait_position](#method-move_portrait_position) ( `position_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int), `vector`: [Vector2](https://docs.godotengine.org/en/latest/classes/class_vector2.html#class-vector2), `relative`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false`, `time`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.0` ) -void | [pause](#method-pause) ( ) +void | [leave_all_characters](#method-leave_all_characters) ( `animation_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `animation_length`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.0`, `animation_wait`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) +[Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) | [get_character_node](#method-get_character_node) ( `character`: [DialogicCharacter](class_dialogiccharacter.md) ) void | [remove_character](#method-remove_character) ( `character`: [DialogicCharacter](class_dialogiccharacter.md) ) -void | [reset_all_portrait_positions](#method-reset_all_portrait_positions) ( `time`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.0` ) -void | [reset_portrait_position](#method-reset_portrait_position) ( `position_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int), `time`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.0` ) -void | [resume](#method-resume) ( ) -void | [text_effect_portrait](#method-text_effect_portrait) ( `text_node`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `skipped`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool), `argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [z_sort_portrait_containers](#method-z_sort_portrait_containers) ( `con1`: [DialogicNode_PortraitContainer](class_dialogicnode_portraitcontainer.md), `con2`: [DialogicNode_PortraitContainer](class_dialogicnode_portraitcontainer.md) ) +[DialogicCharacter](class_dialogiccharacter.md) | [get_current_character](#method-get_current_character) ( ) +[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_character_joined](#method-is_character_joined) ( `character`: [DialogicCharacter](class_dialogiccharacter.md) ) +[DialogicCharacter[]](https://docs.godotengine.org/en/latest/classes/class_dialogiccharacter.html#class-dialogiccharacter) | [get_joined_characters](#method-get_joined_characters) ( ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_character_info](#method-get_character_info) ( `character`: [DialogicCharacter](class_dialogiccharacter.md) ) +void | [change_speaker](#method-change_speaker) ( `speaker`: [DialogicCharacter](class_dialogiccharacter.md) = `null`, `portrait`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) +void | [text_effect_portrait](#method-text_effect_portrait) ( `_text_node`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `_skipped`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool), `argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) --- ## Signals @@ -70,16 +68,6 @@ Returns | Method -**signal [character_moved](#signal-character_moved) ( `info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) )** - - - - *No description available.* - ---- - - - **signal [character_portrait_changed](#signal-character_portrait_changed) ( `info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) )** @@ -90,7 +78,7 @@ Returns | Method -**signal [position_changed](#signal-position_changed) ( `info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) )** +**signal [character_moved](#signal-character_moved) ( `info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) )** @@ -102,7 +90,7 @@ Returns | Method -**var default_portrait_scene = ** +**var default_portrait_scene = load(...)** @@ -114,7 +102,7 @@ The default portrait scene. -**func [add_character](#method-add_character) ( `character`: [DialogicCharacter](class_dialogiccharacter.md), `portrait`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `position_idx`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) ⇒ [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node)** +**func [clear_game_state](#method-clear_game_state) ( `_clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** @@ -124,77 +112,78 @@ The default portrait scene. -**func [add_portrait_position](#method-add_portrait_position) ( `position_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int), `position`: [Vector2](https://docs.godotengine.org/en/latest/classes/class_vector2.html#class-vector2) ) ⇒ void** +**func [load_game_state](#method-load_game_state) ( `_load_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** -Creates a new portrait container node. It will copy it's size and most settings from the first p_container in the tree. It will be added as a sibling of the first p_container in the tree. + *No description available.* --- -**func [animate_character](#method-animate_character) ( `character`: [DialogicCharacter](class_dialogiccharacter.md), `animation_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `length`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float), `repeats`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `1` ) ⇒ [DialogicAnimation](class_dialogicanimation.md)** +**func [pause](#method-pause) ( ) ⇒ void** -Starts the given animation on the given character. Only works with joined characters + *No description available.* --- -**func [change_character_extradata](#method-change_character_extradata) ( `character`: [DialogicCharacter](class_dialogiccharacter.md), `extra_data`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ void** +**func [resume](#method-resume) ( ) ⇒ void** -Changes the extra data on the given character. Only works with joined characters + *No description available.* --- -**func [change_character_mirror](#method-change_character_mirror) ( `character`: [DialogicCharacter](class_dialogiccharacter.md), `mirrored`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false`, `force`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ void** +**func [get_character_portrait](#method-get_character_portrait) ( `character`: [DialogicCharacter](class_dialogiccharacter.md) ) ⇒ [DialogicPortrait](class_dialogicportrait.md)** -Changes the mirror of the given character. Only works with joined characters +Checks if [para, character] has joined the scene, if so, returns its active node. The difference between an active and inactive nodes is whether the node is the latest node. +If a portrait is fading/animating from portrait A and B, both will exist in the scene, but only the new portrait is active, even if it is not fully visible yet. --- -**func [change_character_portrait](#method-change_character_portrait) ( `character`: [DialogicCharacter](class_dialogiccharacter.md), `portrait`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `update_transform`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true` ) ⇒ void** +**func [z_sort_portrait_containers](#method-z_sort_portrait_containers) ( `con1`: [DialogicNode_PortraitContainer](class_dialogicnode_portraitcontainer.md), `con2`: [DialogicNode_PortraitContainer](class_dialogicnode_portraitcontainer.md) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** -Changes the portrait of a character. Only works with joined characters. + *No description available.* --- -**func [change_character_z_index](#method-change_character_z_index) ( `character`: [DialogicCharacter](class_dialogiccharacter.md), `z_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int), `update_zindex`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true` ) ⇒ void** +**func [get_valid_portrait](#method-get_valid_portrait) ( `character`: [DialogicCharacter](class_dialogiccharacter.md), `portrait`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** -Changes the z_index of a character. Only works with joined characters +Checks multiple cases to return a valid portrait to use. --- -**func [change_speaker](#method-change_speaker) ( `speaker`: [DialogicCharacter](class_dialogiccharacter.md) = `null`, `portrait`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ void** +**func [join_character](#method-join_character) ( `character`: [DialogicCharacter](class_dialogiccharacter.md), `portrait`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `position_id`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `mirrored`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false`, `z_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0`, `extra_data`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `animation_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `animation_length`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.0`, `animation_wait`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node)** -Updates all portrait containers set to SPEAKER. +Adds a character at a position and sets it's portrait. If the character is already joined it will only update, portrait, position, etc. --- -**func [clear_game_state](#method-clear_game_state) ( `clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** +**func [add_character](#method-add_character) ( `character`: [DialogicCharacter](class_dialogiccharacter.md), `container`: [DialogicNode_PortraitContainer](class_dialogicnode_portraitcontainer.md), `portrait`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `position_id`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node)** @@ -204,71 +193,61 @@ Updates all portrait containers set to SPEAKER. -**func [get_character_info](#method-get_character_info) ( `character`: [DialogicCharacter](class_dialogiccharacter.md) ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** - - - -Returns a dictionary with info on a given character. Keys can be [joined, character, node (for the portrait node), position_index] Only joined is included (and false) for not joined characters - ---- - - - -**func [get_joined_characters](#method-get_joined_characters) ( ) ⇒ [DialogicCharacter[]](https://docs.godotengine.org/en/latest/classes/class_dialogiccharacter.html#class-dialogiccharacter)** +**func [change_character_portrait](#method-change_character_portrait) ( `character`: [DialogicCharacter](class_dialogiccharacter.md), `portrait`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `fade_animation`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `"DEFAULT"`, `fade_length`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `-1.0` ) ⇒ void** -Returns a list of the joined charcters (as resources) +Changes the portrait of a character. Only works with joined characters. --- -**func [get_portrait_container](#method-get_portrait_container) ( `postion_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) ⇒ [DialogicNode_PortraitContainer](class_dialogicnode_portraitcontainer.md)** +**func [change_character_mirror](#method-change_character_mirror) ( `character`: [DialogicCharacter](class_dialogiccharacter.md), `mirrored`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false`, `force`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ void** - *No description available.* +Changes the mirror of the given character. Only works with joined characters --- -**func [get_valid_portrait](#method-get_valid_portrait) ( `character`: [DialogicCharacter](class_dialogiccharacter.md), `portrait`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [change_character_z_index](#method-change_character_z_index) ( `character`: [DialogicCharacter](class_dialogiccharacter.md), `z_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int), `update_zindex`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true` ) ⇒ void** -Checks multiple cases to return a valid portrait to use. +Changes the z_index of a character. Only works with joined characters --- -**func [is_character_joined](#method-is_character_joined) ( `character`: [DialogicCharacter](class_dialogiccharacter.md) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [change_character_extradata](#method-change_character_extradata) ( `character`: [DialogicCharacter](class_dialogiccharacter.md), `extra_data`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ void** -Returns true if the given character is currently joined. +Changes the extra data on the given character. Only works with joined characters --- -**func [join_character](#method-join_character) ( `character`: [DialogicCharacter](class_dialogiccharacter.md), `portrait`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `position_idx`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int), `mirrored`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false`, `z_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0`, `extra_data`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `animation_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `animation_length`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.0`, `animation_wait`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node)** +**func [animate_character](#method-animate_character) ( `character`: [DialogicCharacter](class_dialogiccharacter.md), `animation_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `length`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float), `repeats`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `1`, `is_reversed`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ [DialogicAnimation](class_dialogicanimation.md)** -Adds a character at a position and sets it's portrait. If the character is already joined it will only update, portrait, position, etc. +Starts the given animation on the given character. Only works with joined characters --- -**func [leave_all_characters](#method-leave_all_characters) ( `animation_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `animation_length`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.0`, `animation_wait`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ void** +**func [move_character](#method-move_character) ( `character`: [DialogicCharacter](class_dialogiccharacter.md), `position_id`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `time`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.0`, `easing`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `2`, `trans`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `1` ) ⇒ void** -Removes all joined characters with a given animation or the default animation. +Moves the given character to the given position. Only works with joined characters --- @@ -284,37 +263,37 @@ Removes a character with a given animation or the default animation. -**func [load_game_state](#method-load_game_state) ( `load_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** +**func [leave_all_characters](#method-leave_all_characters) ( `animation_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `animation_length`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.0`, `animation_wait`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ void** - *No description available.* +Removes all joined characters with a given animation or the default animation. --- -**func [move_character](#method-move_character) ( `character`: [DialogicCharacter](class_dialogiccharacter.md), `position_idx`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int), `time`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.0` ) ⇒ void** +**func [get_character_node](#method-get_character_node) ( `character`: [DialogicCharacter](class_dialogiccharacter.md) ) ⇒ [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node)** -Moves the given character to the given position. Only works with joined characters +Finds the character node for a `character`. Return `null` if the `character` is not part of the scene. --- -**func [move_portrait_position](#method-move_portrait_position) ( `position_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int), `vector`: [Vector2](https://docs.godotengine.org/en/latest/classes/class_vector2.html#class-vector2), `relative`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false`, `time`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.0` ) ⇒ void** +**func [remove_character](#method-remove_character) ( `character`: [DialogicCharacter](class_dialogiccharacter.md) ) ⇒ void** - *No description available.* +Removes the given characters portrait. Only works with joined characters. --- -**func [pause](#method-pause) ( ) ⇒ void** +**func [get_current_character](#method-get_current_character) ( ) ⇒ [DialogicCharacter](class_dialogiccharacter.md)** @@ -324,47 +303,47 @@ Moves the given character to the given position. Only works with joined characte -**func [remove_character](#method-remove_character) ( `character`: [DialogicCharacter](class_dialogiccharacter.md) ) ⇒ void** +**func [is_character_joined](#method-is_character_joined) ( `character`: [DialogicCharacter](class_dialogiccharacter.md) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** -Removes the given characters portrait. Only works with joined characters +Returns true if the given character is currently joined. --- -**func [reset_all_portrait_positions](#method-reset_all_portrait_positions) ( `time`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.0` ) ⇒ void** +**func [get_joined_characters](#method-get_joined_characters) ( ) ⇒ [DialogicCharacter[]](https://docs.godotengine.org/en/latest/classes/class_dialogiccharacter.html#class-dialogiccharacter)** - *No description available.* +Returns a list of the joined charcters (as resources) --- -**func [reset_portrait_position](#method-reset_portrait_position) ( `position_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int), `time`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `0.0` ) ⇒ void** +**func [get_character_info](#method-get_character_info) ( `character`: [DialogicCharacter](class_dialogiccharacter.md) ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** - *No description available.* +Returns a dictionary with info on a given character. Keys can be [joined, character, node (for the portrait node), position_id] Only joined is included (and false) for not joined characters --- -**func [resume](#method-resume) ( ) ⇒ void** +**func [change_speaker](#method-change_speaker) ( `speaker`: [DialogicCharacter](class_dialogiccharacter.md) = `null`, `portrait`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ void** - *No description available.* +Updates all portrait containers set to SPEAKER. --- -**func [text_effect_portrait](#method-text_effect_portrait) ( `text_node`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `skipped`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool), `argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** +**func [text_effect_portrait](#method-text_effect_portrait) ( `_text_node`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `_skipped`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool), `argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** @@ -372,13 +351,3 @@ Called from the [portrait=something] text effect. --- - - -**func [z_sort_portrait_containers](#method-z_sort_portrait_containers) ( `con1`: [DialogicNode_PortraitContainer](class_dialogicnode_portraitcontainer.md), `con2`: [DialogicNode_PortraitContainer](class_dialogicnode_portraitcontainer.md) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** - - - - *No description available.* - ---- - diff --git a/documentation/classes/subsystem_save.md b/documentation/classes/subsystem_save.md index 5e74a75..36ea255 100644 --- a/documentation/classes/subsystem_save.md +++ b/documentation/classes/subsystem_save.md @@ -15,39 +15,41 @@ This subsystem has many different helper methods to save Dialogic or custom game ## Properties Name | Type | Default --- | --- | --- +[latest_thumbnail](#property-latest_thumbnail) | [Image](https://docs.godotengine.org/en/latest/classes/class_image.html#class-image) | `null` [autosave_enabled](#property-autosave_enabled) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` [autosave_mode](#property-autosave_mode) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `0` [autosave_time](#property-autosave_time) | [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | `60` -[autosave_timer](#property-autosave_timer) | [Timer](https://docs.godotengine.org/en/latest/classes/class_timer.html#class-timer) | -[latest_thumbnail](#property-latest_thumbnail) | [Image](https://docs.godotengine.org/en/latest/classes/class_image.html#class-image) | `null` +[autosave_timer](#property-autosave_timer) | [Timer](https://docs.godotengine.org/en/latest/classes/class_timer.html#class-timer) | `new()` --- ## Methods Returns | Method --- | --- -[int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | [add_empty_slot](#method-add_empty_slot) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) void | [clear_game_state](#method-clear_game_state) ( `_clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) -[int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | [delete_slot](#method-delete_slot) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_default_slot](#method-get_default_slot) ( ) -[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_encryption_password](#method-get_encryption_password) ( ) +void | [pause](#method-pause) ( ) +void | [resume](#method-resume) ( ) +[int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | [save](#method-save) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `is_autosave`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false`, `thumbnail_mode`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `1`, `slot_info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) = `{}` ) +[int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | [load](#method-load) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) +[int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | [save_file](#method-save_file) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `file_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `data`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) +[Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) | [load_file](#method-load_file) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `file_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `default`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) +[int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | [set_global_info](#method-set_global_info) ( `key`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `value`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) | [get_global_info](#method-get_global_info) ( `key`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `default`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) -[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_latest_slot](#method-get_latest_slot) ( ) -[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_slot_info](#method-get_slot_info) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_encryption_password](#method-get_encryption_password) ( ) [String[]](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_slot_names](#method-get_slot_names) ( ) -[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_slot_path](#method-get_slot_path) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[ImageTexture](https://docs.godotengine.org/en/latest/classes/class_imagetexture.html#class-imagetexture) | [get_slot_thumbnail](#method-get_slot_thumbnail) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [has_slot](#method-has_slot) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | [load](#method-load) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) -[Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) | [load_file](#method-load_file) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `file_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `default`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) -[int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | [perform_autosave](#method-perform_autosave) ( ) +[int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | [delete_slot](#method-delete_slot) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | [add_empty_slot](#method-add_empty_slot) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | [reset_slot](#method-reset_slot) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) -[int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | [save](#method-save) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `is_autosave`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false`, `thumbnail_mode`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `1`, `slot_info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) = `` ) -[int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | [save_file](#method-save_file) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `file_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `data`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) -[int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | [save_slot_thumbnail](#method-save_slot_thumbnail) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | [set_global_info](#method-set_global_info) ( `key`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `value`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_slot_path](#method-get_slot_path) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_default_slot](#method-get_default_slot) ( ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_latest_slot](#method-get_latest_slot) ( ) [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | [set_latest_slot](#method-set_latest_slot) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | [set_slot_info](#method-set_slot_info) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_slot_info](#method-get_slot_info) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) void | [take_thumbnail](#method-take_thumbnail) ( ) +[int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | [save_slot_thumbnail](#method-save_slot_thumbnail) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[ImageTexture](https://docs.godotengine.org/en/latest/classes/class_imagetexture.html#class-imagetexture) | [get_slot_thumbnail](#method-get_slot_thumbnail) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) | [perform_autosave](#method-perform_autosave) ( ) --- ## Constants @@ -79,6 +81,15 @@ Returns | Method --- +**const AUTO_SAVE_TIME_SETTINGS = "dialogic/save/autosave_delay"** + + + + *No description available.* + +--- + + **const NONE = 0** @@ -152,6 +163,16 @@ Key | Value Type | Value +**var latest_thumbnail = null** + + + + *No description available.* + +--- + + + **var autosave_enabled = false** @@ -182,7 +203,7 @@ After what time interval the auto-save feature will trigger if `autosave_enabled -**var autosave_timer = ** +**var autosave_timer = new()** @@ -190,31 +211,31 @@ After what time interval the auto-save feature will trigger if `autosave_enabled --- +## Method Descriptions -**var latest_thumbnail = null** +**func [clear_game_state](#method-clear_game_state) ( `_clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** - *No description available.* + +Built-in, called by DialogicGameHandler. --- -## Method Descriptions +**func [pause](#method-pause) ( ) ⇒ void** -**func [add_empty_slot](#method-add_empty_slot) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int)** - -This adds a new save folder with the given name +Built-in, called by DialogicGameHandler. --- -**func [clear_game_state](#method-clear_game_state) ( `_clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** +**func [resume](#method-resume) ( ) ⇒ void** @@ -224,61 +245,71 @@ Built-in, called by DialogicGameHandler. -**func [delete_slot](#method-delete_slot) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int)** +**func [save](#method-save) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `is_autosave`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false`, `thumbnail_mode`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `1`, `slot_info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) = `{}` ) ⇒ [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int)** -Removes all the given slot along with all it's info/files. +Saves the current state to the given slot. If no slot is given, the default slot is used. You can change this name in the Dialogic editor. If you want to save to the last used slot, you can get its slot name with the [method get_latest_slot()] method. --- -**func [get_default_slot](#method-get_default_slot) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [load](#method-load) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int)** -Returns the default slot name defined in the dialogic settings +Loads all info from the given slot in the DialogicGameHandler (Dialogic Autoload). If no slot is given, the default slot is used. To check if something is saved in that slot use has_slot(). If the slot does not exist, this method will fail. --- -**func [get_encryption_password](#method-get_encryption_password) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [save_file](#method-save_file) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `file_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `data`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) ⇒ [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int)** -Gets the encryption password from the project settings if it has been set. If no password has been set, an empty string is returned. +Saves a variable to a file in the given slot. Be aware, the `slot_name` will be used as a filesystem folder name. Some operating systems do not support every character in folder names. It is recommended to use only letters, numbers, and underscores. This method allows you to build your own save and load system. You may be looking for the simple [save](#property-save) method to save the game state. --- -**func [get_global_info](#method-get_global_info) ( `key`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `default`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) ⇒ [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant)** +**func [load_file](#method-load_file) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `file_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `default`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) ⇒ [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant)** -Access the data unrelated to a save slot. First, the data must have been set with [set_global_info](#property-set_global_info). +Loads a file using `slot_name` and returns the contained info. This method allows you to build your own save and load system. You may be looking for the simple [load](#property-load) method to load the game state. --- -**func [get_latest_slot](#method-get_latest_slot) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [set_global_info](#method-set_global_info) ( `key`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `value`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) ⇒ [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int)** -Returns the latest slot or empty if nothing was saved yet +Data set in global info can be accessed unrelated to the save slots. For instance, you may want to store game settings in here, as they affect the game globally unrelated to the slot used. --- -**func [get_slot_info](#method-get_slot_info) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [get_global_info](#method-get_global_info) ( `key`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `default`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) ⇒ [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant)** - *No description available.* +Access the data unrelated to a save slot. First, the data must have been set with [set_global_info](#property-set_global_info). + +--- + + + +**func [get_encryption_password](#method-get_encryption_password) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** + + + +Gets the encryption password from the project settings if it has been set. If no password has been set, an empty string is returned. --- @@ -294,141 +325,141 @@ Returns the latest slot or empty if nothing was saved yet -**func [get_slot_path](#method-get_slot_path) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [has_slot](#method-has_slot) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** -Returns the full path to the given slot folder +Returns true if the given slot exists. --- -**func [get_slot_thumbnail](#method-get_slot_thumbnail) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [ImageTexture](https://docs.godotengine.org/en/latest/classes/class_imagetexture.html#class-imagetexture)** +**func [delete_slot](#method-delete_slot) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int)** -Returns the thumbnail of the given slot. +Removes all the given slot along with all it's info/files. --- -**func [has_slot](#method-has_slot) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [add_empty_slot](#method-add_empty_slot) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int)** -Returns true if the given slot exists. +This adds a new save folder with the given name --- -**func [load](#method-load) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int)** +**func [reset_slot](#method-reset_slot) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int)** -Loads all info from the given slot in the DialogicGameHandler (Dialogic Autoload). If no slot is given, the default slot is used. To check if something is saved in that slot use has_slot(). If the slot does not exist, this method will fail. +Reset the state of the given save folder (or default) --- -**func [load_file](#method-load_file) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `file_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `default`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) ⇒ [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant)** +**func [get_slot_path](#method-get_slot_path) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** -Loads a file using `slot_name` and returns the contained info. This method allows you to build your own save and load system. You may be looking for the simple [load](#property-load) method to load the game state. +Returns the full path to the given slot folder --- -**func [perform_autosave](#method-perform_autosave) ( ) ⇒ [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int)** +**func [get_default_slot](#method-get_default_slot) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** -Perform an autosave. This method will be called automatically if the auto-save mode is enabled. +Returns the default slot name defined in the dialogic settings --- -**func [reset_slot](#method-reset_slot) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int)** +**func [get_latest_slot](#method-get_latest_slot) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** -Reset the state of the given save folder (or default) +Returns the latest slot or empty if nothing was saved yet --- -**func [save](#method-save) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `is_autosave`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false`, `thumbnail_mode`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `1`, `slot_info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) = `` ) ⇒ [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int)** +**func [set_latest_slot](#method-set_latest_slot) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int)** -Saves the current state to the given slot. If no slot is given, the default slot is used. You can change this name in the Dialogic editor. If you want to save to the last used slot, you can get its slot name with the [method get_latest_slot()] method. + *No description available.* --- -**func [save_file](#method-save_file) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `file_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `data`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) ⇒ [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int)** +**func [set_slot_info](#method-set_slot_info) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) ) ⇒ [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int)** -Saves a variable to a file in the given slot. Be aware, the `slot_name` will be used as a filesystem folder name. Some operating systems do not support every character in folder names. It is recommended to use only letters, numbers, and underscores. This method allows you to build your own save and load system. You may be looking for the simple [save](#property-save) method to save the game state. + *No description available.* --- -**func [save_slot_thumbnail](#method-save_slot_thumbnail) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int)** +**func [get_slot_info](#method-get_slot_info) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** -No need to call from outside. Used to store the latest thumbnail to the given slot. + *No description available.* --- -**func [set_global_info](#method-set_global_info) ( `key`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `value`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) ⇒ [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int)** +**func [take_thumbnail](#method-take_thumbnail) ( ) ⇒ void** -Data set in global info can be accessed unrelated to the save slots. For instance, you may want to store game settings in here, as they affect the game globally unrelated to the slot used. +This method creates a thumbnail of the current game view, it allows to save the game without having the UI on the save slot image. The thumbnail will be stored in `latest_thumbnail`. Call this method before opening your save & load menu. After that, call [save](#property-save) with [constant ThumbnailMode.STORE_ONLY]. The [save](#property-save) will automatically use the stored thumbnail. --- -**func [set_latest_slot](#method-set_latest_slot) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int)** +**func [save_slot_thumbnail](#method-save_slot_thumbnail) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int)** - *No description available.* +No need to call from outside. Used to store the latest thumbnail to the given slot. --- -**func [set_slot_info](#method-set_slot_info) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) ) ⇒ [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int)** +**func [get_slot_thumbnail](#method-get_slot_thumbnail) ( `slot_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [ImageTexture](https://docs.godotengine.org/en/latest/classes/class_imagetexture.html#class-imagetexture)** - *No description available.* +Returns the thumbnail of the given slot. --- -**func [take_thumbnail](#method-take_thumbnail) ( ) ⇒ void** +**func [perform_autosave](#method-perform_autosave) ( ) ⇒ [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int)** -This method creates a thumbnail of the current game view, it allows to save the game without having the UI on the save slot image. The thumbnail will be stored in `latest_thumbnail`. Call this method before opening your save & load menu. After that, call [save](#property-save) with [constant ThumbnailMode.STORE_ONLY]. The [save](#property-save) will automatically use the stored thumbnail. +Perform an autosave. This method will be called automatically if the auto-save mode is enabled. --- diff --git a/documentation/classes/subsystem_settings.md b/documentation/classes/subsystem_settings.md index cd2dbcd..aeab118 100644 --- a/documentation/classes/subsystem_settings.md +++ b/documentation/classes/subsystem_settings.md @@ -12,24 +12,24 @@ ## Properties Name | Type | Default --- | --- | --- -[settings](#property-settings) | [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | +[settings](#property-settings) | [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | `{}` --- ## Methods Returns | Method --- | --- -void | [clear_game_state](#method-clear_game_state) ( `clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) -void | [connect_to_change](#method-connect_to_change) ( `setting`: [StringName](https://docs.godotengine.org/en/latest/classes/class_stringname.html#class-stringname), `callable`: [Callable](https://docs.godotengine.org/en/latest/classes/class_callable.html#class-callable) ) +void | [clear_game_state](#method-clear_game_state) ( `_clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) | [get_setting](#method-get_setting) ( `property`: [StringName](https://docs.godotengine.org/en/latest/classes/class_stringname.html#class-stringname), `default`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [has_setting](#method-has_setting) ( `property`: [StringName](https://docs.godotengine.org/en/latest/classes/class_stringname.html#class-stringname) ) void | [reset_all](#method-reset_all) ( ) void | [reset_setting](#method-reset_setting) ( `property`: [StringName](https://docs.godotengine.org/en/latest/classes/class_stringname.html#class-stringname) ) +void | [connect_to_change](#method-connect_to_change) ( `property`: [StringName](https://docs.godotengine.org/en/latest/classes/class_stringname.html#class-stringname), `callable`: [Callable](https://docs.godotengine.org/en/latest/classes/class_callable.html#class-callable) ) --- ## Property Descriptions -**var settings = ** +**var settings = {}** @@ -41,7 +41,7 @@ Returns | Method -**func [clear_game_state](#method-clear_game_state) ( `clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** +**func [clear_game_state](#method-clear_game_state) ( `_clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** @@ -51,27 +51,27 @@ Built-in, called by DialogicGameHandler. -**func [connect_to_change](#method-connect_to_change) ( `setting`: [StringName](https://docs.godotengine.org/en/latest/classes/class_stringname.html#class-stringname), `callable`: [Callable](https://docs.godotengine.org/en/latest/classes/class_callable.html#class-callable) ) ⇒ void** +**func [get_setting](#method-get_setting) ( `property`: [StringName](https://docs.godotengine.org/en/latest/classes/class_stringname.html#class-stringname), `default`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) ⇒ [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant)** - *No description available.* +Get a setting named `property`, if it does not exist, falls back to `default`. --- -**func [get_setting](#method-get_setting) ( `property`: [StringName](https://docs.godotengine.org/en/latest/classes/class_stringname.html#class-stringname), `default`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) ⇒ [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant)** +**func [has_setting](#method-has_setting) ( `property`: [StringName](https://docs.godotengine.org/en/latest/classes/class_stringname.html#class-stringname) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** - *No description available.* +Whether a setting has been set/stored before. --- -**func [has_setting](#method-has_setting) ( `property`: [StringName](https://docs.godotengine.org/en/latest/classes/class_stringname.html#class-stringname) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [reset_all](#method-reset_all) ( ) ⇒ void** @@ -81,7 +81,7 @@ Built-in, called by DialogicGameHandler. -**func [reset_all](#method-reset_all) ( ) ⇒ void** +**func [reset_setting](#method-reset_setting) ( `property`: [StringName](https://docs.godotengine.org/en/latest/classes/class_stringname.html#class-stringname) ) ⇒ void** @@ -91,11 +91,11 @@ Built-in, called by DialogicGameHandler. -**func [reset_setting](#method-reset_setting) ( `property`: [StringName](https://docs.godotengine.org/en/latest/classes/class_stringname.html#class-stringname) ) ⇒ void** +**func [connect_to_change](#method-connect_to_change) ( `property`: [StringName](https://docs.godotengine.org/en/latest/classes/class_stringname.html#class-stringname), `callable`: [Callable](https://docs.godotengine.org/en/latest/classes/class_callable.html#class-callable) ) ⇒ void** - *No description available.* +If a setting named `property` changes its value, this will emit `Callable`. --- diff --git a/documentation/classes/subsystem_styles.md b/documentation/classes/subsystem_styles.md index 4e0206d..dc424f2 100644 --- a/documentation/classes/subsystem_styles.md +++ b/documentation/classes/subsystem_styles.md @@ -14,15 +14,16 @@ ## Methods Returns | Method --- | --- -void | [clear_game_state](#method-clear_game_state) ( `clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) +void | [clear_game_state](#method-clear_game_state) ( `_clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) +void | [load_game_state](#method-load_game_state) ( `load_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) +[Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) | [change_style](#method-change_style) ( `style_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `is_base_style`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true` ) +[Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) | [load_style](#method-load_style) ( `style_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `parent`: [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) = `null`, `is_base_style`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true`, `state_reload`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) [DialogicLayoutBase](class_dialogiclayoutbase.md) | [create_layout](#method-create_layout) ( `style`: [DialogicStyle](class_dialogicstyle.md), `parent`: [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) = `null` ) +void | [reload_current_info_into_new_style](#method-reload_current_info_into_new_style) ( ) [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_current_style](#method-get_current_style) ( ) -[Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) | [get_first_node_in_layout](#method-get_first_node_in_layout) ( `group_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) | [get_layout_node](#method-get_layout_node) ( ) [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [has_active_layout_node](#method-has_active_layout_node) ( ) -void | [load_game_state](#method-load_game_state) ( `load_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) -[Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) | [load_style](#method-load_style) ( `style_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `parent`: [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) = `null`, `is_base_style`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true` ) -void | [reload_current_info_into_new_style](#method-reload_current_info_into_new_style) ( ) +[Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) | [get_layout_node](#method-get_layout_node) ( ) +[Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) | [get_first_node_in_layout](#method-get_first_node_in_layout) ( `group_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) --- ## Signals @@ -40,7 +41,7 @@ Returns | Method -**func [clear_game_state](#method-clear_game_state) ( `clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** +**func [clear_game_state](#method-clear_game_state) ( `_clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** @@ -50,57 +51,68 @@ Returns | Method -**func [create_layout](#method-create_layout) ( `style`: [DialogicStyle](class_dialogicstyle.md), `parent`: [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) = `null` ) ⇒ [DialogicLayoutBase](class_dialogiclayoutbase.md)** +**func [load_game_state](#method-load_game_state) ( `load_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** -Method that adds a layout scene with all the necessary layers. The layout scene will be added to the tree root and returned. + *No description available.* --- -**func [get_current_style](#method-get_current_style) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [change_style](#method-change_style) ( `style_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `is_base_style`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true` ) ⇒ [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node)** -Returns the style currently in use +This helper method calls load_style, but with the `state_reload` as true, which is commonly wanted if you expect a game to already be in progress. --- -**func [get_first_node_in_layout](#method-get_first_node_in_layout) ( `group_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node)** +**func [load_style](#method-load_style) ( `style_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `parent`: [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) = `null`, `is_base_style`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true`, `state_reload`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node)** -Similar to get_tree().get_first_node_in_group('group_name') but filtered to the active layout node subtree +Loads a style. Consider using the simpler [change_style](#property-change_style) if you want to change the style while another style is already in use. + If `state_reload` is true, the current state will be loaded into a new layout scenes nodes. That should not be done before calling start() or load() as it would be unnecessary or cause double-loading. --- -**func [get_layout_node](#method-get_layout_node) ( ) ⇒ [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node)** +**func [create_layout](#method-create_layout) ( `style`: [DialogicStyle](class_dialogicstyle.md), `parent`: [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) = `null` ) ⇒ [DialogicLayoutBase](class_dialogiclayoutbase.md)** - *No description available.* +Method that adds a layout scene with all the necessary layers. The layout scene will be added to the tree root and returned. --- -**func [has_active_layout_node](#method-has_active_layout_node) ( ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [reload_current_info_into_new_style](#method-reload_current_info_into_new_style) ( ) ⇒ void** - *No description available.* +When changing to a different layout scene, we have to load all the info from the current_state_info (basically --- -**func [load_game_state](#method-load_game_state) ( `load_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** +**func [get_current_style](#method-get_current_style) ( ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** + + + +Returns the style currently in use + +--- + + + +**func [has_active_layout_node](#method-has_active_layout_node) ( ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** @@ -110,7 +122,7 @@ Similar to get_tree().get_first_node_in_group('group_name') but filtered to the -**func [load_style](#method-load_style) ( `style_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `parent`: [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) = `null`, `is_base_style`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true` ) ⇒ [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node)** +**func [get_layout_node](#method-get_layout_node) ( ) ⇒ [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node)** @@ -120,11 +132,11 @@ Similar to get_tree().get_first_node_in_group('group_name') but filtered to the -**func [reload_current_info_into_new_style](#method-reload_current_info_into_new_style) ( ) ⇒ void** +**func [get_first_node_in_layout](#method-get_first_node_in_layout) ( `group_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node)** -When changing to a different layout scene, we have to load all the info from the current_state_info (basically +Similar to get_tree().get_first_node_in_group('group_name') but filtered to the active layout node subtree --- diff --git a/documentation/classes/subsystem_text.md b/documentation/classes/subsystem_text.md index de92e19..fe0a7ed 100644 --- a/documentation/classes/subsystem_text.md +++ b/documentation/classes/subsystem_text.md @@ -12,57 +12,58 @@ Subsystem that handles showing of dialog text (+text effects & modifiers), name ## Properties Name | Type | Default --- | --- | --- -[character_colors](#property-character_colors) | [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | -[color_regex](#property-color_regex) | [RegEx](https://docs.godotengine.org/en/latest/classes/class_regex.html#class-regex) | -[modifier_words_select_regex](#property-modifier_words_select_regex) | [RegEx](https://docs.godotengine.org/en/latest/classes/class_regex.html#class-regex) | -[parsed_text_effect_info](#property-parsed_text_effect_info) | [Dictionary[]](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | +[character_colors](#property-character_colors) | [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | `{}` +[color_regex](#property-color_regex) | [RegEx](https://docs.godotengine.org/en/latest/classes/class_regex.html#class-regex) | `new()` [text_already_read](#property-text_already_read) | [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | `false` -[text_effects](#property-text_effects) | [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | -[text_effects_regex](#property-text_effects_regex) | [RegEx](https://docs.godotengine.org/en/latest/classes/class_regex.html#class-regex) | -[text_modifiers](#property-text_modifiers) | [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | +[text_effects](#property-text_effects) | [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | `{}` +[parsed_text_effect_info](#property-parsed_text_effect_info) | [Dictionary[]](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | `[]` +[text_effects_regex](#property-text_effects_regex) | [RegEx](https://docs.godotengine.org/en/latest/classes/class_regex.html#class-regex) | `new()` +[text_modifiers](#property-text_modifiers) | [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | `[]` +[modifier_words_select_regex](#property-modifier_words_select_regex) | [RegEx](https://docs.godotengine.org/en/latest/classes/class_regex.html#class-regex) | `create_from_string(...)` --- ## Methods Returns | Method --- | --- -void | [clear_game_state](#method-clear_game_state) ( `clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) -void | [collect_character_names](#method-collect_character_names) ( ) +void | [clear_game_state](#method-clear_game_state) ( `_clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) +void | [load_game_state](#method-load_game_state) ( `_load_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) +void | [post_install](#method-post_install) ( ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [parse_text](#method-parse_text) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `type`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0`, `variables`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true`, `glossary`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true`, `modifiers`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true`, `effects`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true`, `color_names`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true` ) +void | [update_textbox](#method-update_textbox) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `instant`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [update_dialog_text](#method-update_dialog_text) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `instant`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false`, `additional`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) +void | [update_name_label](#method-update_name_label) ( `character`: [DialogicCharacter](class_dialogiccharacter.md) ) +void | [update_typing_sound_mood](#method-update_typing_sound_mood) ( `mood`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) = `{}` ) +void | [show_textbox](#method-show_textbox) ( `instant`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) +void | [hide_textbox](#method-hide_textbox) ( `instant`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) +[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_textbox_visible](#method-is_textbox_visible) ( ) +void | [show_next_indicators](#method-show_next_indicators) ( `question`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false`, `autoadvance`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) +void | [hide_next_indicators](#method-hide_next_indicators) ( `_fake_arg`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) = `null` ) +void | [set_text_voice_synced](#method-set_text_voice_synced) ( `enabled`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true` ) +[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_text_voice_synced](#method-is_text_voice_synced) ( ) +void | [update_text_speed](#method-update_text_speed) ( `letter_speed`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `-1.0`, `absolute`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false`, `speed_multiplier`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `_speed_multiplier`, `user_speed`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `get_setting(...)` ) +void | [set_text_reveal_skippable](#method-set_text_reveal_skippable) ( `skippable`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true`, `temp`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) +[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_text_reveal_skippable](#method-is_text_reveal_skippable) ( ) +void | [skip_text_reveal](#method-skip_text_reveal) ( ) void | [collect_text_effects](#method-collect_text_effects) ( ) -void | [collect_text_modifiers](#method-collect_text_modifiers) ( ) -[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [color_names](#method-color_names) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -void | [connect_meta_signals](#method-connect_meta_signals) ( `text_node`: [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) ) -void | [effect_lspeed](#method-effect_lspeed) ( `text_node`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `skipped`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool), `argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -void | [effect_mood](#method-effect_mood) ( `text_node`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `skipped`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool), `argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -void | [effect_pause](#method-effect_pause) ( `text_node`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `skipped`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool), `argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -void | [effect_signal](#method-effect_signal) ( `text_node`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `skipped`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool), `argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -void | [effect_speed](#method-effect_speed) ( `text_node`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `skipped`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool), `argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -void | [emit_meta_signal](#method-emit_meta_signal) ( `meta`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant), `sig`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [parse_text_effects](#method-parse_text_effects) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) void | [execute_effects](#method-execute_effects) ( `current_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int), `text_node`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `skipping`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) +void | [collect_text_modifiers](#method-collect_text_modifiers) ( ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [parse_text_modifiers](#method-parse_text_modifiers) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `type`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [get_character_name_parsed](#method-get_character_name_parsed) ( `character`: [DialogicCharacter](class_dialogiccharacter.md) ) [DialogicCharacter](class_dialogiccharacter.md) | [get_current_speaker](#method-get_current_speaker) ( ) -void | [hide_next_indicators](#method-hide_next_indicators) ( `_fake_arg`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) = `null` ) -void | [hide_textbox](#method-hide_textbox) ( `instant`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) -[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_text_reveal_skippable](#method-is_text_reveal_skippable) ( ) -[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_text_voice_synced](#method-is_text_voice_synced) ( ) -[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_textbox_visible](#method-is_textbox_visible) ( ) -void | [load_game_state](#method-load_game_state) ( `load_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) -[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [modifier_autopauses](#method-modifier_autopauses) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [modifier_break](#method-modifier_break) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +void | [connect_meta_signals](#method-connect_meta_signals) ( `text_node`: [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) ) +void | [emit_meta_signal](#method-emit_meta_signal) ( `meta`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant), `sig`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [color_character_names](#method-color_character_names) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +void | [collect_character_names](#method-collect_character_names) ( ) +[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [sort_by_length](#method-sort_by_length) ( `a`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `b`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +void | [effect_pause](#method-effect_pause) ( `_text_node`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `skipped`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool), `argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +void | [effect_speed](#method-effect_speed) ( `_text_node`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `skipped`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool), `argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +void | [effect_lspeed](#method-effect_lspeed) ( `_text_node`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `skipped`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool), `argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +void | [effect_signal](#method-effect_signal) ( `_text_node`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `_skipped`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool), `argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +void | [effect_mood](#method-effect_mood) ( `_text_node`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `_skipped`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool), `argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [modifier_random_selection](#method-modifier_random_selection) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [parse_text](#method-parse_text) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `type`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0`, `variables`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true`, `glossary`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true`, `modifiers`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true`, `effects`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true`, `color_names`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true` ) -[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [parse_text_effects](#method-parse_text_effects) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [parse_text_modifiers](#method-parse_text_modifiers) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `type`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) -void | [post_install](#method-post_install) ( ) -void | [set_text_reveal_skippable](#method-set_text_reveal_skippable) ( `skippable`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true`, `temp`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) -void | [set_text_voice_synced](#method-set_text_voice_synced) ( `enabled`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true` ) -void | [show_next_indicators](#method-show_next_indicators) ( `question`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false`, `autoadvance`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) -void | [show_textbox](#method-show_textbox) ( `instant`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) -void | [skip_text_reveal](#method-skip_text_reveal) ( ) -[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [update_dialog_text](#method-update_dialog_text) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `instant`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false`, `additional`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) -void | [update_name_label](#method-update_name_label) ( `character`: [DialogicCharacter](class_dialogiccharacter.md) ) -void | [update_text_speed](#method-update_text_speed) ( `letter_speed`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `-1.0`, `absolute`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false`, `speed_multiplier`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = ``, `user_speed`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `` ) -void | [update_textbox](#method-update_textbox) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `instant`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) -void | [update_typing_sound_mood](#method-update_typing_sound_mood) ( `mood`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) = `` ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [modifier_break](#method-modifier_break) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [modifier_autopauses](#method-modifier_autopauses) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) --- ## Constants @@ -124,7 +125,7 @@ Returns | Method -**signal [animation_textbox_hide](#signal-animation_textbox_hide) ( )** +**signal [text_finished](#signal-text_finished) ( `info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) )** @@ -134,7 +135,7 @@ Returns | Method -**signal [animation_textbox_new_text](#signal-animation_textbox_new_text) ( )** +**signal [speaker_updated](#signal-speaker_updated) ( `character`: [DialogicCharacter](class_dialogiccharacter.md) )** @@ -144,7 +145,7 @@ Returns | Method -**signal [animation_textbox_show](#signal-animation_textbox_show) ( )** +**signal [textbox_visibility_changed](#signal-textbox_visibility_changed) ( `visible`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) )** @@ -154,7 +155,7 @@ Returns | Method -**signal [meta_clicked](#signal-meta_clicked) ( `meta`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) )** +**signal [animation_textbox_new_text](#signal-animation_textbox_new_text) ( )** @@ -164,7 +165,7 @@ Returns | Method -**signal [meta_hover_ended](#signal-meta_hover_ended) ( `meta`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) )** +**signal [animation_textbox_show](#signal-animation_textbox_show) ( )** @@ -174,7 +175,7 @@ Returns | Method -**signal [meta_hover_started](#signal-meta_hover_started) ( `meta`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) )** +**signal [animation_textbox_hide](#signal-animation_textbox_hide) ( )** @@ -184,7 +185,7 @@ Returns | Method -**signal [speaker_updated](#signal-speaker_updated) ( `character`: [DialogicCharacter](class_dialogiccharacter.md) )** +**signal [meta_hover_ended](#signal-meta_hover_ended) ( `meta`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) )** @@ -194,7 +195,7 @@ Returns | Method -**signal [text_finished](#signal-text_finished) ( `info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) )** +**signal [meta_hover_started](#signal-meta_hover_started) ( `meta`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) )** @@ -204,7 +205,7 @@ Returns | Method -**signal [textbox_visibility_changed](#signal-textbox_visibility_changed) ( `visible`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) )** +**signal [meta_clicked](#signal-meta_clicked) ( `meta`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) )** @@ -216,7 +217,7 @@ Returns | Method -**var character_colors = ** +**var character_colors = {}** @@ -226,7 +227,7 @@ Returns | Method -**var color_regex = ** +**var color_regex = new()** @@ -236,7 +237,7 @@ Returns | Method -**var modifier_words_select_regex = ** +**var text_already_read = false** @@ -246,7 +247,7 @@ Returns | Method -**var parsed_text_effect_info = ** +**var text_effects = {}** @@ -256,7 +257,7 @@ Returns | Method -**var text_already_read = false** +**var parsed_text_effect_info = []** @@ -266,7 +267,7 @@ Returns | Method -**var text_effects = ** +**var text_effects_regex = new()** @@ -276,7 +277,7 @@ Returns | Method -**var text_effects_regex = ** +**var text_modifiers = []** @@ -286,7 +287,7 @@ Returns | Method -**var text_modifiers = ** +**var modifier_words_select_regex = create_from_string(...)** @@ -298,7 +299,7 @@ Returns | Method -**func [clear_game_state](#method-clear_game_state) ( `clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** +**func [clear_game_state](#method-clear_game_state) ( `_clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** @@ -308,7 +309,7 @@ Returns | Method -**func [collect_character_names](#method-collect_character_names) ( ) ⇒ void** +**func [load_game_state](#method-load_game_state) ( `_load_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** @@ -318,7 +319,7 @@ Returns | Method -**func [collect_text_effects](#method-collect_text_effects) ( ) ⇒ void** +**func [post_install](#method-post_install) ( ) ⇒ void** @@ -328,47 +329,47 @@ Returns | Method -**func [collect_text_modifiers](#method-collect_text_modifiers) ( ) ⇒ void** +**func [parse_text](#method-parse_text) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `type`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0`, `variables`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true`, `glossary`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true`, `modifiers`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true`, `effects`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true`, `color_names`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true` ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** - *No description available.* +Applies modifiers, effects and coloring to the text --- -**func [color_names](#method-color_names) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [update_textbox](#method-update_textbox) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `instant`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ void** - *No description available.* +When an event updates the text spoken, this can adjust the state of the dialog text box. This method is async. --- -**func [connect_meta_signals](#method-connect_meta_signals) ( `text_node`: [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) ) ⇒ void** +**func [update_dialog_text](#method-update_dialog_text) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `instant`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false`, `additional`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** - *No description available.* +Shows the given text on all visible DialogText nodes. Instant can be used to skip all revieling. If additional is true, the previous text will be kept. --- -**func [effect_lspeed](#method-effect_lspeed) ( `text_node`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `skipped`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool), `argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** +**func [update_name_label](#method-update_name_label) ( `character`: [DialogicCharacter](class_dialogiccharacter.md) ) ⇒ void** - *No description available.* +Updates the visible name on all name labels nodes. If a name changes, the [speaker_updated](#signal-speaker_updated) signal is emitted. --- -**func [effect_mood](#method-effect_mood) ( `text_node`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `skipped`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool), `argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** +**func [update_typing_sound_mood](#method-update_typing_sound_mood) ( `mood`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) = `{}` ) ⇒ void** @@ -378,27 +379,27 @@ Returns | Method -**func [effect_pause](#method-effect_pause) ( `text_node`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `skipped`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool), `argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** +**func [show_textbox](#method-show_textbox) ( `instant`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ void** - *No description available.* +instant skips the signal and thus possible animations --- -**func [effect_signal](#method-effect_signal) ( `text_node`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `skipped`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool), `argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** +**func [hide_textbox](#method-hide_textbox) ( `instant`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ void** - *No description available.* +Instant skips the signal and thus possible animations --- -**func [effect_speed](#method-effect_speed) ( `text_node`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `skipped`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool), `argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** +**func [is_textbox_visible](#method-is_textbox_visible) ( ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** @@ -408,7 +409,7 @@ Returns | Method -**func [emit_meta_signal](#method-emit_meta_signal) ( `meta`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant), `sig`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** +**func [show_next_indicators](#method-show_next_indicators) ( `question`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false`, `autoadvance`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ void** @@ -418,7 +419,7 @@ Returns | Method -**func [execute_effects](#method-execute_effects) ( `current_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int), `text_node`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `skipping`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ void** +**func [hide_next_indicators](#method-hide_next_indicators) ( `_fake_arg`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) = `null` ) ⇒ void** @@ -428,41 +429,49 @@ Returns | Method -**func [get_character_name_parsed](#method-get_character_name_parsed) ( `character`: [DialogicCharacter](class_dialogiccharacter.md) ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [set_text_voice_synced](#method-set_text_voice_synced) ( `enabled`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true` ) ⇒ void** -Parses the character's display_name and returns the text that should be rendered. Note that characters may have variables in their name, therefore this function should be called to evaluate any potential variables in a character's name. +This method will sync the text speed to the voice audio clip length, if a voice is playing. For instance, if the voice is playing for four seconds, the text will finish revealing after this time. This feature ignores Auto-Pauses on letters. Pauses via BBCode will desync the reveal. --- -**func [get_current_speaker](#method-get_current_speaker) ( ) ⇒ [DialogicCharacter](class_dialogiccharacter.md)** +**func [is_text_voice_synced](#method-is_text_voice_synced) ( ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** -Returns the [DialogicCharacter](class_dialogiccharacter.md) of the current speaker. If there is no current speaker or the speaker is not found, returns null. +Returns whether voice-synced text is enabled. --- -**func [hide_next_indicators](#method-hide_next_indicators) ( `_fake_arg`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) = `null` ) ⇒ void** +**func [update_text_speed](#method-update_text_speed) ( `letter_speed`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `-1.0`, `absolute`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false`, `speed_multiplier`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `_speed_multiplier`, `user_speed`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `get_setting(...)` ) ⇒ void** - *No description available.* +Sets how fast text will be revealed. + +`letter_speed` is the speed a single text character takes to appear on the textbox. + +`absolute` will force text to display at the given speed, regardless of the user's text speed setting. + +`_speed_multiplier` adjusts the speed of the text, if set to -1, the value won't be updated and the current value will persist. + +`_user_speed` adjusts the speed of the text, if set to -1, the project setting 'text_speed' will be used.operator --- -**func [hide_textbox](#method-hide_textbox) ( `instant`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ void** +**func [set_text_reveal_skippable](#method-set_text_reveal_skippable) ( `skippable`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true`, `temp`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ void** -Instant skips the signal and thus possible animations + *No description available.* --- @@ -478,17 +487,17 @@ Instant skips the signal and thus possible animations -**func [is_text_voice_synced](#method-is_text_voice_synced) ( ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [skip_text_reveal](#method-skip_text_reveal) ( ) ⇒ void** -Returns whether voice-synced text is enabled. + *No description available.* --- -**func [is_textbox_visible](#method-is_textbox_visible) ( ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [collect_text_effects](#method-collect_text_effects) ( ) ⇒ void** @@ -498,17 +507,17 @@ Returns whether voice-synced text is enabled. -**func [load_game_state](#method-load_game_state) ( `load_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** +**func [parse_text_effects](#method-parse_text_effects) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** - *No description available.* +Returns the string with all text effects removed Use get_parsed_text_effects() after calling this to get all effect information --- -**func [modifier_autopauses](#method-modifier_autopauses) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [execute_effects](#method-execute_effects) ( `current_index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int), `text_node`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `skipping`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ void** @@ -518,7 +527,7 @@ Returns whether voice-synced text is enabled. -**func [modifier_break](#method-modifier_break) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [collect_text_modifiers](#method-collect_text_modifiers) ( ) ⇒ void** @@ -528,7 +537,7 @@ Returns whether voice-synced text is enabled. -**func [modifier_random_selection](#method-modifier_random_selection) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [parse_text_modifiers](#method-parse_text_modifiers) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `type`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** @@ -538,27 +547,27 @@ Returns whether voice-synced text is enabled. -**func [parse_text](#method-parse_text) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `type`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0`, `variables`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true`, `glossary`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true`, `modifiers`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true`, `effects`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true`, `color_names`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true` ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [get_character_name_parsed](#method-get_character_name_parsed) ( `character`: [DialogicCharacter](class_dialogiccharacter.md) ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** -Applies modifiers, effects and coloring to the text +Parses the character's display_name and returns the text that should be rendered. Note that characters may have variables in their name, therefore this function should be called to evaluate any potential variables in a character's name. --- -**func [parse_text_effects](#method-parse_text_effects) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [get_current_speaker](#method-get_current_speaker) ( ) ⇒ [DialogicCharacter](class_dialogiccharacter.md)** -Returns the string with all text effects removed Use get_parsed_text_effects() after calling this to get all effect information +Returns the [DialogicCharacter](class_dialogiccharacter.md) of the current speaker. If there is no current speaker or the speaker is not found, returns null. --- -**func [parse_text_modifiers](#method-parse_text_modifiers) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `type`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [connect_meta_signals](#method-connect_meta_signals) ( `text_node`: [Node](https://docs.godotengine.org/en/latest/classes/class_node.html#class-node) ) ⇒ void** @@ -568,7 +577,7 @@ Returns the string with all text effects removed Use get_parsed_text_effects() a -**func [post_install](#method-post_install) ( ) ⇒ void** +**func [emit_meta_signal](#method-emit_meta_signal) ( `meta`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant), `sig`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** @@ -578,7 +587,7 @@ Returns the string with all text effects removed Use get_parsed_text_effects() a -**func [set_text_reveal_skippable](#method-set_text_reveal_skippable) ( `skippable`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true`, `temp`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ void** +**func [color_character_names](#method-color_character_names) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** @@ -588,17 +597,17 @@ Returns the string with all text effects removed Use get_parsed_text_effects() a -**func [set_text_voice_synced](#method-set_text_voice_synced) ( `enabled`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `true` ) ⇒ void** +**func [collect_character_names](#method-collect_character_names) ( ) ⇒ void** -This method will sync the text speed to the voice audio clip length, if a voice is playing. For instance, if the voice is playing for four seconds, the text will finish revealing after this time. This feature ignores Auto-Pauses on letters. Pauses via BBCode will desync the reveal. + *No description available.* --- -**func [show_next_indicators](#method-show_next_indicators) ( `question`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false`, `autoadvance`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ void** +**func [sort_by_length](#method-sort_by_length) ( `a`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `b`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** @@ -608,17 +617,17 @@ This method will sync the text speed to the voice audio clip length, if a voice -**func [show_textbox](#method-show_textbox) ( `instant`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ void** +**func [effect_pause](#method-effect_pause) ( `_text_node`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `skipped`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool), `argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** -instant skips the signal and thus possible animations + *No description available.* --- -**func [skip_text_reveal](#method-skip_text_reveal) ( ) ⇒ void** +**func [effect_speed](#method-effect_speed) ( `_text_node`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `skipped`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool), `argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** @@ -628,47 +637,57 @@ instant skips the signal and thus possible animations -**func [update_dialog_text](#method-update_dialog_text) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `instant`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false`, `additional`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [effect_lspeed](#method-effect_lspeed) ( `_text_node`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `skipped`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool), `argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** -Shows the given text on all visible DialogText nodes. Instant can be used to skip all revieling. If additional is true, the previous text will be kept. + *No description available.* --- -**func [update_name_label](#method-update_name_label) ( `character`: [DialogicCharacter](class_dialogiccharacter.md) ) ⇒ void** +**func [effect_signal](#method-effect_signal) ( `_text_node`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `_skipped`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool), `argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** -Updates the visible name on all name labels nodes. If a name changes, the [speaker_updated](#signal-speaker_updated) signal is emitted. + *No description available.* --- -**func [update_text_speed](#method-update_text_speed) ( `letter_speed`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `-1.0`, `absolute`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false`, `speed_multiplier`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = ``, `user_speed`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) = `` ) ⇒ void** +**func [effect_mood](#method-effect_mood) ( `_text_node`: [Control](https://docs.godotengine.org/en/latest/classes/class_control.html#class-control), `_skipped`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool), `argument`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** -Sets how fast text will be revealed. `absolute` will force test to display at the given speed, regardless of the user's text speed setting. `_speed_multiplier` adjusts the speed of the text, if set to -1, the value won't be updated and the current value will persist. `_user_speed` adjusts the speed of the text, if set to -1, the project setting 'text_speed' will be used.operator + *No description available.* --- -**func [update_textbox](#method-update_textbox) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `instant`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ void** +**func [modifier_random_selection](#method-modifier_random_selection) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** -When an event updates the text spoken, this can adjust the state of the dialog text box. This method is async. + *No description available.* --- -**func [update_typing_sound_mood](#method-update_typing_sound_mood) ( `mood`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) = `` ) ⇒ void** +**func [modifier_break](#method-modifier_break) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** + + + + *No description available.* + +--- + + + +**func [modifier_autopauses](#method-modifier_autopauses) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** diff --git a/documentation/classes/subsystem_text_input.md b/documentation/classes/subsystem_text_input.md index 1864d7f..09d5824 100644 --- a/documentation/classes/subsystem_text_input.md +++ b/documentation/classes/subsystem_text_input.md @@ -14,9 +14,9 @@ Subsystem that handles showing of input promts. ## Methods Returns | Method --- | --- -void | [clear_game_state](#method-clear_game_state) ( `clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) -void | [hide_text_input](#method-hide_text_input) ( ) +void | [clear_game_state](#method-clear_game_state) ( `_clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) void | [show_text_input](#method-show_text_input) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `default`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `placeholder`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `allow_empty`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) +void | [hide_text_input](#method-hide_text_input) ( ) --- ## Signals @@ -44,7 +44,7 @@ Returns | Method -**func [clear_game_state](#method-clear_game_state) ( `clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** +**func [clear_game_state](#method-clear_game_state) ( `_clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** @@ -54,7 +54,7 @@ Returns | Method -**func [hide_text_input](#method-hide_text_input) ( ) ⇒ void** +**func [show_text_input](#method-show_text_input) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `default`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `placeholder`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `allow_empty`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ void** @@ -64,7 +64,7 @@ Returns | Method -**func [show_text_input](#method-show_text_input) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `default`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `placeholder`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""`, `allow_empty`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ void** +**func [hide_text_input](#method-hide_text_input) ( ) ⇒ void** diff --git a/documentation/classes/subsystem_variables.md b/documentation/classes/subsystem_variables.md index 4cd4824..c37772a 100644 --- a/documentation/classes/subsystem_variables.md +++ b/documentation/classes/subsystem_variables.md @@ -15,16 +15,16 @@ Subsystem that manages variables and allows to access them. Returns | Method --- | --- void | [clear_game_state](#method-clear_game_state) ( `clear_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) -[Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | [folders](#method-folders) ( ) -[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_autoloads](#method-get_autoloads) ( ) -[Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) | [get_variable](#method-get_variable) ( `variable_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `default`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) = `null`, `no_warning`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) -[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [has](#method-has) ( `variable`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) void | [load_game_state](#method-load_game_state) ( `load_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) -[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [merge_folder](#method-merge_folder) ( `new`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary), `defs`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) ) [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | [parse_variables](#method-parse_variables) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) -void | [reset](#method-reset) ( `variable`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [set_variable](#method-set_variable) ( `variable_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `value`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) -[Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | [variables](#method-variables) ( `absolute`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) +[Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) | [get_variable](#method-get_variable) ( `variable_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `default`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) = `null`, `no_warning`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) +void | [reset](#method-reset) ( `variable`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) +[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [has](#method-has) ( `variable`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) +[Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | [folders](#method-folders) ( ) +[Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | [variables](#method-variables) ( `_absolute`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [get_autoloads](#method-get_autoloads) ( ) +[Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | [merge_folder](#method-merge_folder) ( `new`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary), `defs`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) ) --- ## Signals @@ -34,7 +34,13 @@ Returns | Method - Emitted if a dialogic variable changes + Emitted if a dialogic variable changes, gives a dictionary with the following keys: + +Key | Value Type | Value +----------- | ------------- | ----- +`variable` | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | The name of the variable that is getting changed. +`new_value` | [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant)| The value that has after the change (the result). + --- @@ -44,7 +50,16 @@ Returns | Method - Emitted on any set variable event + Emitted on a set variable event, gives a dictionary with the following keys: + +Key | Value Type | Value +----------- | ------------- | ----- +`variable` | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | The name of the variable that is getting changed. +`orig_value`| [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant)| The value that had before. +`new_value` | [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant)| The value that has after the change (the result). +`value` | [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant)| The value that the variable is changed by/to. +`value_str` | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | Whatever has been given as the value (not interpreted, so a variable is just a string). + --- @@ -62,7 +77,7 @@ Returns | Method -**func [folders](#method-folders) ( ) ⇒ [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array)** +**func [load_game_state](#method-load_game_state) ( `load_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** @@ -72,17 +87,17 @@ Returns | Method -**func [get_autoloads](#method-get_autoloads) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [parse_variables](#method-parse_variables) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** - *No description available.* +This function will try to get the value of variables provided inside curly brackets and replace them with their values. It will: - look for the strings to replace - search all autoloads - try to get the value from context So if you provide a string like `Hello, how are you doing {Game.player_name} it will try to search for an autoload with the name `Game` and get the value of `player_name` to replace it. --- -**func [get_variable](#method-get_variable) ( `variable_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `default`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) = `null`, `no_warning`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant)** +**func [set_variable](#method-set_variable) ( `variable_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `value`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** @@ -92,57 +107,57 @@ Returns | Method -**func [has](#method-has) ( `variable`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [get_variable](#method-get_variable) ( `variable_path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `default`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) = `null`, `no_warning`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant)** -Returns true if a variable with the given path exists + *No description available.* --- -**func [load_game_state](#method-load_game_state) ( `load_flag`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) = `0` ) ⇒ void** +**func [reset](#method-reset) ( `variable`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ void** - *No description available.* +Resets all variables or a specific variable to the value(s) defined in the variable editor --- -**func [merge_folder](#method-merge_folder) ( `new`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary), `defs`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** +**func [has](#method-has) ( `variable`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** - *No description available.* +Returns true if a variable with the given path exists --- -**func [parse_variables](#method-parse_variables) ( `text`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)** +**func [folders](#method-folders) ( ) ⇒ [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array)** -This function will try to get the value of variables provided inside curly brackets and replace them with their values. It will: - look for the strings to replace - search all autoloads - try to get the value from context So if you provide a string like `Hello, how are you doing {Game.player_name} it will try to search for an autoload with the name `Game` and get the value of `player_name` to replace it. + *No description available.* --- -**func [reset](#method-reset) ( `variable`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) = `""` ) ⇒ void** +**func [variables](#method-variables) ( `_absolute`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array)** -Resets all variables or a specific variable to the value(s) defined in the variable editor + *No description available.* --- -**func [set_variable](#method-set_variable) ( `variable_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string), `value`: [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html#class-variant) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [get_autoloads](#method-get_autoloads) ( ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** @@ -152,7 +167,7 @@ Resets all variables or a specific variable to the value(s) defined in the varia -**func [variables](#method-variables) ( `absolute`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) ⇒ [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array)** +**func [merge_folder](#method-merge_folder) ( `new`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary), `defs`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) ) ⇒ [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary)** diff --git a/documentation/classes/subsystem_variables.variablefolder.md b/documentation/classes/subsystem_variables.variablefolder.md index e50625b..c5151a8 100644 --- a/documentation/classes/subsystem_variables.variablefolder.md +++ b/documentation/classes/subsystem_variables.variablefolder.md @@ -12,23 +12,23 @@ ## Properties Name | Type | Default --- | --- | --- -[data](#property-data) | [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | -[outside](#property-outside) | [DialogicSubsystem](class_dialogicsubsystem.md) | +[data](#property-data) | [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) | `{}` [path](#property-path) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | `""` +[outside](#property-outside) | [DialogicSubsystem](class_dialogicsubsystem.md) | --- ## Methods Returns | Method --- | --- -[Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | [folders](#method-folders) ( ) [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [has](#method-has) ( `key`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | [folders](#method-folders) ( ) [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array) | [variables](#method-variables) ( `absolute`: [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) = `false` ) --- ## Property Descriptions -**var data = ** +**var data = {}** @@ -38,7 +38,7 @@ Returns | Method -**var outside** +**var path = ""** @@ -48,7 +48,7 @@ Returns | Method -**var path = ""** +**var outside** @@ -60,7 +60,7 @@ Returns | Method -**func [folders](#method-folders) ( ) ⇒ [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array)** +**func [has](#method-has) ( `key`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** @@ -70,7 +70,7 @@ Returns | Method -**func [has](#method-has) ( `key`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [folders](#method-folders) ( ) ⇒ [Array](https://docs.godotengine.org/en/latest/classes/class_array.html#class-array)** diff --git a/documentation/classes/subsystem_voice.md b/documentation/classes/subsystem_voice.md index 2297e23..65d071b 100644 --- a/documentation/classes/subsystem_voice.md +++ b/documentation/classes/subsystem_voice.md @@ -16,50 +16,50 @@ It's recommended to use the [DialogicVoiceEvent](class_dialogicvoiceevent.md) to Name | Type | Default --- | --- | --- [current_audio_file](#property-current_audio_file) | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | -[voice_player](#property-voice_player) | [AudioStreamPlayer](https://docs.godotengine.org/en/latest/classes/class_audiostreamplayer.html#class-audiostreamplayer) | +[voice_player](#property-voice_player) | [AudioStreamPlayer](https://docs.godotengine.org/en/latest/classes/class_audiostreamplayer.html#class-audiostreamplayer) | `new()` --- ## Methods Returns | Method --- | --- -[float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | [get_remaining_time](#method-get_remaining_time) ( ) -[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_running](#method-is_running) ( ) -[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_voiced](#method-is_voiced) ( `index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) void | [pause](#method-pause) ( ) -void | [play_voice](#method-play_voice) ( ) void | [resume](#method-resume) ( ) -void | [set_bus](#method-set_bus) ( `bus_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) +[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_voiced](#method-is_voiced) ( `index`: [int](https://docs.godotengine.org/en/latest/classes/class_int.html#class-int) ) +void | [play_voice](#method-play_voice) ( ) void | [set_file](#method-set_file) ( `path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) void | [set_volume](#method-set_volume) ( `value`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) ) +void | [set_bus](#method-set_bus) ( `bus_name`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) void | [stop_audio](#method-stop_audio) ( ) +[float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | [get_remaining_time](#method-get_remaining_time) ( ) +[bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool) | [is_running](#method-is_running) ( ) --- ## Signals -**signal [voiceline_finished](#signal-voiceline_finished) ( `info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) )** +**signal [voiceline_started](#signal-voiceline_started) ( `info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) )** - Emitted whenever a voice line finished playing. The `info` contains the following keys and values: -Key | Value Type | Value ----------------- | ------------- | ----- -`file` | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | The path to file played. -`remaining_time` | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | The remaining time of the voiceline. + Emitted whenever a new voice line starts playing. The `info` contains the following keys and values: +Key | Value Type | Value +-------- | ------------- | ----- +`file` | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | The path to file played. --- -**signal [voiceline_started](#signal-voiceline_started) ( `info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) )** +**signal [voiceline_finished](#signal-voiceline_finished) ( `info`: [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html#class-dictionary) )** - Emitted whenever a new voice line starts playing. The `info` contains the following keys and values: -Key | Value Type | Value --------- | ------------- | ----- -`file` | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | The path to file played. + Emitted whenever a voice line finished playing. The `info` contains the following keys and values: +Key | Value Type | Value +---------------- | ------------- | ----- +`file` | [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) | The path to file played. +`remaining_time` | [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) | The remaining time of the voiceline. --- @@ -93,7 +93,7 @@ The current audio file being played. -**var voice_player = ** +**var voice_player = new()** @@ -105,21 +105,21 @@ The audio player for the voiceline. -**func [get_remaining_time](#method-get_remaining_time) ( ) ⇒ [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float)** +**func [pause](#method-pause) ( ) ⇒ void** -Returns the remaining time of the current voice line in seconds. If there is no voice line playing, returns `0`. +Stops the current voice from playing. --- -**func [is_running](#method-is_running) ( ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** +**func [resume](#method-resume) ( ) ⇒ void** -Whether there is still positive time remaining for the current voiceline. +Resumes a paused voice. --- @@ -135,31 +135,31 @@ Whether the current event is a text event and has a voice event before it. -**func [pause](#method-pause) ( ) ⇒ void** +**func [play_voice](#method-play_voice) ( ) ⇒ void** -Stops the current voice from playing. +Plays the voice line. This will be invoked by Dialogic. Requires [set_file](#property-set_file) to be called before or nothing plays. --- -**func [play_voice](#method-play_voice) ( ) ⇒ void** +**func [set_file](#method-set_file) ( `path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** -Plays the voice line. This will be invoked by Dialogic. Requires [set_file](#property-set_file) to be called before or nothing plays. +Set a voice file `path` to be played, then invoke [play_voice](#property-play_voice). This method does not check if `path` is a valid file. --- -**func [resume](#method-resume) ( ) ⇒ void** +**func [set_volume](#method-set_volume) ( `value`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) ) ⇒ void** -Resumes a paused voice. +Set the volume to a `value` in decibels. --- @@ -175,31 +175,31 @@ Set the voice player's bus to a `bus_name`. -**func [set_file](#method-set_file) ( `path`: [String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string) ) ⇒ void** +**func [stop_audio](#method-stop_audio) ( ) ⇒ void** -Set a voice file `path` to be played, then invoke [play_voice](#property-play_voice). This method does not check if `path` is a valid file. +Stops the current voice line from playing. --- -**func [set_volume](#method-set_volume) ( `value`: [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float) ) ⇒ void** +**func [get_remaining_time](#method-get_remaining_time) ( ) ⇒ [float](https://docs.godotengine.org/en/latest/classes/class_float.html#class-float)** -Set the volume to a `value` in decibels. +Returns the remaining time of the current voice line in seconds. If there is no voice line playing, returns `0`. --- -**func [stop_audio](#method-stop_audio) ( ) ⇒ void** +**func [is_running](#method-is_running) ( ) ⇒ [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html#class-bool)** -Stops the current voice line from playing. +Whether there is still positive time remaining for the current voiceline. ---