mirror of
https://github.com/Relintai/pandemonium_engine_docs.git
synced 2025-01-23 15:17:21 +01:00
172 lines
7.5 KiB
ReStructuredText
172 lines
7.5 KiB
ReStructuredText
|
:github_url: hide
|
||
|
|
|
||
|
|
.. DO NOT EDIT THIS FILE!!!
|
||
|
|
.. Generated automatically from Godot engine sources.
|
||
|
|
.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py.
|
||
|
|
.. XML source: https://github.com/godotengine/godot/tree/3.5/modules/visual_script/doc_classes/VisualScriptPropertyGet.xml.
|
||
|
|
|
||
|
|
.. _class_VisualScriptPropertyGet:
|
||
|
|
|
||
|
|
VisualScriptPropertyGet
|
||
|
|
=======================
|
||
|
|
|
||
|
|
**Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
||
|
|
|
||
|
|
A Visual Script node returning a value of a property from an :ref:`Object<class_Object>`.
|
||
|
|
|
||
|
|
Description
|
||
|
|
-----------
|
||
|
|
|
||
|
|
``VisualScriptPropertyGet`` can return a value of any property from the current object or other objects.
|
||
|
|
|
||
|
|
Properties
|
||
|
|
----------
|
||
|
|
|
||
|
|
+--------------------------------------------------------+------------------------------------------------------------------------+--------------+
|
||
|
|
| :ref:`String<class_String>` | :ref:`base_script<class_VisualScriptPropertyGet_property_base_script>` | |
|
||
|
|
+--------------------------------------------------------+------------------------------------------------------------------------+--------------+
|
||
|
|
| :ref:`String<class_String>` | :ref:`base_type<class_VisualScriptPropertyGet_property_base_type>` | ``"Object"`` |
|
||
|
|
+--------------------------------------------------------+------------------------------------------------------------------------+--------------+
|
||
|
|
| :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` | :ref:`basic_type<class_VisualScriptPropertyGet_property_basic_type>` | |
|
||
|
|
+--------------------------------------------------------+------------------------------------------------------------------------+--------------+
|
||
|
|
| :ref:`String<class_String>` | :ref:`index<class_VisualScriptPropertyGet_property_index>` | |
|
||
|
|
+--------------------------------------------------------+------------------------------------------------------------------------+--------------+
|
||
|
|
| :ref:`NodePath<class_NodePath>` | :ref:`node_path<class_VisualScriptPropertyGet_property_node_path>` | |
|
||
|
|
+--------------------------------------------------------+------------------------------------------------------------------------+--------------+
|
||
|
|
| :ref:`String<class_String>` | :ref:`property<class_VisualScriptPropertyGet_property_property>` | ``""`` |
|
||
|
|
+--------------------------------------------------------+------------------------------------------------------------------------+--------------+
|
||
|
|
| :ref:`CallMode<enum_VisualScriptPropertyGet_CallMode>` | :ref:`set_mode<class_VisualScriptPropertyGet_property_set_mode>` | ``0`` |
|
||
|
|
+--------------------------------------------------------+------------------------------------------------------------------------+--------------+
|
||
|
|
|
||
|
|
Enumerations
|
||
|
|
------------
|
||
|
|
|
||
|
|
.. _enum_VisualScriptPropertyGet_CallMode:
|
||
|
|
|
||
|
|
.. _class_VisualScriptPropertyGet_constant_CALL_MODE_SELF:
|
||
|
|
|
||
|
|
.. _class_VisualScriptPropertyGet_constant_CALL_MODE_NODE_PATH:
|
||
|
|
|
||
|
|
.. _class_VisualScriptPropertyGet_constant_CALL_MODE_INSTANCE:
|
||
|
|
|
||
|
|
.. _class_VisualScriptPropertyGet_constant_CALL_MODE_BASIC_TYPE:
|
||
|
|
|
||
|
|
enum **CallMode**:
|
||
|
|
|
||
|
|
- **CALL_MODE_SELF** = **0** --- The property will be retrieved from this :ref:`Object<class_Object>`.
|
||
|
|
|
||
|
|
- **CALL_MODE_NODE_PATH** = **1** --- The property will be retrieved from the given :ref:`Node<class_Node>` in the scene tree.
|
||
|
|
|
||
|
|
- **CALL_MODE_INSTANCE** = **2** --- The property will be retrieved from an instanced node with the given type and script.
|
||
|
|
|
||
|
|
- **CALL_MODE_BASIC_TYPE** = **3** --- The property will be retrieved from a GDScript basic type (e.g. :ref:`Vector2<class_Vector2>`).
|
||
|
|
|
||
|
|
Property Descriptions
|
||
|
|
---------------------
|
||
|
|
|
||
|
|
.. _class_VisualScriptPropertyGet_property_base_script:
|
||
|
|
|
||
|
|
- :ref:`String<class_String>` **base_script**
|
||
|
|
|
||
|
|
+----------+------------------------+
|
||
|
|
| *Setter* | set_base_script(value) |
|
||
|
|
+----------+------------------------+
|
||
|
|
| *Getter* | get_base_script() |
|
||
|
|
+----------+------------------------+
|
||
|
|
|
||
|
|
The script to be used when :ref:`set_mode<class_VisualScriptPropertyGet_property_set_mode>` is set to :ref:`CALL_MODE_INSTANCE<class_VisualScriptPropertyGet_constant_CALL_MODE_INSTANCE>`.
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. _class_VisualScriptPropertyGet_property_base_type:
|
||
|
|
|
||
|
|
- :ref:`String<class_String>` **base_type**
|
||
|
|
|
||
|
|
+-----------+----------------------+
|
||
|
|
| *Default* | ``"Object"`` |
|
||
|
|
+-----------+----------------------+
|
||
|
|
| *Setter* | set_base_type(value) |
|
||
|
|
+-----------+----------------------+
|
||
|
|
| *Getter* | get_base_type() |
|
||
|
|
+-----------+----------------------+
|
||
|
|
|
||
|
|
The base type to be used when :ref:`set_mode<class_VisualScriptPropertyGet_property_set_mode>` is set to :ref:`CALL_MODE_INSTANCE<class_VisualScriptPropertyGet_constant_CALL_MODE_INSTANCE>`.
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. _class_VisualScriptPropertyGet_property_basic_type:
|
||
|
|
|
||
|
|
- :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **basic_type**
|
||
|
|
|
||
|
|
+----------+-----------------------+
|
||
|
|
| *Setter* | set_basic_type(value) |
|
||
|
|
+----------+-----------------------+
|
||
|
|
| *Getter* | get_basic_type() |
|
||
|
|
+----------+-----------------------+
|
||
|
|
|
||
|
|
The type to be used when :ref:`set_mode<class_VisualScriptPropertyGet_property_set_mode>` is set to :ref:`CALL_MODE_BASIC_TYPE<class_VisualScriptPropertyGet_constant_CALL_MODE_BASIC_TYPE>`.
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. _class_VisualScriptPropertyGet_property_index:
|
||
|
|
|
||
|
|
- :ref:`String<class_String>` **index**
|
||
|
|
|
||
|
|
+----------+------------------+
|
||
|
|
| *Setter* | set_index(value) |
|
||
|
|
+----------+------------------+
|
||
|
|
| *Getter* | get_index() |
|
||
|
|
+----------+------------------+
|
||
|
|
|
||
|
|
The indexed name of the property to retrieve. See :ref:`Object.get_indexed<class_Object_method_get_indexed>` for details.
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. _class_VisualScriptPropertyGet_property_node_path:
|
||
|
|
|
||
|
|
- :ref:`NodePath<class_NodePath>` **node_path**
|
||
|
|
|
||
|
|
+----------+----------------------+
|
||
|
|
| *Setter* | set_base_path(value) |
|
||
|
|
+----------+----------------------+
|
||
|
|
| *Getter* | get_base_path() |
|
||
|
|
+----------+----------------------+
|
||
|
|
|
||
|
|
The node path to use when :ref:`set_mode<class_VisualScriptPropertyGet_property_set_mode>` is set to :ref:`CALL_MODE_NODE_PATH<class_VisualScriptPropertyGet_constant_CALL_MODE_NODE_PATH>`.
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. _class_VisualScriptPropertyGet_property_property:
|
||
|
|
|
||
|
|
- :ref:`String<class_String>` **property**
|
||
|
|
|
||
|
|
+-----------+---------------------+
|
||
|
|
| *Default* | ``""`` |
|
||
|
|
+-----------+---------------------+
|
||
|
|
| *Setter* | set_property(value) |
|
||
|
|
+-----------+---------------------+
|
||
|
|
| *Getter* | get_property() |
|
||
|
|
+-----------+---------------------+
|
||
|
|
|
||
|
|
The name of the property to retrieve. Changing this will clear :ref:`index<class_VisualScriptPropertyGet_property_index>`.
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. _class_VisualScriptPropertyGet_property_set_mode:
|
||
|
|
|
||
|
|
- :ref:`CallMode<enum_VisualScriptPropertyGet_CallMode>` **set_mode**
|
||
|
|
|
||
|
|
+-----------+----------------------+
|
||
|
|
| *Default* | ``0`` |
|
||
|
|
+-----------+----------------------+
|
||
|
|
| *Setter* | set_call_mode(value) |
|
||
|
|
+-----------+----------------------+
|
||
|
|
| *Getter* | get_call_mode() |
|
||
|
|
+-----------+----------------------+
|
||
|
|
|
||
|
|
``set_mode`` determines the target object from which the property will be retrieved. See :ref:`CallMode<enum_VisualScriptPropertyGet_CallMode>` for options.
|
||
|
|
|
||
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
||
|
|
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
||
|
|
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|