Sara/behaviour-tree-test
1
0
Fork 0
Code Issues Pull requests Projects Releases 2 Packages Wiki Activity Actions

doc: Sync classref with StringName/Callable changes

Browse source
This commit is contained in:
Rémi Verschelde 2020-02-22 14:59:09 +01:00
parent bf7d6de556
commit fea37cfb52
83 changed files with 689 additions and 457 deletions
Download patch file Download diff file Expand all files Collapse all files

90
modules/visual_script/doc_classes/VisualScript.xml
View file

@ -15,7 +15,7 @@
<method name="add_custom_signal">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Add a custom signal with the specified name to the VisualScript.
@ -24,7 +24,7 @@
<method name="add_function">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Add a function with the specified name to the VisualScript.
@ -33,7 +33,7 @@
<method name="add_node">
<return type="void">
</return>
<argument index="0" name="func" type="String">
<argument index="0" name="func" type="StringName">
</argument>
<argument index="1" name="id" type="int">
</argument>
@ -48,7 +48,7 @@
<method name="add_variable">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="default_value" type="Variant" default="null">
</argument>
@ -61,7 +61,7 @@
<method name="custom_signal_add_argument">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="type" type="int" enum="Variant.Type">
</argument>
@ -76,7 +76,7 @@
<method name="custom_signal_get_argument_count" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Get the count of a custom signal's arguments.
@ -85,7 +85,7 @@
<method name="custom_signal_get_argument_name" qualifiers="const">
<return type="String">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="argidx" type="int">
</argument>
@ -96,7 +96,7 @@
<method name="custom_signal_get_argument_type" qualifiers="const">
<return type="int" enum="Variant.Type">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="argidx" type="int">
</argument>
@ -107,7 +107,7 @@
<method name="custom_signal_remove_argument">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="argidx" type="int">
</argument>
@ -118,7 +118,7 @@
<method name="custom_signal_set_argument_name">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="argidx" type="int">
</argument>
@ -131,7 +131,7 @@
<method name="custom_signal_set_argument_type">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="argidx" type="int">
</argument>
@ -144,7 +144,7 @@
<method name="custom_signal_swap_argument">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="argidx" type="int">
</argument>
@ -157,7 +157,7 @@
<method name="data_connect">
<return type="void">
</return>
<argument index="0" name="func" type="String">
<argument index="0" name="func" type="StringName">
</argument>
<argument index="1" name="from_node" type="int">
</argument>
@ -174,7 +174,7 @@
<method name="data_disconnect">
<return type="void">
</return>
<argument index="0" name="func" type="String">
<argument index="0" name="func" type="StringName">
</argument>
<argument index="1" name="from_node" type="int">
</argument>
@ -191,7 +191,7 @@
<method name="get_function_node_id" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Returns the id of a function's entry point node.
@ -200,7 +200,7 @@
<method name="get_function_scroll" qualifiers="const">
<return type="Vector2">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Returns the position of the center of the screen for a given function.
@ -209,7 +209,7 @@
<method name="get_node" qualifiers="const">
<return type="VisualScriptNode">
</return>
<argument index="0" name="func" type="String">
<argument index="0" name="func" type="StringName">
</argument>
<argument index="1" name="id" type="int">
</argument>
@ -220,7 +220,7 @@
<method name="get_node_position" qualifiers="const">
<return type="Vector2">
</return>
<argument index="0" name="func" type="String">
<argument index="0" name="func" type="StringName">
</argument>
<argument index="1" name="id" type="int">
</argument>
@ -231,7 +231,7 @@
<method name="get_variable_default_value" qualifiers="const">
<return type="Variant">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Returns the default (initial) value of a variable.
@ -240,7 +240,7 @@
<method name="get_variable_export" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Returns whether a variable is exported.
@ -249,7 +249,7 @@
<method name="get_variable_info" qualifiers="const">
<return type="Dictionary">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Returns the information for a given variable as a dictionary. The information includes its name, type, hint and usage.
@ -258,7 +258,7 @@
<method name="has_custom_signal" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Returns whether a signal exists with the specified name.
@ -267,7 +267,7 @@
<method name="has_data_connection" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="func" type="String">
<argument index="0" name="func" type="StringName">
</argument>
<argument index="1" name="from_node" type="int">
</argument>
@ -284,7 +284,7 @@
<method name="has_function" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Returns whether a function exists with the specified name.
@ -293,7 +293,7 @@
<method name="has_node" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="func" type="String">
<argument index="0" name="func" type="StringName">
</argument>
<argument index="1" name="id" type="int">
</argument>
@ -304,7 +304,7 @@
<method name="has_sequence_connection" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="func" type="String">
<argument index="0" name="func" type="StringName">
</argument>
<argument index="1" name="from_node" type="int">
</argument>
@ -319,7 +319,7 @@
<method name="has_variable" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Returns whether a variable exists with the specified name.
@ -328,7 +328,7 @@
<method name="remove_custom_signal">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Remove a custom signal with the given name.
@ -337,7 +337,7 @@
<method name="remove_function">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Remove a specific function and its nodes from the script.
@ -346,7 +346,7 @@
<method name="remove_node">
<return type="void">
</return>
<argument index="0" name="func" type="String">
<argument index="0" name="func" type="StringName">
</argument>
<argument index="1" name="id" type="int">
</argument>
@ -357,7 +357,7 @@
<method name="remove_variable">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Remove a variable with the given name.
@ -366,9 +366,9 @@
<method name="rename_custom_signal">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="new_name" type="String">
<argument index="1" name="new_name" type="StringName">
</argument>
<description>
Change the name of a custom signal.
@ -377,9 +377,9 @@
<method name="rename_function">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="new_name" type="String">
<argument index="1" name="new_name" type="StringName">
</argument>
<description>
Change the name of a function.
@ -388,9 +388,9 @@
<method name="rename_variable">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="new_name" type="String">
<argument index="1" name="new_name" type="StringName">
</argument>
<description>
Change the name of a variable.
@ -399,7 +399,7 @@
<method name="sequence_connect">
<return type="void">
</return>
<argument index="0" name="func" type="String">
<argument index="0" name="func" type="StringName">
</argument>
<argument index="1" name="from_node" type="int">
</argument>
@ -415,7 +415,7 @@
<method name="sequence_disconnect">
<return type="void">
</return>
<argument index="0" name="func" type="String">
<argument index="0" name="func" type="StringName">
</argument>
<argument index="1" name="from_node" type="int">
</argument>
@ -430,7 +430,7 @@
<method name="set_function_scroll">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="ofs" type="Vector2">
</argument>
@ -441,7 +441,7 @@
<method name="set_instance_base_type">
<return type="void">
</return>
<argument index="0" name="type" type="String">
<argument index="0" name="type" type="StringName">
</argument>
<description>
Set the base type of the script.
@ -450,7 +450,7 @@
<method name="set_node_position">
<return type="void">
</return>
<argument index="0" name="func" type="String">
<argument index="0" name="func" type="StringName">
</argument>
<argument index="1" name="id" type="int">
</argument>
@ -463,7 +463,7 @@
<method name="set_variable_default_value">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="value" type="Variant">
</argument>
@ -474,7 +474,7 @@
<method name="set_variable_export">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="enable" type="bool">
</argument>
@ -485,7 +485,7 @@
<method name="set_variable_info">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="value" type="Dictionary">
</argument>

