godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/modules/visual_script/doc_classes/VisualScriptPropertyGet.xml

51 lines
2.5 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Update docs to version 4.0
2020-02-01 01:03:48 +00:00
<class name="VisualScriptPropertyGet" inherits="VisualScriptNode" version="4.0">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<brief_description>
Document remaining Visual Script classes
2020-10-12 17:37:50 +00:00
A Visual Script node returning a value of a property from an [Object].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</brief_description>
<description>
Document remaining Visual Script classes
2020-10-12 17:37:50 +00:00
[VisualScriptPropertyGet] can return a value of any property from the current object or other objects.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
doc: Remove null default values that can't be determined Applying #30187.
2019-06-29 19:22:15 +00:00
<member name="base_script" type="String" setter="set_base_script" getter="get_base_script">
Document remaining Visual Script classes
2020-10-12 17:37:50 +00:00
The script to be used when [member set_mode] is set to [constant CALL_MODE_INSTANCE].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
Let var2str display StringName with correct sigil
2021-06-05 19:24:24 +00:00
<member name="base_type" type="StringName" setter="set_base_type" getter="get_base_type" default="&amp;&quot;Object&quot;">
Document remaining Visual Script classes
2020-10-12 17:37:50 +00:00
The base type to be used when [member set_mode] is set to [constant CALL_MODE_INSTANCE].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Remove null default values that can't be determined Applying #30187.
2019-06-29 19:22:15 +00:00
<member name="basic_type" type="int" setter="set_basic_type" getter="get_basic_type" enum="Variant.Type">
Document remaining Visual Script classes
2020-10-12 17:37:50 +00:00
The type to be used when [member set_mode] is set to [constant CALL_MODE_BASIC_TYPE].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
<member name="index" type="StringName" setter="set_index" getter="get_index">
Document remaining Visual Script classes
2020-10-12 17:37:50 +00:00
The indexed name of the property to retrieve. See [method Object.get_indexed] for details.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Remove null default values that can't be determined Applying #30187.
2019-06-29 19:22:15 +00:00
<member name="node_path" type="NodePath" setter="set_base_path" getter="get_base_path">
Document remaining Visual Script classes
2020-10-12 17:37:50 +00:00
The node path to use when [member set_mode] is set to [constant CALL_MODE_NODE_PATH].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
Let var2str display StringName with correct sigil
2021-06-05 19:24:24 +00:00
<member name="property" type="StringName" setter="set_property" getter="get_property" default="&amp;&quot;&quot;">
Document remaining Visual Script classes
2020-10-12 17:37:50 +00:00
The name of the property to retrieve. Changing this will clear [member index].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="set_mode" type="int" setter="set_call_mode" getter="get_call_mode" enum="VisualScriptPropertyGet.CallMode" default="0">
Document remaining Visual Script classes
2020-10-12 17:37:50 +00:00
[code]set_mode[/code] determines the target object from which the property will be retrieved. See [enum CallMode] for options.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
</members>
<constants>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="CALL_MODE_SELF" value="0" enum="CallMode">
Document remaining Visual Script classes
2020-10-12 17:37:50 +00:00
The property will be retrieved from this [Object].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="CALL_MODE_NODE_PATH" value="1" enum="CallMode">
Document remaining Visual Script classes
2020-10-12 17:37:50 +00:00
The property will be retrieved from the given [Node] in the scene tree.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="CALL_MODE_INSTANCE" value="2" enum="CallMode">
Document remaining Visual Script classes
2020-10-12 17:37:50 +00:00
The property will be retrieved from an instanced node with the given type and script.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Sync classref with current source + fixup some bindings Includes various changes triggered by the refactoring of method bindings.
2020-11-04 14:38:26 +00:00
<constant name="CALL_MODE_BASIC_TYPE" value="3" enum="CallMode">
Document remaining Visual Script classes
2020-10-12 17:37:50 +00:00
The property will be retrieved from a GDScript basic type (e.g. [Vector2]).
doc: Sync classref with current source + fixup some bindings Includes various changes triggered by the refactoring of method bindings.
2020-11-04 14:38:26 +00:00
</constant>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constants>
</class>