godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-11-14 13:41:12 +00:00
Code Releases Wiki Activity

doc: Add default values to all properties

Browse Source 
Thanks to @bojidar-bg's impressive work in #29380.
This commit is contained in:
Rémi Verschelde
2019-06-29 12:38:01 +02:00
parent 82604195b4
commit c6cea6e9b3
394 changed files with 2881 additions and 2719 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
modules/visual_script/doc_classes/VisualScriptBasicTypeConstant.xml
View File

@@ -11,10 +11,10 @@
<methods>
</methods>
<members>
<member name="basic_type" type="int" setter="set_basic_type" getter="get_basic_type" enum="Variant.Type">
<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="String" setter="set_basic_type_constant" getter="get_basic_type_constant" default="null">
The name of the constant to return.
</member>
</members>

2
modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml
View File

@@ -12,7 +12,7 @@
<methods>
</methods>
<members>
<member name="function" type="int" setter="set_func" getter="get_func" enum="VisualScriptBuiltinFunc.BuiltinFunc">
<member name="function" type="int" setter="set_func" getter="get_func" enum="VisualScriptBuiltinFunc.BuiltinFunc" default="0">
The function to be executed.
</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">
<member name="base_type" type="String" 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">
<member name="constant" type="String" 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>

6
modules/visual_script/doc_classes/VisualScriptComment.xml
View File

@@ -12,13 +12,13 @@
<methods>
</methods>
<members>
<member name="description" type="String" setter="set_description" getter="get_description">
<member name="description" type="String" setter="set_description" getter="get_description" default="&quot;&quot;">
The text inside the comment node.
</member>
<member name="size" type="Vector2" setter="set_size" getter="get_size">
<member name="size" type="Vector2" setter="set_size" getter="get_size" default="Vector2( 150, 150 )">
The comment node's size (in pixels).
</member>
<member name="title" type="String" setter="set_title" getter="get_title">
<member name="title" type="String" setter="set_title" getter="get_title" default="&quot;Comment&quot;">
The comment node's title.
</member>
</members>

4
modules/visual_script/doc_classes/VisualScriptConstant.xml
View File

@@ -15,10 +15,10 @@
<methods>
</methods>
<members>
<member name="type" type="int" setter="set_constant_type" getter="get_constant_type" enum="Variant.Type">
<member name="type" type="int" setter="set_constant_type" getter="get_constant_type" enum="Variant.Type" default="0">
The constant's type.
</member>
<member name="value" type="Variant" setter="set_constant_value" getter="get_constant_value">
<member name="value" type="Variant" setter="set_constant_value" getter="get_constant_value" default="null">
The constant's value.
</member>
</members>

2
modules/visual_script/doc_classes/VisualScriptDeconstruct.xml
View File

@@ -11,7 +11,7 @@
<methods>
</methods>
<members>
<member name="type" type="int" setter="set_deconstruct_type" getter="get_deconstruct_type" enum="Variant.Type">
<member name="type" type="int" setter="set_deconstruct_type" getter="get_deconstruct_type" enum="Variant.Type" default="0">
The type to deconstruct.
</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">
<member name="signal" type="String" setter="set_signal" getter="get_signal" default="&quot;&quot;">
The signal to emit.
</member>
</members>

2
modules/visual_script/doc_classes/VisualScriptEngineSingleton.xml
View File

@@ -11,7 +11,7 @@
<methods>
</methods>
<members>
<member name="constant" type="String" setter="set_singleton" getter="get_singleton">
<member name="constant" type="String" setter="set_singleton" getter="get_singleton" default="&quot;&quot;">
The singleton's name.
</member>
</members>

20
modules/visual_script/doc_classes/VisualScriptFunctionCall.xml
View File

@@ -9,25 +9,25 @@
<methods>
</methods>
<members>
<member name="base_script" type="String" setter="set_base_script" getter="get_base_script">
<member name="base_script" type="String" setter="set_base_script" getter="get_base_script" default="null">
</member>
<member name="base_type" type="String" setter="set_base_type" getter="get_base_type">
<member name="base_type" type="String" 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 name="basic_type" type="int" setter="set_basic_type" getter="get_basic_type" enum="Variant.Type" default="null">
</member>
<member name="call_mode" type="int" setter="set_call_mode" getter="get_call_mode" enum="VisualScriptFunctionCall.CallMode">
<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">
<member name="function" type="String" 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 name="node_path" type="NodePath" setter="set_base_path" getter="get_base_path" default="null">
</member>
<member name="rpc_call_mode" type="int" setter="set_rpc_call_mode" getter="get_rpc_call_mode" enum="VisualScriptFunctionCall.RPCCallMode">
<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="String" setter="set_singleton" getter="get_singleton" default="null">
</member>
<member name="use_default_args" type="int" setter="set_use_default_args" getter="get_use_default_args">
<member name="use_default_args" type="int" setter="set_use_default_args" getter="get_use_default_args" default="null">
</member>
<member name="validate" type="bool" setter="set_validate" getter="get_validate">
<member name="validate" type="bool" setter="set_validate" getter="get_validate" default="true">
</member>
</members>
<constants>

