godot/doc/classes/ProximityGroup.xml
Rémi Verschelde 1a64f5d2ec
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 79ba70f7ee)
2020-12-29 16:01:58 +01:00

48 lines
1.4 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="ProximityGroup" inherits="Spatial" version="3.2">
<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">
</return>
<argument index="0" name="method" type="String">
</argument>
<argument index="1" name="parameters" type="Variant">
</argument>
<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>
<argument index="1" name="parameters" type="Array">
</argument>
<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>