Add and update class docs

- Add docs for BTSetVar
This commit is contained in:
Serhii Snitsaruk 2023-08-07 15:30:04 +02:00
parent 471a12fec4
commit 5204bf644e
33 changed files with 20 additions and 90 deletions

View File

@ -7,7 +7,4 @@
</description>
<tutorials>
</tutorials>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="AABB(0, 0, 0, 0, 0, 0)" />
</members>
</class>

View File

@ -7,7 +7,4 @@
</description>
<tutorials>
</tutorials>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="[]" />
</members>
</class>

View File

@ -7,7 +7,4 @@
</description>
<tutorials>
</tutorials>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="Basis(1, 0, 0, 0, 1, 0, 0, 0, 1)" />
</members>
</class>

View File

@ -7,7 +7,4 @@
</description>
<tutorials>
</tutorials>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="false" />
</members>
</class>

View File

@ -7,7 +7,4 @@
</description>
<tutorials>
</tutorials>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="PackedByteArray()" />
</members>
</class>

View File

@ -7,7 +7,4 @@
</description>
<tutorials>
</tutorials>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="Color(0, 0, 0, 1)" />
</members>
</class>

View File

@ -7,7 +7,4 @@
</description>
<tutorials>
</tutorials>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="PackedColorArray()" />
</members>
</class>

View File

@ -7,7 +7,4 @@
</description>
<tutorials>
</tutorials>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="{}" />
</members>
</class>

View File

@ -7,7 +7,4 @@
</description>
<tutorials>
</tutorials>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="0.0" />
</members>
</class>

View File

@ -6,7 +6,4 @@
</description>
<tutorials>
</tutorials>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="PackedFloat64Array()" />
</members>
</class>

View File

@ -7,7 +7,4 @@
</description>
<tutorials>
</tutorials>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="PackedInt64Array()" />
</members>
</class>

View File

@ -7,7 +7,4 @@
</description>
<tutorials>
</tutorials>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="NodePath(&quot;&quot;)" />
</members>
</class>

View File

@ -28,7 +28,7 @@
</method>
</methods>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" default="0">
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" default="null">
A value that is saved with BBParam resource. The type of value is defined by [method get_type]. Provides the parameter's value, if [member value_source] is [constant SAVED_VALUE].
</member>
<member name="value_source" type="int" setter="set_value_source" getter="get_value_source" enum="BBParam.ValueSource" default="0">

View File

@ -7,7 +7,4 @@
</description>
<tutorials>
</tutorials>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="Plane(0, 0, 0, 0)" />
</members>
</class>

View File

@ -6,7 +6,4 @@
</description>
<tutorials>
</tutorials>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="Quaternion(0, 0, 0, 1)" />
</members>
</class>

View File

@ -7,7 +7,4 @@
</description>
<tutorials>
</tutorials>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="Rect2(0, 0, 0, 0)" />
</members>
</class>

View File

@ -6,7 +6,4 @@
</description>
<tutorials>
</tutorials>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="Rect2i(0, 0, 0, 0)" />
</members>
</class>

View File

@ -7,7 +7,4 @@
</description>
<tutorials>
</tutorials>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="&quot;&quot;" />
</members>
</class>

View File

@ -7,7 +7,4 @@
</description>
<tutorials>
</tutorials>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="PackedStringArray()" />
</members>
</class>

View File

@ -6,7 +6,4 @@
</description>
<tutorials>
</tutorials>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="&amp;&quot;&quot;" />
</members>
</class>

View File

@ -7,7 +7,4 @@
</description>
<tutorials>
</tutorials>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="Transform2D(1, 0, 0, 1, 0, 0)" />
</members>
</class>

View File

@ -6,7 +6,4 @@
</description>
<tutorials>
</tutorials>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)" />
</members>
</class>

View File

@ -8,7 +8,6 @@
<tutorials>
</tutorials>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="null" />
<member name="type" type="int" setter="set_type" getter="get_type" enum="Variant.Type" default="0">
</member>
</members>

View File

@ -7,7 +7,4 @@
</description>
<tutorials>
</tutorials>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="Vector2(0, 0)" />
</members>
</class>

View File

@ -7,7 +7,4 @@
</description>
<tutorials>
</tutorials>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="PackedVector2Array()" />
</members>
</class>

View File

@ -6,7 +6,4 @@
</description>
<tutorials>
</tutorials>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="Vector2i(0, 0)" />
</members>
</class>

View File

@ -7,7 +7,4 @@
</description>
<tutorials>
</tutorials>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="Vector3(0, 0, 0)" />
</members>
</class>

View File

@ -7,7 +7,4 @@
</description>
<tutorials>
</tutorials>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="PackedVector3Array()" />
</members>
</class>

View File

@ -6,7 +6,4 @@
</description>
<tutorials>
</tutorials>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="Vector3i(0, 0, 0)" />
</members>
</class>

View File

@ -6,7 +6,4 @@
</description>
<tutorials>
</tutorials>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="Vector4(0, 0, 0, 0)" />
</members>
</class>

View File

@ -6,7 +6,4 @@
</description>
<tutorials>
</tutorials>
<members>
<member name="saved_value" type="Variant" setter="set_saved_value" getter="get_saved_value" overrides="BBParam" default="Vector4i(0, 0, 0, 0)" />
</members>
</class>

18
doc_classes/BTSetVar.xml Normal file
View File

@ -0,0 +1,18 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="BTSetVar" inherits="BTAction" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
BT action that assigns [member value] to the [member variable] and then returns [code]SUCCESS[/code].
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<members>
<member name="value" type="BBVariant" setter="set_value" getter="get_value">
Parameter that specifies the value to be assigned to the variable.
</member>
<member name="variable" type="String" setter="set_variable" getter="get_variable" default="&quot;&quot;">
Variable name whose value is to be assigned.
</member>
</members>
</class>