2
modules/visual_script/doc_classes/VisualScriptBasicTypeConstant.xml
View file

@ -14,7 +14,7 @@
<member name="basic_type" type="int" setter="set_basic_type" getter="get_basic_type" enum="Variant.Type" default="0">
The type to get the constant from.
</member>
<member name="constant" type="String" setter="set_basic_type_constant" getter="get_basic_type_constant">
<member name="constant" type="StringName" setter="set_basic_type_constant" getter="get_basic_type_constant">
The name of the constant to return.
</member>
</members>

4
modules/visual_script/doc_classes/VisualScriptClassConstant.xml
View file

@ -15,10 +15,10 @@
<methods>
</methods>
<members>
<member name="base_type" type="String" setter="set_base_type" getter="get_base_type" default="&quot;Object&quot;">
<member name="base_type" type="StringName" setter="set_base_type" getter="get_base_type" default="@&quot;Object&quot;">
The constant's parent class.
</member>
<member name="constant" type="String" setter="set_class_constant" getter="get_class_constant" default="&quot;&quot;">
<member name="constant" type="StringName" setter="set_class_constant" getter="get_class_constant" default="@&quot;&quot;">
The constant to return. See the given class for its available constants.
</member>
</members>

2
modules/visual_script/doc_classes/VisualScriptEmitSignal.xml
View file

