Skip to content

Commit ed2e41c

Browse files
authored
Update Classes documentation to Dialogic 2 Alpha 18 (#76)
1 parent 158d364 commit ed2e41c

File tree

63 files changed

+1781
-748
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+1781
-748
lines changed

documentation/class_index.md

Lines changed: 92 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -3,106 +3,106 @@
33
<div class="header-label purple">Class Reference Index</div>
44
</div>
55

6-
*All classes from the Dialogic 2 source code.*
6+
*All classes from the Dialogic 2 (Alpha 18) source code.*
77

88
- [Subsystem]()
9-
- [Audio](class__subsystem_audio.md)
10-
- [Backgrounds](class__subsystem_backgrounds.md)
11-
- [Containers](class__subsystem_containers.md)
12-
- [Portraits](class__subsystem_portraits.md)
13-
- [Choices](class__subsystem_choices.md)
14-
- [Animation](class__subsystem_animation.md)
15-
- [Expression](class__subsystem_expression.md)
16-
- [Input](class__subsystem_input.md)
17-
- [Glossary](class__subsystem_glossary.md)
18-
- [History](class__subsystem_history.md)
19-
- [Jump](class__subsystem_jump.md)
20-
- [Save](class__subsystem_save.md)
21-
- [Settings](class__subsystem_settings.md)
22-
- [Styles](class__subsystem_styles.md)
23-
- [Text](class__subsystem_text.md)
24-
- [Text_input](class__subsystem_text_input.md)
25-
- [Variables.VariableFolder](class__subsystem_variables.variablefolder.md)
26-
- [Variables](class__subsystem_variables.md)
27-
- [Voice](class__subsystem_voice.md)
9+
- [Audio](classes/class_subsystem_audio.md)
10+
- [Backgrounds](classes/class_subsystem_backgrounds.md)
11+
- [Containers](classes/class_subsystem_containers.md)
12+
- [Portraits](classes/class_subsystem_portraits.md)
13+
- [Choices](classes/class_subsystem_choices.md)
14+
- [Animation](classes/class_subsystem_animation.md)
15+
- [Expression](classes/class_subsystem_expression.md)
16+
- [Input](classes/class_subsystem_input.md)
17+
- [Glossary](classes/class_subsystem_glossary.md)
18+
- [History](classes/class_subsystem_history.md)
19+
- [Jump](classes/class_subsystem_jump.md)
20+
- [Save](classes/class_subsystem_save.md)
21+
- [Settings](classes/class_subsystem_settings.md)
22+
- [Styles](classes/class_subsystem_styles.md)
23+
- [Text](classes/class_subsystem_text.md)
24+
- [Text_input](classes/class_subsystem_text_input.md)
25+
- [Variables](classes/class_subsystem_variables.md)
26+
- [Voice](classes/class_subsystem_voice.md)
27+
- [Animation](classes/class_dialogicanimation.md)
28+
- [AutoAdvance](classes/class_dialogicautoadvance.md)
29+
- [AutoSkip](classes/class_dialogicautoskip.md)
30+
- [Background](classes/class_dialogicbackground.md)
2831

2932
- [Event]()
30-
- [BackgroundEvent](class__dialogicbackgroundevent.md)
31-
- [CallEvent](class__dialogiccallevent.md)
32-
- [CharacterEvent](class__dialogiccharacterevent.md)
33-
- [ChoiceEvent](class__dialogicchoiceevent.md)
34-
- [ClearEvent](class__dialogicclearevent.md)
35-
- [CommentEvent](class__dialogiccommentevent.md)
36-
- [ConditionEvent](class__dialogicconditionevent.md)
37-
- [EndBranchEvent](class__dialogicendbranchevent.md)
38-
- [EndTimelineEvent](class__dialogicendtimelineevent.md)
39-
- [Event](class__dialogicevent.md)
40-
- [GlossaryEvent](class__dialogicglossaryevent.md)
41-
- [HistoryEvent](class__dialogichistoryevent.md)
42-
- [JumpEvent](class__dialogicjumpevent.md)
43-
- [LabelEvent](class__dialogiclabelevent.md)
44-
- [MusicEvent](class__dialogicmusicevent.md)
45-
- [ReturnEvent](class__dialogicreturnevent.md)
46-
- [SaveEvent](class__dialogicsaveevent.md)
47-
- [SettingEvent](class__dialogicsettingevent.md)
48-
- [SignalEvent](class__dialogicsignalevent.md)
49-
- [SoundEvent](class__dialogicsoundevent.md)
50-
- [StyleEvent](class__dialogicstyleevent.md)
51-
- [TextEvent](class__dialogictextevent.md)
52-
- [TextInputEvent](class__dialogictextinputevent.md)
53-
- [VariableEvent](class__dialogicvariableevent.md)
54-
- [VoiceEvent](class__dialogicvoiceevent.md)
55-
- [WaitEvent](class__dialogicwaitevent.md)
56-
- [WaitInputEvent](class__dialogicwaitinputevent.md)
33+
- [Audio](classes/class_dialogicaudioevent.md)
34+
- [Background](classes/class_dialogicbackgroundevent.md)
35+
- [Call](classes/class_dialogiccallevent.md)
36+
- [Character](classes/class_dialogiccharacterevent.md)
37+
- [Choice](classes/class_dialogicchoiceevent.md)
38+
- [Clear](classes/class_dialogicclearevent.md)
39+
- [Comment](classes/class_dialogiccommentevent.md)
40+
- [Condition](classes/class_dialogicconditionevent.md)
41+
- [EndBranch](classes/class_dialogicendbranchevent.md)
42+
- [EndTimeline](classes/class_dialogicendtimelineevent.md)
43+
- [Event](classes/class_dialogicevent.md)
44+
- [Glossary](classes/class_dialogicglossaryevent.md)
45+
- [History](classes/class_dialogichistoryevent.md)
46+
- [Jump](classes/class_dialogicjumpevent.md)
47+
- [Label](classes/class_dialogiclabelevent.md)
48+
- [Return](classes/class_dialogicreturnevent.md)
49+
- [Save](classes/class_dialogicsaveevent.md)
50+
- [Setting](classes/class_dialogicsettingevent.md)
51+
- [Signal](classes/class_dialogicsignalevent.md)
52+
- [Style](classes/class_dialogicstyleevent.md)
53+
- [Text](classes/class_dialogictextevent.md)
54+
- [TextInput](classes/class_dialogictextinputevent.md)
55+
- [Variable](classes/class_dialogicvariableevent.md)
56+
- [Voice](classes/class_dialogicvoiceevent.md)
57+
- [Wait](classes/class_dialogicwaitevent.md)
58+
- [WaitInput](classes/class_dialogicwaitinputevent.md)
5759

5860
- [Resource]()
59-
- [Character](class__dialogiccharacter.md)
60-
- [CharacterFormatLoader](class__dialogiccharacterformatloader.md)
61-
- [CharacterFormatSaver](class__dialogiccharacterformatsaver.md)
62-
- [Glossary](class__dialogicglossary.md)
63-
- [Style](class__dialogicstyle.md)
64-
- [StyleLayer](class__dialogicstylelayer.md)
65-
- [Timeline](class__dialogictimeline.md)
66-
- [TimelineFormatLoader](class__dialogictimelineformatloader.md)
67-
- [TimelineFormatSaver](class__dialogictimelineformatsaver.md)
61+
- [Character](classes/class_dialogiccharacter.md)
62+
- [CharacterFormatLoader](classes/class_dialogiccharacterformatloader.md)
63+
- [CharacterFormatSaver](classes/class_dialogiccharacterformatsaver.md)
64+
- [Glossary](classes/class_dialogicglossary.md)
65+
- [Style](classes/class_dialogicstyle.md)
66+
- [StyleLayer](classes/class_dialogicstylelayer.md)
67+
- [Timeline](classes/class_dialogictimeline.md)
68+
- [TimelineFormatLoader](classes/class_dialogictimelineformatloader.md)
69+
- [TimelineFormatSaver](classes/class_dialogictimelineformatsaver.md)
6870

6971
- [Node]()
70-
- [BackgroundHolder](class__dialogicnode_backgroundholder.md)
71-
- [ButtonSound](class__dialogicnode_buttonsound.md)
72-
- [ChoiceButton](class__dialogicnode_choicebutton.md)
73-
- [DialogText](class__dialogicnode_dialogtext.md)
74-
- [Input](class__dialogicnode_input.md)
75-
- [NameLabel](class__dialogicnode_namelabel.md)
76-
- [NextIndicator](class__dialogicnode_nextindicator.md)
77-
- [PortraitContainer](class__dialogicnode_portraitcontainer.md)
78-
- [StyleLayer](class__dialogicnode_stylelayer.md)
79-
- [TextInput](class__dialogicnode_textinput.md)
80-
- [TypeSounds](class__dialogicnode_typesounds.md)
72+
- [BackgroundHolder](classes/class_dialogicnode_backgroundholder.md)
73+
- [ButtonSound](classes/class_dialogicnode_buttonsound.md)
74+
- [ChoiceButton](classes/class_dialogicnode_choicebutton.md)
75+
- [DialogText](classes/class_dialogicnode_dialogtext.md)
76+
- [Input](classes/class_dialogicnode_input.md)
77+
- [NameLabel](classes/class_dialogicnode_namelabel.md)
78+
- [NextIndicator](classes/class_dialogicnode_nextindicator.md)
79+
- [PortraitContainer](classes/class_dialogicnode_portraitcontainer.md)
80+
- [StyleLayer](classes/class_dialogicnode_stylelayer.md)
81+
- [TextInput](classes/class_dialogicnode_textinput.md)
82+
- [TypeSounds](classes/class_dialogicnode_typesounds.md)
8183

8284
- [Other]()
83-
- [DCSS](class__dcss.md)
84-
- [Animation](class__dialogicanimation.md)
85-
- [AutoAdvance](class__dialogicautoadvance.md)
86-
- [AutoSkip](class__dialogicautoskip.md)
87-
- [Background](class__dialogicbackground.md)
88-
- [BackgroundTransition](class__dialogicbackgroundtransition.md)
89-
- [CharacterEditorMainSection](class__dialogiccharactereditormainsection.md)
90-
- [CharacterEditorPortraitSection](class__dialogiccharactereditorportraitsection.md)
91-
- [CsvFile](class__dialogiccsvfile.md)
92-
- [Editor](class__dialogiceditor.md)
93-
- [GameHandler](class__dialogicgamehandler.md)
94-
- [Indexer](class__dialogicindexer.md)
95-
- [LayoutBase](class__dialogiclayoutbase.md)
96-
- [LayoutLayer](class__dialogiclayoutlayer.md)
97-
- [ManualAdvance](class__dialogicmanualadvance.md)
98-
- [Portrait](class__dialogicportrait.md)
99-
- [PortraitAnimationUtil](class__dialogicportraitanimationutil.md)
100-
- [ResourceUtil](class__dialogicresourceutil.md)
101-
- [SettingsPage](class__dialogicsettingspage.md)
102-
- [Sidebar.ResourceListItem](class__dialogicsidebar.resourcelistitem.md)
103-
- [Sidebar](class__dialogicsidebar.md)
85+
- [BackgroundTransition](classes/class_dialogicbackgroundtransition.md)
86+
- [CharacterEditorMainSection](classes/class_dialogiccharactereditormainsection.md)
87+
- [CharacterEditorPortraitSection](classes/class_dialogiccharactereditorportraitsection.md)
88+
- [CharacterPrefixSuffixSection](classes/class_dialogiccharacterprefixsuffixsection.md)
89+
- [CsvFile](classes/class_dialogiccsvfile.md)
90+
- [Editor](classes/class_dialogiceditor.md)
91+
- [GameHandler](classes/class_dialogicgamehandler.md)
92+
- [Indexer](classes/class_dialogicindexer.md)
93+
- [LayoutBase](classes/class_dialogiclayoutbase.md)
94+
- [LayoutLayer](classes/class_dialogiclayoutlayer.md)
95+
- [ManualAdvance](classes/class_dialogicmanualadvance.md)
96+
- [Portrait](classes/class_dialogicportrait.md)
97+
- [PortraitAnimationUtil](classes/class_dialogicportraitanimationutil.md)
98+
- [ResourceUtil](classes/class_dialogicresourceutil.md)
99+
- [RichTextTransitionEffect](classes/class_dialogicrichtexttransitioneffect.md)
100+
- [SettingsPage](classes/class_dialogicsettingspage.md)
101+
- [Sidebar.ResourceListItem](classes/class_dialogicsidebar.resourcelistitem.md)
102+
- [Sidebar](classes/class_dialogicsidebar.md)
103+
- [StylesUtil](classes/class_dialogicstylesutil.md)
104104
- [Subsystem](_dialogicsubsystem.md)
105-
- [Util](class__dialogicutil.md)
106-
- [VisualEditorField](class__dialogicvisualeditorfield.md)
107-
- [VisualEditorFieldNumber](class__dialogicvisualeditorfieldnumber.md)
108-
- [VisualEditorFieldVector](class__dialogicvisualeditorfieldvector.md)
105+
- [Util](classes/class_dialogicutil.md)
106+
- [VisualEditorField](classes/class_dialogicvisualeditorfield.md)
107+
- [VisualEditorFieldNumber](classes/class_dialogicvisualeditorfieldnumber.md)
108+
- [VisualEditorFieldVector](classes/class_dialogicvisualeditorfieldvector.md)

documentation/classes/class_dialogicanimation.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,9 @@ Returns | Method
2828
<span style = "color: gray">void</span> | [<span class="hljs-title">pause</span>](#method-pause) ( )
2929
<span style = "color: gray">void</span> | [<span class="hljs-title">resume</span>](#method-resume) ( )
3030
<span class="hljs-attribute">[String](https://docs.godotengine.org/en/latest/classes/class_string.html#class-string)</span> | [<span class="hljs-title">get_modulation_property</span>](#method-get_modulation_property) ( )
31+
<span class="hljs-attribute">[Vector2](https://docs.godotengine.org/en/latest/classes/class_vector2.html#class-vector2)</span> | [<span class="hljs-title">get_node_size</span>](#method-get_node_size) ( )
32+
<span class="hljs-attribute">[Vector2](https://docs.godotengine.org/en/latest/classes/class_vector2.html#class-vector2)</span> | [<span class="hljs-title">get_node_origin</span>](#method-get_node_origin) ( )
33+
<span class="hljs-attribute">[Vector2](https://docs.godotengine.org/en/latest/classes/class_vector2.html#class-vector2)</span> | [<span class="hljs-title">get_viewport_size</span>](#method-get_viewport_size) ( )
3134
---
3235
## Constants
3336

@@ -202,3 +205,33 @@ If the animation wants to change the modulation, this method will return the pro
202205

203206
---
204207

208+
209+
210+
<a class="header" id="method-get_node_size" href="#method-get_node_size">**<span class="hljs-attribute">func</span> [<span class="hljs-title">get_node_size</span>](#method-get_node_size) ( )</a> ⇒ <span class="hljs-attribute">[Vector2](https://docs.godotengine.org/en/latest/classes/class_vector2.html#class-vector2)</span>**
211+
212+
213+
214+
Tries to return the size of the node to be animated. For portraits this uses the portrait containers size. This is useful if your animation depends on the size of the node.
215+
216+
---
217+
218+
219+
220+
<a class="header" id="method-get_node_origin" href="#method-get_node_origin">**<span class="hljs-attribute">func</span> [<span class="hljs-title">get_node_origin</span>](#method-get_node_origin) ( )</a> ⇒ <span class="hljs-attribute">[Vector2](https://docs.godotengine.org/en/latest/classes/class_vector2.html#class-vector2)</span>**
221+
222+
223+
224+
<span style = "color: gray">*No description available.*</span>
225+
226+
---
227+
228+
229+
230+
<a class="header" id="method-get_viewport_size" href="#method-get_viewport_size">**<span class="hljs-attribute">func</span> [<span class="hljs-title">get_viewport_size</span>](#method-get_viewport_size) ( )</a> ⇒ <span class="hljs-attribute">[Vector2](https://docs.godotengine.org/en/latest/classes/class_vector2.html#class-vector2)</span>**
231+
232+
233+
234+
<span style = "color: gray">*No description available.*</span>
235+
236+
---
237+

0 commit comments

Comments
 (0)