virtualx-engine/doc/classes/ProximityGroup.xml
Rémi Verschelde f5836b40d4
doc: Use self-closing tags for return and argument
For the time being we don't support writing a description for those, preferring
having all details in the method's description.

Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.

(cherry picked from commit 7adf4cc9b5)
2021-08-03 10:20:19 +02:00

42 lines
1.3 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="ProximityGroup" inherits="Spatial" version="3.4">
<brief_description>
General-purpose proximity detection node.
</brief_description>
<description>
General-purpose proximity detection node.
</description>
<tutorials>
</tutorials>
<methods>
<method name="broadcast">
<return type="void" />
<argument index="0" name="method" type="String" />
<argument index="1" name="parameters" type="Variant" />
<description>
</description>
</method>
</methods>
<members>
<member name="dispatch_mode" type="int" setter="set_dispatch_mode" getter="get_dispatch_mode" enum="ProximityGroup.DispatchMode" default="0">
</member>
<member name="grid_radius" type="Vector3" setter="set_grid_radius" getter="get_grid_radius" default="Vector3( 1, 1, 1 )">
</member>
<member name="group_name" type="String" setter="set_group_name" getter="get_group_name" default="&quot;&quot;">
</member>
</members>
<signals>
<signal name="broadcast">
<argument index="0" name="method" type="String" />
<argument index="1" name="parameters" type="Array" />
<description>
</description>
</signal>
</signals>
<constants>
<constant name="MODE_PROXY" value="0" enum="DispatchMode">
</constant>
<constant name="MODE_SIGNAL" value="1" enum="DispatchMode">
</constant>
</constants>
</class>