@ -15,7 +15,7 @@
<methods>
</methods>
<members>
<member name="signal" type="String" setter="set_signal" getter="get_signal" default="&quot;&quot;">
<member name="signal" type="StringName" setter="set_signal" getter="get_signal" default="@&quot;&quot;">
The signal to emit.
</member>
</members>

6
modules/visual_script/doc_classes/VisualScriptFunctionCall.xml
View file

@ -11,19 +11,19 @@
<members>
<member name="base_script" type="String" setter="set_base_script" getter="get_base_script">
</member>
<member name="base_type" type="String" setter="set_base_type" getter="get_base_type" default="&quot;Object&quot;">
<member name="base_type" type="StringName" setter="set_base_type" getter="get_base_type" default="@&quot;Object&quot;">
</member>
<member name="basic_type" type="int" setter="set_basic_type" getter="get_basic_type" enum="Variant.Type">
</member>
<member name="call_mode" type="int" setter="set_call_mode" getter="get_call_mode" enum="VisualScriptFunctionCall.CallMode" default="0">
</member>
<member name="function" type="String" setter="set_function" getter="get_function" default="&quot;&quot;">
<member name="function" type="StringName" setter="set_function" getter="get_function" default="@&quot;&quot;">
</member>
<member name="node_path" type="NodePath" setter="set_base_path" getter="get_base_path">
</member>
<member name="rpc_call_mode" type="int" setter="set_rpc_call_mode" getter="get_rpc_call_mode" enum="VisualScriptFunctionCall.RPCCallMode" default="0">
</member>
<member name="singleton" type="String" setter="set_singleton" getter="get_singleton">
<member name="singleton" type="StringName" setter="set_singleton" getter="get_singleton">
</member>
<member name="use_default_args" type="int" setter="set_use_default_args" getter="get_use_default_args">
</member>

2
modules/visual_script/doc_classes/VisualScriptInputAction.xml
View file

@ -9,7 +9,7 @@
<methods>
</methods>
<members>
<member name="action" type="String" setter="set_action_name" getter="get_action_name" default="&quot;&quot;">
<member name="action" type="StringName" setter="set_action_name" getter="get_action_name" default="@&quot;&quot;">
</member>
<member name="mode" type="int" setter="set_action_mode" getter="get_action_mode" enum="VisualScriptInputAction.Mode" default="0">
</member>

2
modules/visual_script/doc_classes/VisualScriptLocalVar.xml
View file

@ -18,7 +18,7 @@
<member name="type" type="int" setter="set_var_type" getter="get_var_type" enum="Variant.Type" default="0">
The local variable's type.
</member>
<member name="var_name" type="String" setter="set_var_name" getter="get_var_name" default="&quot;new_local&quot;">
<member name="var_name" type="StringName" setter="set_var_name" getter="get_var_name" default="@&quot;new_local&quot;">
The local variable's name.
</member>
</members>

2
modules/visual_script/doc_classes/VisualScriptLocalVarSet.xml
View file

@ -20,7 +20,7 @@
<member name="type" type="int" setter="set_var_type" getter="get_var_type" enum="Variant.Type" default="0">
The local variable's type.
</member>
<member name="var_name" type="String" setter="set_var_name" getter="get_var_name" default="&quot;new_local&quot;">
<member name="var_name" type="StringName" setter="set_var_name" getter="get_var_name" default="@&quot;new_local&quot;">
The local variable's name.
</member>
</members>

6
modules/visual_script/doc_classes/VisualScriptPropertyGet.xml
View file

