Skip to content

Commit

Permalink
Update documentation [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
GDevelop documentation CI committed Jul 6, 2024
1 parent d16c138 commit 04bf586
Show file tree
Hide file tree
Showing 407 changed files with 9,871 additions and 11,828 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@
<div class="ttc" id="aclassgd_1_1_arbitrary_events_worker_with_context_html_a9647e80dede99ca1cd2b9d3764a11516"><div class="ttname"><a href="classgd_1_1_arbitrary_events_worker_with_context.html#a9647e80dede99ca1cd2b9d3764a11516">gd::ArbitraryEventsWorkerWithContext::Launch</a></div><div class="ttdeci">void Launch(gd::EventsList &amp;events, const gd::ProjectScopedContainers &amp;projectScopedContainers)</div><div class="ttdoc">Launch the worker on the specified events list, giving the objects container on which the events are ...</div><div class="ttdef"><b>Definition:</b> ArbitraryEventsWorker.h:146</div></div>
<div class="ttc" id="aclassgd_1_1_base_event_html"><div class="ttname"><a href="classgd_1_1_base_event.html">gd::BaseEvent</a></div><div class="ttdoc">Base class defining an event.</div><div class="ttdef"><b>Definition:</b> Event.h:43</div></div>
<div class="ttc" id="aclassgd_1_1_event_visitor_html"><div class="ttname"><a href="classgd_1_1_event_visitor.html">gd::EventVisitor</a></div><div class="ttdoc">Visitor of any kind of event.</div><div class="ttdef"><b>Definition:</b> EventVisitor.h:26</div></div>
<div class="ttc" id="aclassgd_1_1_events_list_html"><div class="ttname"><a href="classgd_1_1_events_list.html">gd::EventsList</a></div><div class="ttdoc">A list of events.</div><div class="ttdef"><b>Definition:</b> EventsList.h:33</div></div>
<div class="ttc" id="aclassgd_1_1_events_list_html"><div class="ttname"><a href="classgd_1_1_events_list.html">gd::EventsList</a></div><div class="ttdoc">A list of events.</div><div class="ttdef"><b>Definition:</b> EventsList.h:32</div></div>
<div class="ttc" id="aclassgd_1_1_expression_html"><div class="ttname"><a href="classgd_1_1_expression.html">gd::Expression</a></div><div class="ttdoc">Class representing an expression used as a parameter of a gd::Instruction. This class is nothing more...</div><div class="ttdef"><b>Definition:</b> Expression.h:30</div></div>
<div class="ttc" id="aclassgd_1_1_instruction_html"><div class="ttname"><a href="classgd_1_1_instruction.html">gd::Instruction</a></div><div class="ttdoc">An instruction is a member of an event: It can be a condition or an action.</div><div class="ttdef"><b>Definition:</b> Instruction.h:30</div></div>
<div class="ttc" id="aclassgd_1_1_instructions_list_html"><div class="ttname"><a href="classgd_1_1_instructions_list.html">gd::InstructionsList</a></div><div class="ttdef"><b>Definition:</b> InstructionsList.h:25</div></div>
Expand Down
2 changes: 1 addition & 1 deletion GDCore Documentation/_async_event_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@
<div class="ttc" id="aclassgd_1_1_async_event_html_a7d5fec0ba3cf6c44f4fae1857fa5cada"><div class="ttname"><a href="classgd_1_1_async_event.html#a7d5fec0ba3cf6c44f4fae1857fa5cada">gd::AsyncEvent::GetSubEvents</a></div><div class="ttdeci">virtual gd::EventsList &amp; GetSubEvents()</div><div class="ttdef"><b>Definition:</b> AsyncEvent.h:41</div></div>
<div class="ttc" id="aclassgd_1_1_async_event_html_afe8dea6998223ab5973c5da10374f62f"><div class="ttname"><a href="classgd_1_1_async_event.html#afe8dea6998223ab5973c5da10374f62f">gd::AsyncEvent::GetSubEvents</a></div><div class="ttdeci">virtual const gd::EventsList &amp; GetSubEvents() const</div><div class="ttdef"><b>Definition:</b> AsyncEvent.h:40</div></div>
<div class="ttc" id="aclassgd_1_1_base_event_html"><div class="ttname"><a href="classgd_1_1_base_event.html">gd::BaseEvent</a></div><div class="ttdoc">Base class defining an event.</div><div class="ttdef"><b>Definition:</b> Event.h:43</div></div>
<div class="ttc" id="aclassgd_1_1_events_list_html"><div class="ttname"><a href="classgd_1_1_events_list.html">gd::EventsList</a></div><div class="ttdoc">A list of events.</div><div class="ttdef"><b>Definition:</b> EventsList.h:33</div></div>
<div class="ttc" id="aclassgd_1_1_events_list_html"><div class="ttname"><a href="classgd_1_1_events_list.html">gd::EventsList</a></div><div class="ttdoc">A list of events.</div><div class="ttdef"><b>Definition:</b> EventsList.h:32</div></div>
<div class="ttc" id="aclassgd_1_1_instruction_html"><div class="ttname"><a href="classgd_1_1_instruction.html">gd::Instruction</a></div><div class="ttdoc">An instruction is a member of an event: It can be a condition or an action.</div><div class="ttdef"><b>Definition:</b> Instruction.h:30</div></div>
<div class="ttc" id="aclassgd_1_1_instructions_list_html"><div class="ttname"><a href="classgd_1_1_instructions_list.html">gd::InstructionsList</a></div><div class="ttdef"><b>Definition:</b> InstructionsList.h:25</div></div>
<div class="ttc" id="anamespacegd_html"><div class="ttname"><a href="namespacegd.html">gd</a></div><div class="ttdef"><b>Definition:</b> CommonTools.h:24</div></div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@
<div class="ttc" id="aclassgd_1_1_custom_object_configuration_html_acc2a91a3ad164645fb1cff1fbdba75f0"><div class="ttname"><a href="classgd_1_1_custom_object_configuration.html#acc2a91a3ad164645fb1cff1fbdba75f0">gd::CustomObjectConfiguration::UpdateInitialInstanceProperty</a></div><div class="ttdeci">bool UpdateInitialInstanceProperty(gd::InitialInstance &amp;instance, const gd::String &amp;name, const gd::String &amp;value, gd::Project &amp;project, gd::Layout &amp;scene) override</div><div class="ttdoc">Called when the IDE wants to update a custom property of an initial instance of this object configura...</div><div class="ttdef"><b>Definition:</b> CustomObjectConfiguration.cpp:106</div></div>
<div class="ttc" id="aclassgd_1_1_custom_object_configuration_html_af55a9ab1f2dc8c53aaca57f07318392a"><div class="ttname"><a href="classgd_1_1_custom_object_configuration.html#af55a9ab1f2dc8c53aaca57f07318392a">gd::CustomObjectConfiguration::Clone</a></div><div class="ttdeci">std::unique_ptr&lt; gd::ObjectConfiguration &gt; Clone() const override</div><div class="ttdef"><b>Definition:</b> CustomObjectConfiguration.cpp:34</div></div>
<div class="ttc" id="aclassgd_1_1_initial_instance_html"><div class="ttname"><a href="classgd_1_1_initial_instance.html">gd::InitialInstance</a></div><div class="ttdoc">Represents an instance of an object to be created on a layout start up.</div><div class="ttdef"><b>Definition:</b> InitialInstance.h:25</div></div>
<div class="ttc" id="aclassgd_1_1_layout_html"><div class="ttname"><a href="classgd_1_1_layout.html">gd::Layout</a></div><div class="ttdoc">Represent a layout ( also called a scene ) of a project.</div><div class="ttdef"><b>Definition:</b> Layout.h:39</div></div>
<div class="ttc" id="aclassgd_1_1_layout_html"><div class="ttname"><a href="classgd_1_1_layout.html">gd::Layout</a></div><div class="ttdoc">Represent a layout ( also called a scene ) of a project.</div><div class="ttdef"><b>Definition:</b> Layout.h:38</div></div>
<div class="ttc" id="aclassgd_1_1_object_configuration_html"><div class="ttname"><a href="classgd_1_1_object_configuration.html">gd::ObjectConfiguration</a></div><div class="ttdoc">Base class used to represent an object configuration. For example, this can be the animations in a sp...</div><div class="ttdef"><b>Definition:</b> ObjectConfiguration.h:38</div></div>
<div class="ttc" id="aclassgd_1_1_object_configuration_html_a1b5e284a1fbc2db3733633ea08a41eda"><div class="ttname"><a href="classgd_1_1_object_configuration.html#a1b5e284a1fbc2db3733633ea08a41eda">gd::ObjectConfiguration::SetType</a></div><div class="ttdeci">void SetType(const gd::String &amp;type_)</div><div class="ttdoc">Change the type of the object.</div><div class="ttdef"><b>Definition:</b> ObjectConfiguration.h:64</div></div>
<div class="ttc" id="aclassgd_1_1_project_html"><div class="ttname"><a href="classgd_1_1_project.html">gd::Project</a></div><div class="ttdoc">Base class representing a project (game), including all resources, scenes, objects,...</div><div class="ttdef"><b>Definition:</b> Project.h:51</div></div>
Expand Down
4 changes: 2 additions & 2 deletions GDCore Documentation/_dependencies_analyzer_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -146,9 +146,9 @@
<div class="ttc" id="aclass_dependencies_analyzer_html_a2fad88126471502a84705a35393d9d41"><div class="ttname"><a href="class_dependencies_analyzer.html#a2fad88126471502a84705a35393d9d41">DependenciesAnalyzer::GetScenesDependencies</a></div><div class="ttdeci">const std::set&lt; gd::String &gt; &amp; GetScenesDependencies() const</div><div class="ttdoc">Return the scenes being dependencies of the scene or external events passed in the constructor.</div><div class="ttdef"><b>Definition:</b> DependenciesAnalyzer.h:62</div></div>
<div class="ttc" id="aclass_dependencies_analyzer_html_aaf3edc27ceedc7ded97926263f244911"><div class="ttname"><a href="class_dependencies_analyzer.html#aaf3edc27ceedc7ded97926263f244911">DependenciesAnalyzer::GetExternalEventsDependencies</a></div><div class="ttdeci">const std::set&lt; gd::String &gt; &amp; GetExternalEventsDependencies() const</div><div class="ttdoc">Return the external events being dependencies of the scene or external events passed in the construct...</div><div class="ttdef"><b>Definition:</b> DependenciesAnalyzer.h:70</div></div>
<div class="ttc" id="aclass_dependencies_analyzer_html_ae712c9cab83abd211452ad8bffa20261"><div class="ttname"><a href="class_dependencies_analyzer.html#ae712c9cab83abd211452ad8bffa20261">DependenciesAnalyzer::GetSourceFilesDependencies</a></div><div class="ttdeci">const std::set&lt; gd::String &gt; &amp; GetSourceFilesDependencies() const</div><div class="ttdoc">Return the source files being dependencies of the scene or external events passed in the constructor.</div><div class="ttdef"><b>Definition:</b> DependenciesAnalyzer.h:78</div></div>
<div class="ttc" id="aclassgd_1_1_events_list_html"><div class="ttname"><a href="classgd_1_1_events_list.html">gd::EventsList</a></div><div class="ttdoc">A list of events.</div><div class="ttdef"><b>Definition:</b> EventsList.h:33</div></div>
<div class="ttc" id="aclassgd_1_1_events_list_html"><div class="ttname"><a href="classgd_1_1_events_list.html">gd::EventsList</a></div><div class="ttdoc">A list of events.</div><div class="ttdef"><b>Definition:</b> EventsList.h:32</div></div>
<div class="ttc" id="aclassgd_1_1_external_events_html"><div class="ttname"><a href="classgd_1_1_external_events.html">gd::ExternalEvents</a></div><div class="ttdoc">Contains a list of events not directly linked to a layout.</div><div class="ttdef"><b>Definition:</b> ExternalEvents.h:31</div></div>
<div class="ttc" id="aclassgd_1_1_layout_html"><div class="ttname"><a href="classgd_1_1_layout.html">gd::Layout</a></div><div class="ttdoc">Represent a layout ( also called a scene ) of a project.</div><div class="ttdef"><b>Definition:</b> Layout.h:39</div></div>
<div class="ttc" id="aclassgd_1_1_layout_html"><div class="ttname"><a href="classgd_1_1_layout.html">gd::Layout</a></div><div class="ttdoc">Represent a layout ( also called a scene ) of a project.</div><div class="ttdef"><b>Definition:</b> Layout.h:38</div></div>
<div class="ttc" id="aclassgd_1_1_project_html"><div class="ttname"><a href="classgd_1_1_project.html">gd::Project</a></div><div class="ttdoc">Base class representing a project (game), including all resources, scenes, objects,...</div><div class="ttdef"><b>Definition:</b> Project.h:51</div></div>
<div class="ttc" id="anamespacegd_html"><div class="ttname"><a href="namespacegd.html">gd</a></div><div class="ttdef"><b>Definition:</b> CommonTools.h:24</div></div>
</div><!-- fragment --></div><!-- contents -->
Expand Down
4 changes: 2 additions & 2 deletions GDCore Documentation/_event_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -280,13 +280,13 @@
<div class="ttc" id="aclassgd_1_1_event_visitor_html"><div class="ttname"><a href="classgd_1_1_event_visitor.html">gd::EventVisitor</a></div><div class="ttdoc">Visitor of any kind of event.</div><div class="ttdef"><b>Definition:</b> EventVisitor.h:26</div></div>
<div class="ttc" id="aclassgd_1_1_events_code_generation_context_html"><div class="ttname"><a href="classgd_1_1_events_code_generation_context.html">gd::EventsCodeGenerationContext</a></div><div class="ttdoc">Used to manage the context when generating code for events.</div><div class="ttdef"><b>Definition:</b> EventsCodeGenerationContext.h:27</div></div>
<div class="ttc" id="aclassgd_1_1_events_code_generator_html"><div class="ttname"><a href="classgd_1_1_events_code_generator.html">gd::EventsCodeGenerator</a></div><div class="ttdoc">Internal class used to generate code from events.</div><div class="ttdef"><b>Definition:</b> EventsCodeGenerator.h:41</div></div>
<div class="ttc" id="aclassgd_1_1_events_list_html"><div class="ttname"><a href="classgd_1_1_events_list.html">gd::EventsList</a></div><div class="ttdoc">A list of events.</div><div class="ttdef"><b>Definition:</b> EventsList.h:33</div></div>
<div class="ttc" id="aclassgd_1_1_events_list_html"><div class="ttname"><a href="classgd_1_1_events_list.html">gd::EventsList</a></div><div class="ttdoc">A list of events.</div><div class="ttdef"><b>Definition:</b> EventsList.h:32</div></div>
<div class="ttc" id="aclassgd_1_1_platform_html"><div class="ttname"><a href="classgd_1_1_platform.html">gd::Platform</a></div><div class="ttdoc">Base class for implementing a platform.</div><div class="ttdef"><b>Definition:</b> Platform.h:42</div></div>
<div class="ttc" id="aclassgd_1_1_project_html"><div class="ttname"><a href="classgd_1_1_project.html">gd::Project</a></div><div class="ttdoc">Base class representing a project (game), including all resources, scenes, objects,...</div><div class="ttdef"><b>Definition:</b> Project.h:51</div></div>
<div class="ttc" id="aclassgd_1_1_read_only_event_visitor_html"><div class="ttname"><a href="classgd_1_1_read_only_event_visitor.html">gd::ReadOnlyEventVisitor</a></div><div class="ttdoc">Visitor of any kind of event.</div><div class="ttdef"><b>Definition:</b> EventVisitor.h:54</div></div>
<div class="ttc" id="aclassgd_1_1_serializer_element_html"><div class="ttname"><a href="classgd_1_1_serializer_element.html">gd::SerializerElement</a></div><div class="ttdoc">A generic container that can represent a value ( containing a string, double, bool or int),...</div><div class="ttdef"><b>Definition:</b> SerializerElement.h:37</div></div>
<div class="ttc" id="aclassgd_1_1_string_html"><div class="ttname"><a href="classgd_1_1_string.html">gd::String</a></div><div class="ttdoc">String represents an UTF8 encoded string.</div><div class="ttdef"><b>Definition:</b> String.h:31</div></div>
<div class="ttc" id="aclassgd_1_1_variables_container_html"><div class="ttname"><a href="classgd_1_1_variables_container.html">gd::VariablesContainer</a></div><div class="ttdoc">Class defining a container for gd::Variable.</div><div class="ttdef"><b>Definition:</b> VariablesContainer.h:29</div></div>
<div class="ttc" id="aclassgd_1_1_variables_container_html"><div class="ttname"><a href="classgd_1_1_variables_container.html">gd::VariablesContainer</a></div><div class="ttdoc">Class defining a container for gd::Variable.</div><div class="ttdef"><b>Definition:</b> VariablesContainer.h:28</div></div>
<div class="ttc" id="agroup___events_html_ga48cf8614cb43e52b30f8e7123b111e10"><div class="ttname"><a href="group___events.html#ga48cf8614cb43e52b30f8e7123b111e10">gd::CloneRememberingOriginalEvent</a></div><div class="ttdeci">BaseEventSPtr GD_CORE_API CloneRememberingOriginalEvent(BaseEventSPtr event)</div><div class="ttdef"><b>Definition:</b> Event.cpp:155</div></div>
<div class="ttc" id="anamespacegd_html"><div class="ttname"><a href="namespacegd.html">gd</a></div><div class="ttdef"><b>Definition:</b> CommonTools.h:24</div></div>
</div><!-- fragment --></div><!-- contents -->
Expand Down
2 changes: 1 addition & 1 deletion GDCore Documentation/_event_metadata_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@
<div class="ttc" id="aclassgd_1_1_event_metadata_html_a97833b0bc30ce98f163841231eef96cd"><div class="ttname"><a href="classgd_1_1_event_metadata.html#a97833b0bc30ce98f163841231eef96cd">gd::EventMetadata::SetPreprocessing</a></div><div class="ttdeci">EventMetadata &amp; SetPreprocessing(std::function&lt; void(gd::BaseEvent &amp;event, gd::EventsCodeGenerator &amp;codeGenerator, gd::EventsList &amp;eventList, std::size_t indexOfTheEventInThisList)&gt; function)</div><div class="ttdoc">Set the code to preprocess the event.</div><div class="ttdef"><b>Definition:</b> EventMetadata.h:47</div></div>
<div class="ttc" id="aclassgd_1_1_events_code_generation_context_html"><div class="ttname"><a href="classgd_1_1_events_code_generation_context.html">gd::EventsCodeGenerationContext</a></div><div class="ttdoc">Used to manage the context when generating code for events.</div><div class="ttdef"><b>Definition:</b> EventsCodeGenerationContext.h:27</div></div>
<div class="ttc" id="aclassgd_1_1_events_code_generator_html"><div class="ttname"><a href="classgd_1_1_events_code_generator.html">gd::EventsCodeGenerator</a></div><div class="ttdoc">Internal class used to generate code from events.</div><div class="ttdef"><b>Definition:</b> EventsCodeGenerator.h:41</div></div>
<div class="ttc" id="aclassgd_1_1_events_list_html"><div class="ttname"><a href="classgd_1_1_events_list.html">gd::EventsList</a></div><div class="ttdoc">A list of events.</div><div class="ttdef"><b>Definition:</b> EventsList.h:33</div></div>
<div class="ttc" id="aclassgd_1_1_events_list_html"><div class="ttname"><a href="classgd_1_1_events_list.html">gd::EventsList</a></div><div class="ttdoc">A list of events.</div><div class="ttdef"><b>Definition:</b> EventsList.h:32</div></div>
<div class="ttc" id="aclassgd_1_1_string_html"><div class="ttname"><a href="classgd_1_1_string.html">gd::String</a></div><div class="ttdoc">String represents an UTF8 encoded string.</div><div class="ttdef"><b>Definition:</b> String.h:31</div></div>
<div class="ttc" id="anamespacegd_html"><div class="ttname"><a href="namespacegd.html">gd</a></div><div class="ttdef"><b>Definition:</b> CommonTools.h:24</div></div>
</div><!-- fragment --></div><!-- contents -->
Expand Down
Loading

0 comments on commit 04bf586

Please sign in to comment.