2
modules/visual_script/doc_classes/VisualScriptGlobalConstant.xml
View File

@@ -9,7 +9,7 @@
<methods>
</methods>
<members>
<member name="constant" type="int" setter="set_global_constant" getter="get_global_constant">
<member name="constant" type="int" setter="set_global_constant" getter="get_global_constant" default="0">
</member>
</members>
<constants>

4
modules/visual_script/doc_classes/VisualScriptInputAction.xml
View File

@@ -9,9 +9,9 @@
<methods>
</methods>
<members>
<member name="action" type="String" setter="set_action_name" getter="get_action_name">
<member name="action" type="String" 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">
<member name="mode" type="int" setter="set_action_mode" getter="get_action_mode" enum="VisualScriptInputAction.Mode" default="0">
</member>
</members>
<constants>

4
modules/visual_script/doc_classes/VisualScriptLocalVar.xml
View File

@@ -15,10 +15,10 @@
<methods>
</methods>
<members>
<member name="type" type="int" setter="set_var_type" getter="get_var_type" enum="Variant.Type">
<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">
<member name="var_name" type="String" setter="set_var_name" getter="get_var_name" default="&quot;new_local&quot;">
The local variable's name.
</member>
</members>

4
modules/visual_script/doc_classes/VisualScriptLocalVarSet.xml
View File

@@ -17,10 +17,10 @@
<methods>
</methods>
<members>
<member name="type" type="int" setter="set_var_type" getter="get_var_type" enum="Variant.Type">
<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">
<member name="var_name" type="String" 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/VisualScriptMathConstant.xml
View File

@@ -15,7 +15,7 @@
<methods>
</methods>
<members>
<member name="constant" type="int" setter="set_math_constant" getter="get_math_constant" enum="VisualScriptMathConstant.MathConstant">
<member name="constant" type="int" setter="set_math_constant" getter="get_math_constant" enum="VisualScriptMathConstant.MathConstant" default="0">
The math constant.
</member>
</members>

4
modules/visual_script/doc_classes/VisualScriptOperator.xml
View File

@@ -14,9 +14,9 @@
<methods>
</methods>
<members>
<member name="operator" type="int" setter="set_operator" getter="get_operator" enum="Variant.Operator">
<member name="operator" type="int" setter="set_operator" getter="get_operator" enum="Variant.Operator" default="6">
</member>
<member name="type" type="int" setter="set_typed" getter="get_typed" enum="Variant.Type">
<member name="type" type="int" setter="set_typed" getter="get_typed" enum="Variant.Type" default="0">
</member>
</members>
<constants>

2
modules/visual_script/doc_classes/VisualScriptPreload.xml
View File

@@ -15,7 +15,7 @@
<methods>
</methods>
<members>
<member name="resource" type="Resource" setter="set_preload" getter="get_preload">
<member name="resource" type="Resource" setter="set_preload" getter="get_preload" default="null">
The [Resource] to load.
</member>
</members>

14
modules/visual_script/doc_classes/VisualScriptPropertyGet.xml
View File

@@ -9,19 +9,19 @@
<methods>
</methods>
<members>
<member name="base_script" type="String" setter="set_base_script" getter="get_base_script">
<member name="base_script" type="String" setter="set_base_script" getter="get_base_script" default="null">
</member>
<member name="base_type" type="String" setter="set_base_type" getter="get_base_type">
<member name="base_type" type="String" 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 name="basic_type" type="int" setter="set_basic_type" getter="get_basic_type" enum="Variant.Type" default="null">
</member>
<member name="index" type="String" setter="set_index" getter="get_index">
<member name="index" type="String" setter="set_index" getter="get_index" default="null">
</member>
<member name="node_path" type="NodePath" setter="set_base_path" getter="get_base_path">
<member name="node_path" type="NodePath" setter="set_base_path" getter="get_base_path" default="null">
</member>
<member name="property" type="String" setter="set_property" getter="get_property">
<member name="property" type="String" 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">
<member name="set_mode" type="int" setter="set_call_mode" getter="get_call_mode" enum="VisualScriptPropertyGet.CallMode" default="0">
</member>
</members>
<constants>

16
modules/visual_script/doc_classes/VisualScriptPropertySet.xml
View File