@ -11,15 +11,15 @@
<members>
<member name="base_script" type="String" setter="set_base_script" getter="get_base_script">
</member>
<member name="base_type" type="String" setter="set_base_type" getter="get_base_type" default="&quot;Object&quot;">
<member name="base_type" type="StringName" setter="set_base_type" getter="get_base_type" default="@&quot;Object&quot;">
</member>
<member name="basic_type" type="int" setter="set_basic_type" getter="get_basic_type" enum="Variant.Type">
</member>
<member name="index" type="String" setter="set_index" getter="get_index">
<member name="index" type="StringName" setter="set_index" getter="get_index">
</member>
<member name="node_path" type="NodePath" setter="set_base_path" getter="get_base_path">
</member>
<member name="property" type="String" setter="set_property" getter="get_property" default="&quot;&quot;">
<member name="property" type="StringName" setter="set_property" getter="get_property" default="@&quot;&quot;">
</member>
<member name="set_mode" type="int" setter="set_call_mode" getter="get_call_mode" enum="VisualScriptPropertyGet.CallMode" default="0">
</member>

6
modules/visual_script/doc_classes/VisualScriptPropertySet.xml
View file

@ -13,15 +13,15 @@
</member>
<member name="base_script" type="String" setter="set_base_script" getter="get_base_script">
</member>
<member name="base_type" type="String" setter="set_base_type" getter="get_base_type" default="&quot;Object&quot;">
<member name="base_type" type="StringName" setter="set_base_type" getter="get_base_type" default="@&quot;Object&quot;">
</member>
<member name="basic_type" type="int" setter="set_basic_type" getter="get_basic_type" enum="Variant.Type">
</member>
<member name="index" type="String" setter="set_index" getter="get_index">
<member name="index" type="StringName" setter="set_index" getter="get_index">
</member>
<member name="node_path" type="NodePath" setter="set_base_path" getter="get_base_path">
</member>
<member name="property" type="String" setter="set_property" getter="get_property" default="&quot;&quot;">
<member name="property" type="StringName" setter="set_property" getter="get_property" default="@&quot;&quot;">
</member>
<member name="set_mode" type="int" setter="set_call_mode" getter="get_call_mode" enum="VisualScriptPropertySet.CallMode" default="0">
</member>

2
modules/visual_script/doc_classes/VisualScriptTypeCast.xml
View file

@ -11,7 +11,7 @@
<members>
<member name="base_script" type="String" setter="set_base_script" getter="get_base_script" default="&quot;&quot;">
</member>
<member name="base_type" type="String" setter="set_base_type" getter="get_base_type" default="&quot;Object&quot;">
<member name="base_type" type="StringName" setter="set_base_type" getter="get_base_type" default="@&quot;Object&quot;">
</member>
</members>
<constants>

2
modules/visual_script/doc_classes/VisualScriptVariableGet.xml
View file

@ -15,7 +15,7 @@
<methods>
</methods>
<members>
<member name="var_name" type="String" setter="set_variable" getter="get_variable" default="&quot;&quot;">
<member name="var_name" type="StringName" setter="set_variable" getter="get_variable" default="@&quot;&quot;">
The variable's name.
</member>
</members>

2
modules/visual_script/doc_classes/VisualScriptVariableSet.xml
View file

@ -16,7 +16,7 @@
<methods>
</methods>
<members>
<member name="var_name" type="String" setter="set_variable" getter="get_variable" default="&quot;&quot;">
<member name="var_name" type="StringName" setter="set_variable" getter="get_variable" default="@&quot;&quot;">
The variable's name.
</member>
</members>

4
modules/visual_script/doc_classes/VisualScriptYieldSignal.xml
View file

@ -9,13 +9,13 @@
<methods>
</methods>
<members>
<member name="base_type" type="String" setter="set_base_type" getter="get_base_type" default="&quot;Object&quot;">
<member name="base_type" type="StringName" setter="set_base_type" getter="get_base_type" default="@&quot;Object&quot;">
</member>
<member name="call_mode" type="int" setter="set_call_mode" getter="get_call_mode" enum="VisualScriptYieldSignal.CallMode" default="0">
</member>
<member name="node_path" type="NodePath" setter="set_base_path" getter="get_base_path">
</member>
<member name="signal" type="String" setter="set_signal" getter="get_signal" default="&quot;&quot;">
<member name="signal" type="StringName" setter="set_signal" getter="get_signal" default="@&quot;&quot;">
</member>
</members>
<constants>