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 Oct 15, 2024
1 parent 6001ae8 commit 283b908
Show file tree
Hide file tree
Showing 544 changed files with 11,485 additions and 11,777 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@
<div class="line">} <span class="comment">// namespace gd</span></div>
<div class="line"><span class="preprocessor">#endif </span><span class="comment">// DEPENDENCYMETADATA_H</span></div>
<div class="ttc" id="aclassgd_1_1_property_descriptor_html"><div class="ttname"><a href="classgd_1_1_property_descriptor.html">gd::PropertyDescriptor</a></div><div class="ttdoc">Used to describe a property shown in a property grid.</div><div class="ttdef"><b>Definition:</b> PropertyDescriptor.h:25</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_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:33</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 class="ttc" id="anamespacegd_html_a73c8d31b71086a051978c6e953211c96"><div class="ttname"><a href="namespacegd.html#a73c8d31b71086a051978c6e953211c96">gd::LogWarning</a></div><div class="ttdeci">void GD_CORE_API LogWarning(const gd::String &amp;msg)</div><div class="ttdoc">Standard function that should be used when emitting a warning to be displayed to the user.</div><div class="ttdef"><b>Definition:</b> Log.cpp:11</div></div>
</div><!-- fragment --> </div><!-- contents -->
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@
<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_properties_container_html"><div class="ttname"><a href="classgd_1_1_properties_container.html">gd::PropertiesContainer</a></div><div class="ttdoc">A container of properties, used for custom behaviors, custom objects, extensions.....</div><div class="ttdef"><b>Definition:</b> PropertiesContainer.h:17</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_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:33</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 -->
<!-- start footer part -->
Expand Down
2 changes: 1 addition & 1 deletion GDCore Documentation/_abstract_file_system_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@
<div class="ttc" id="aclassgd_1_1_abstract_file_system_html_aded7ea22bce3dcf6b4b54cc52a4d8eb6"><div class="ttname"><a href="classgd_1_1_abstract_file_system.html#aded7ea22bce3dcf6b4b54cc52a4d8eb6">gd::AbstractFileSystem::MkDir</a></div><div class="ttdeci">virtual void MkDir(const gd::String &amp;path)=0</div><div class="ttdoc">Create the specified directory.</div></div>
<div class="ttc" id="aclassgd_1_1_abstract_file_system_html_ae7ad61537a274a4c6da4d8e07f046116"><div class="ttname"><a href="classgd_1_1_abstract_file_system.html#ae7ad61537a274a4c6da4d8e07f046116">gd::AbstractFileSystem::ClearDir</a></div><div class="ttdeci">virtual bool ClearDir(const gd::String &amp;directory)=0</div><div class="ttdoc">Clear the directory given as parameter, removing all the files.</div></div>
<div class="ttc" id="aclassgd_1_1_abstract_file_system_html_aea9054a2a73f97bf3b533d7c0f6cf12b"><div class="ttname"><a href="classgd_1_1_abstract_file_system.html#aea9054a2a73f97bf3b533d7c0f6cf12b">gd::AbstractFileSystem::CopyFile</a></div><div class="ttdeci">virtual bool CopyFile(const gd::String &amp;file, const gd::String &amp;destination)=0</div><div class="ttdoc">Copy a file.</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_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:33</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 -->
<!-- start footer part -->
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_abstract_function_metadata_html_aec9c78aaef7d5cd591d4af2abeac567b"><div class="ttname"><a href="classgd_1_1_abstract_function_metadata.html#aec9c78aaef7d5cd591d4af2abeac567b">gd::AbstractFunctionMetadata::AddIncludeFile</a></div><div class="ttdeci">virtual AbstractFunctionMetadata &amp; AddIncludeFile(const gd::String &amp;includeFile)=0</div><div class="ttdoc">Add a file to the already existing include files.</div></div>
<div class="ttc" id="aclassgd_1_1_abstract_function_metadata_html_af6a6c5e8114a476001d6e6a569451b4d"><div class="ttname"><a href="classgd_1_1_abstract_function_metadata.html#af6a6c5e8114a476001d6e6a569451b4d">gd::AbstractFunctionMetadata::SetRelevantForAsynchronousFunctionEventsOnly</a></div><div class="ttdeci">virtual AbstractFunctionMetadata &amp; SetRelevantForAsynchronousFunctionEventsOnly()=0</div></div>
<div class="ttc" id="aclassgd_1_1_abstract_function_metadata_html_afc1577c545b6fe1267eda2f5a7aedf1d"><div class="ttname"><a href="classgd_1_1_abstract_function_metadata.html#afc1577c545b6fe1267eda2f5a7aedf1d">gd::AbstractFunctionMetadata::SetIncludeFile</a></div><div class="ttdeci">virtual AbstractFunctionMetadata &amp; SetIncludeFile(const gd::String &amp;includeFile)=0</div><div class="ttdoc">Erase any existing include file and add the specified include.</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_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:33</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 -->
<!-- start footer part -->
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; </div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// GDCORE_COMMONINSTRUCTIONSEXTENSION_H</span></div>
<div class="ttc" id="aclassgd_1_1_builtin_extensions_implementer_html"><div class="ttname"><a href="classgd_1_1_builtin_extensions_implementer.html">gd::BuiltinExtensionsImplementer</a></div><div class="ttdoc">Tool class containing static methods to setup an extension so that it provides standards events,...</div><div class="ttdef"><b>Definition:</b> AllBuiltinExtensions.h:20</div></div>
<div class="ttc" id="aclassgd_1_1_platform_extension_html"><div class="ttname"><a href="classgd_1_1_platform_extension.html">gd::PlatformExtension</a></div><div class="ttdoc">Base class for implementing platform's extensions.</div><div class="ttdef"><b>Definition:</b> PlatformExtension.h:84</div></div>
<div class="ttc" id="aclassgd_1_1_platform_extension_html"><div class="ttname"><a href="classgd_1_1_platform_extension.html">gd::PlatformExtension</a></div><div class="ttdoc">Base class for implementing platform's extensions.</div><div class="ttdef"><b>Definition:</b> PlatformExtension.h:83</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 -->
<!-- start footer part -->
Expand Down
2 changes: 1 addition & 1 deletion GDCore Documentation/_animation_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@
<div class="ttc" id="aclassgd_1_1_animation_html_a7f323aa04638176ff778fd37651049b2"><div class="ttname"><a href="classgd_1_1_animation.html#a7f323aa04638176ff778fd37651049b2">gd::Animation::useMultipleDirections</a></div><div class="ttdeci">bool useMultipleDirections</div><div class="ttdef"><b>Definition:</b> Animation.h:83</div></div>
<div class="ttc" id="aclassgd_1_1_animation_html_ab8ee51916fb5fc489678d24b31a8c3c0"><div class="ttname"><a href="classgd_1_1_animation.html#ab8ee51916fb5fc489678d24b31a8c3c0">gd::Animation::UseMultipleDirections</a></div><div class="ttdeci">bool UseMultipleDirections() const</div><div class="ttdoc">Return true if the animation is composed of more than one direction.</div><div class="ttdef"><b>Definition:</b> Animation.h:73</div></div>
<div class="ttc" id="aclassgd_1_1_direction_html"><div class="ttname"><a href="classgd_1_1_direction.html">gd::Direction</a></div><div class="ttdoc">Class defining a direction (set of frames) of an Animation.</div><div class="ttdef"><b>Definition:</b> Direction.h:28</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_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:33</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 -->
<!-- start footer part -->
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@
<div class="ttc" id="aclassgd_1_1_arbitrary_behavior_shared_data_worker_html"><div class="ttname"><a href="classgd_1_1_arbitrary_behavior_shared_data_worker.html">gd::ArbitraryBehaviorSharedDataWorker</a></div><div class="ttdoc">ArbitraryBehaviorSharedDataWorker is an abstract class used to browse shared data and do some work on...</div><div class="ttdef"><b>Definition:</b> ArbitraryBehaviorSharedDataWorker.h:29</div></div>
<div class="ttc" id="aclassgd_1_1_arbitrary_behavior_shared_data_worker_html_a6e5a8a7a26e6edf5cdd46734f98489a6"><div class="ttname"><a href="classgd_1_1_arbitrary_behavior_shared_data_worker.html#a6e5a8a7a26e6edf5cdd46734f98489a6">gd::ArbitraryBehaviorSharedDataWorker::Launch</a></div><div class="ttdeci">void Launch(const std::map&lt; gd::String, std::unique_ptr&lt; gd::BehaviorsSharedData &gt;&gt; &amp;sharedDatas)</div><div class="ttdoc">Launch the worker on the specified shared data.</div><div class="ttdef"><b>Definition:</b> ArbitraryBehaviorSharedDataWorker.h:37</div></div>
<div class="ttc" id="aclassgd_1_1_behaviors_shared_data_html"><div class="ttname"><a href="classgd_1_1_behaviors_shared_data.html">gd::BehaviorsSharedData</a></div><div class="ttdoc">Base class for defining data shared by behaviors having the same type and name.</div><div class="ttdef"><b>Definition:</b> BehaviorsSharedData.h:24</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_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:33</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 -->
<!-- start footer part -->
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@
<div class="ttc" id="aclassgd_1_1_resource_worker_in_events_worker_html"><div class="ttname"><a href="classgd_1_1_resource_worker_in_events_worker.html">gd::ResourceWorkerInEventsWorker</a></div><div class="ttdef"><b>Definition:</b> ArbitraryResourceWorker.h:151</div></div>
<div class="ttc" id="aclassgd_1_1_resource_worker_in_objects_worker_html"><div class="ttname"><a href="classgd_1_1_resource_worker_in_objects_worker.html">gd::ResourceWorkerInObjectsWorker</a></div><div class="ttdef"><b>Definition:</b> ArbitraryResourceWorker.h:174</div></div>
<div class="ttc" id="aclassgd_1_1_resources_manager_html"><div class="ttname"><a href="classgd_1_1_resources_manager.html">gd::ResourcesManager</a></div><div class="ttdoc">Inventory all resources used by a project.</div><div class="ttdef"><b>Definition:</b> ResourcesManager.h:557</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_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:33</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 -->
<!-- start footer part -->
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@
<div class="ttc" id="aclassgd_1_1_asset_resource_path_cleaner_html_a0db2ebf4db31ba93b372f560278cc912"><div class="ttname"><a href="classgd_1_1_asset_resource_path_cleaner.html#a0db2ebf4db31ba93b372f560278cc912">gd::AssetResourcePathCleaner::resourcesNameReverseMap</a></div><div class="ttdeci">std::map&lt; gd::String, gd::String &gt; &amp; resourcesNameReverseMap</div><div class="ttdef"><b>Definition:</b> AssetResourcePathCleaner.h:62</div></div>
<div class="ttc" id="aclassgd_1_1_asset_resource_path_cleaner_html_a50d03a2c52d67430813154582acd069c"><div class="ttname"><a href="classgd_1_1_asset_resource_path_cleaner.html#a50d03a2c52d67430813154582acd069c">gd::AssetResourcePathCleaner::resourcesFileNameMap</a></div><div class="ttdeci">std::map&lt; gd::String, gd::String &gt; &amp; resourcesFileNameMap</div><div class="ttdef"><b>Definition:</b> AssetResourcePathCleaner.h:57</div></div>
<div class="ttc" id="aclassgd_1_1_resources_manager_html"><div class="ttname"><a href="classgd_1_1_resources_manager.html">gd::ResourcesManager</a></div><div class="ttdoc">Inventory all resources used by a project.</div><div class="ttdef"><b>Definition:</b> ResourcesManager.h:557</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_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:33</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 -->
<!-- start footer part -->
Expand Down
2 changes: 1 addition & 1 deletion GDCore Documentation/_behavior_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// GDCORE_BEHAVIOR_H</span></div>
<div class="ttc" id="aclassgd_1_1_behavior_configuration_container_html"><div class="ttname"><a href="classgd_1_1_behavior_configuration_container.html">gd::BehaviorConfigurationContainer</a></div><div class="ttdoc">Base class for containers of behavior configuration. They can be attached to objects (Behavior) or la...</div><div class="ttdef"><b>Definition:</b> BehaviorConfigurationContainer.h:35</div></div>
<div class="ttc" id="aclassgd_1_1_behavior_html"><div class="ttname"><a href="classgd_1_1_behavior.html">gd::Behavior</a></div><div class="ttdoc">Base class used to represents a behavior that can be applied to an object. It stores the content (i....</div><div class="ttdef"><b>Definition:</b> Behavior.h:23</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_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:33</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 class="ttc" id="anamespacegd_html_a87931627550f265363b6860d3ef8f1d4"><div class="ttname"><a href="namespacegd.html#a87931627550f265363b6860d3ef8f1d4">gd::IsDefaultBehavior</a></div><div class="ttdeci">bool GD_CORE_API IsDefaultBehavior(const gd::ObjectsContainer &amp;project, const gd::ObjectsContainer &amp;layout, gd::String objectOrGroupName, gd::String behaviorName, bool searchInGroups)</div><div class="ttdoc">Check if a behavior is a default one or doesn't exist in an object or all objects of a group.</div><div class="ttdef"><b>Definition:</b> Layout.cpp:622</div></div>
</div><!-- fragment --></div><!-- contents -->
Expand Down
Loading

0 comments on commit 283b908

Please sign in to comment.