godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/ProximityGroup.xml

48 lines
1.4 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
doc: Update classref headers with 3.4 version
2021-04-26 11:14:51 +00:00
<class name="ProximityGroup" inherits="Spatial" version="3.4">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<brief_description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
General-purpose proximity detection node.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</brief_description>
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
General-purpose proximity detection node.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
<tutorials>
</tutorials>
<methods>
<method name="broadcast">
<return type="void">
</return>
ProximityGroup: Fix access modifiers, rename private methods for clarity See #36285 which mistakenly added documentation for the whole C++ API, while some of it is meant to be and stay private as it's not exposed to scripts. The access modifiers and method prefix were not used properly. Cleanup code, and rename wrong `group_name` parameters to `method`, as it's a method name which is being broadcast. This is a very old class from pre-open source days, chances are that it was just forgotten and not meant to be kept as is and undocumented. (cherry picked from commit 79ba70f7ee1eabeabc7e62256eea3670506a2e7f)
2020-12-11 13:26:50 +00:00
<argument index="0" name="method" type="String">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<argument index="1" name="parameters" type="Variant">
</argument>
<description>
</description>
</method>
</methods>
<members>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="dispatch_mode" type="int" setter="set_dispatch_mode" getter="get_dispatch_mode" enum="ProximityGroup.DispatchMode" default="0">
Update docs [ci skip]
2018-01-11 22:38:35 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="grid_radius" type="Vector3" setter="set_grid_radius" getter="get_grid_radius" default="Vector3( 1, 1, 1 )">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="group_name" type="String" setter="set_group_name" getter="get_group_name" default="&quot;&quot;">
Update docs [ci skip]
2018-01-11 22:38:35 +00:00
</member>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</members>
<signals>
<signal name="broadcast">
ProximityGroup: Fix access modifiers, rename private methods for clarity See #36285 which mistakenly added documentation for the whole C++ API, while some of it is meant to be and stay private as it's not exposed to scripts. The access modifiers and method prefix were not used properly. Cleanup code, and rename wrong `group_name` parameters to `method`, as it's a method name which is being broadcast. This is a very old class from pre-open source days, chances are that it was just forgotten and not meant to be kept as is and undocumented. (cherry picked from commit 79ba70f7ee1eabeabc7e62256eea3670506a2e7f)
2020-12-11 13:26:50 +00:00
<argument index="0" name="method" type="String">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<argument index="1" name="parameters" type="Array">
</argument>
<description>
</description>
</signal>
</signals>
<constants>
Update docs [ci skip]
2018-01-11 22:38:35 +00:00
<constant name="MODE_PROXY" value="0" enum="DispatchMode">
</constant>
<constant name="MODE_SIGNAL" value="1" enum="DispatchMode">
</constant>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constants>
</class>