@@ -9,21 +9,21 @@
<methods>
</methods>
<members>
<member name="assign_op" type="int" setter="set_assign_op" getter="get_assign_op" enum="VisualScriptPropertySet.AssignOp">
<member name="assign_op" type="int" setter="set_assign_op" getter="get_assign_op" enum="VisualScriptPropertySet.AssignOp" default="0">
</member>
<member name="base_script" type="String" setter="set_base_script" getter="get_base_script">
<member name="base_script" type="String" setter="set_base_script" getter="get_base_script" default="null">
</member>
<member name="base_type" type="String" setter="set_base_type" getter="get_base_type">
<member name="base_type" type="String" 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 name="basic_type" type="int" setter="set_basic_type" getter="get_basic_type" enum="Variant.Type" default="null">
</member>
<member name="index" type="String" setter="set_index" getter="get_index">
<member name="index" type="String" setter="set_index" getter="get_index" default="null">
</member>
<member name="node_path" type="NodePath" setter="set_base_path" getter="get_base_path">
<member name="node_path" type="NodePath" setter="set_base_path" getter="get_base_path" default="null">
</member>
<member name="property" type="String" setter="set_property" getter="get_property">
<member name="property" type="String" 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">
<member name="set_mode" type="int" setter="set_call_mode" getter="get_call_mode" enum="VisualScriptPropertySet.CallMode" default="0">
</member>
</members>
<constants>

2
modules/visual_script/doc_classes/VisualScriptResourcePath.xml
View File

@@ -9,7 +9,7 @@
<methods>
</methods>
<members>
<member name="path" type="String" setter="set_resource_path" getter="get_resource_path">
<member name="path" type="String" setter="set_resource_path" getter="get_resource_path" default="&quot;&quot;">
</member>
</members>
<constants>

4
modules/visual_script/doc_classes/VisualScriptReturn.xml
View File

@@ -16,10 +16,10 @@
<methods>
</methods>
<members>
<member name="return_enabled" type="bool" setter="set_enable_return_value" getter="is_return_value_enabled">
<member name="return_enabled" type="bool" setter="set_enable_return_value" getter="is_return_value_enabled" default="false">
If [code]true[/code], the [code]return[/code] input port is available.
</member>
<member name="return_type" type="int" setter="set_return_type" getter="get_return_type" enum="Variant.Type">
<member name="return_type" type="int" setter="set_return_type" getter="get_return_type" enum="Variant.Type" default="0">
The return value's data type.
</member>
</members>

2
modules/visual_script/doc_classes/VisualScriptSceneNode.xml
View File

@@ -15,7 +15,7 @@
<methods>
</methods>
<members>
<member name="node_path" type="NodePath" setter="set_node_path" getter="get_node_path">
<member name="node_path" type="NodePath" setter="set_node_path" getter="get_node_path" default="NodePath(&quot;.&quot;)">
The node's path in the scene tree.
</member>
</members>

2
modules/visual_script/doc_classes/VisualScriptSelect.xml
View File

@@ -17,7 +17,7 @@
<methods>
</methods>
<members>
<member name="type" type="int" setter="set_typed" getter="get_typed" enum="Variant.Type">
<member name="type" type="int" setter="set_typed" getter="get_typed" enum="Variant.Type" default="0">
The input variables' type.
</member>
</members>

2
modules/visual_script/doc_classes/VisualScriptSequence.xml
View File

@@ -17,7 +17,7 @@
<methods>
</methods>
<members>
<member name="steps" type="int" setter="set_steps" getter="get_steps">
<member name="steps" type="int" setter="set_steps" getter="get_steps" default="1">
The number of steps in the sequence.
</member>
</members>

4
modules/visual_script/doc_classes/VisualScriptTypeCast.xml
View File

@@ -9,9 +9,9 @@
<methods>
</methods>
<members>
<member name="base_script" type="String" setter="set_base_script" getter="get_base_script">
<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">
<member name="base_type" type="String" 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">
<member name="var_name" type="String" 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">
<member name="var_name" type="String" setter="set_variable" getter="get_variable" default="&quot;&quot;">
The variable's name.
</member>
</members>

4
modules/visual_script/doc_classes/VisualScriptYield.xml
View File

@@ -9,9 +9,9 @@
<methods>
</methods>
<members>
<member name="mode" type="int" setter="set_yield_mode" getter="get_yield_mode" enum="VisualScriptYield.YieldMode">
<member name="mode" type="int" setter="set_yield_mode" getter="get_yield_mode" enum="VisualScriptYield.YieldMode" default="1">
</member>
<member name="wait_time" type="float" setter="set_wait_time" getter="get_wait_time">
<member name="wait_time" type="float" setter="set_wait_time" getter="get_wait_time" default="null">
</member>
</members>
<constants>

8
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">
<member name="base_type" type="String" 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">
<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 name="node_path" type="NodePath" setter="set_base_path" getter="get_base_path" default="null">
</member>
<member name="signal" type="String" setter="set_signal" getter="get_signal">
<member name="signal" type="String" setter="set_signal" getter="get_signal" default="&quot;&quot;">
</member>
</members>
<constants>