mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
218 lines
7.5 KiB
ReStructuredText
218 lines
7.5 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the VisualScriptPropertySet.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_VisualScriptPropertySet:
|
|
|
|
VisualScriptPropertySet
|
|
=======================
|
|
|
|
**Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
|
|
|
|
|
|
|
Properties
|
|
----------
|
|
|
|
+--------------------------------------------------------+------------------------------------------------------------------------+--------------+
|
|
| :ref:`AssignOp<enum_VisualScriptPropertySet_AssignOp>` | :ref:`assign_op<class_VisualScriptPropertySet_property_assign_op>` | ``0`` |
|
|
+--------------------------------------------------------+------------------------------------------------------------------------+--------------+
|
|
| :ref:`String<class_String>` | :ref:`base_script<class_VisualScriptPropertySet_property_base_script>` | |
|
|
+--------------------------------------------------------+------------------------------------------------------------------------+--------------+
|
|
| :ref:`String<class_String>` | :ref:`base_type<class_VisualScriptPropertySet_property_base_type>` | ``"Object"`` |
|
|
+--------------------------------------------------------+------------------------------------------------------------------------+--------------+
|
|
| :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` | :ref:`basic_type<class_VisualScriptPropertySet_property_basic_type>` | |
|
|
+--------------------------------------------------------+------------------------------------------------------------------------+--------------+
|
|
| :ref:`String<class_String>` | :ref:`index<class_VisualScriptPropertySet_property_index>` | |
|
|
+--------------------------------------------------------+------------------------------------------------------------------------+--------------+
|
|
| :ref:`NodePath<class_NodePath>` | :ref:`node_path<class_VisualScriptPropertySet_property_node_path>` | |
|
|
+--------------------------------------------------------+------------------------------------------------------------------------+--------------+
|
|
| :ref:`String<class_String>` | :ref:`property<class_VisualScriptPropertySet_property_property>` | ``""`` |
|
|
+--------------------------------------------------------+------------------------------------------------------------------------+--------------+
|
|
| :ref:`CallMode<enum_VisualScriptPropertySet_CallMode>` | :ref:`set_mode<class_VisualScriptPropertySet_property_set_mode>` | ``0`` |
|
|
+--------------------------------------------------------+------------------------------------------------------------------------+--------------+
|
|
|
|
Enumerations
|
|
------------
|
|
|
|
.. _enum_VisualScriptPropertySet_CallMode:
|
|
|
|
.. _class_VisualScriptPropertySet_constant_CALL_MODE_SELF:
|
|
|
|
.. _class_VisualScriptPropertySet_constant_CALL_MODE_NODE_PATH:
|
|
|
|
.. _class_VisualScriptPropertySet_constant_CALL_MODE_INSTANCE:
|
|
|
|
.. _class_VisualScriptPropertySet_constant_CALL_MODE_BASIC_TYPE:
|
|
|
|
enum **CallMode**:
|
|
|
|
- **CALL_MODE_SELF** = **0**
|
|
|
|
- **CALL_MODE_NODE_PATH** = **1**
|
|
|
|
- **CALL_MODE_INSTANCE** = **2**
|
|
|
|
- **CALL_MODE_BASIC_TYPE** = **3**
|
|
|
|
----
|
|
|
|
.. _enum_VisualScriptPropertySet_AssignOp:
|
|
|
|
.. _class_VisualScriptPropertySet_constant_ASSIGN_OP_NONE:
|
|
|
|
.. _class_VisualScriptPropertySet_constant_ASSIGN_OP_ADD:
|
|
|
|
.. _class_VisualScriptPropertySet_constant_ASSIGN_OP_SUB:
|
|
|
|
.. _class_VisualScriptPropertySet_constant_ASSIGN_OP_MUL:
|
|
|
|
.. _class_VisualScriptPropertySet_constant_ASSIGN_OP_DIV:
|
|
|
|
.. _class_VisualScriptPropertySet_constant_ASSIGN_OP_MOD:
|
|
|
|
.. _class_VisualScriptPropertySet_constant_ASSIGN_OP_SHIFT_LEFT:
|
|
|
|
.. _class_VisualScriptPropertySet_constant_ASSIGN_OP_SHIFT_RIGHT:
|
|
|
|
.. _class_VisualScriptPropertySet_constant_ASSIGN_OP_BIT_AND:
|
|
|
|
.. _class_VisualScriptPropertySet_constant_ASSIGN_OP_BIT_OR:
|
|
|
|
.. _class_VisualScriptPropertySet_constant_ASSIGN_OP_BIT_XOR:
|
|
|
|
enum **AssignOp**:
|
|
|
|
- **ASSIGN_OP_NONE** = **0**
|
|
|
|
- **ASSIGN_OP_ADD** = **1**
|
|
|
|
- **ASSIGN_OP_SUB** = **2**
|
|
|
|
- **ASSIGN_OP_MUL** = **3**
|
|
|
|
- **ASSIGN_OP_DIV** = **4**
|
|
|
|
- **ASSIGN_OP_MOD** = **5**
|
|
|
|
- **ASSIGN_OP_SHIFT_LEFT** = **6**
|
|
|
|
- **ASSIGN_OP_SHIFT_RIGHT** = **7**
|
|
|
|
- **ASSIGN_OP_BIT_AND** = **8**
|
|
|
|
- **ASSIGN_OP_BIT_OR** = **9**
|
|
|
|
- **ASSIGN_OP_BIT_XOR** = **10**
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_VisualScriptPropertySet_property_assign_op:
|
|
|
|
- :ref:`AssignOp<enum_VisualScriptPropertySet_AssignOp>` **assign_op**
|
|
|
|
+-----------+----------------------+
|
|
| *Default* | ``0`` |
|
|
+-----------+----------------------+
|
|
| *Setter* | set_assign_op(value) |
|
|
+-----------+----------------------+
|
|
| *Getter* | get_assign_op() |
|
|
+-----------+----------------------+
|
|
|
|
----
|
|
|
|
.. _class_VisualScriptPropertySet_property_base_script:
|
|
|
|
- :ref:`String<class_String>` **base_script**
|
|
|
|
+----------+------------------------+
|
|
| *Setter* | set_base_script(value) |
|
|
+----------+------------------------+
|
|
| *Getter* | get_base_script() |
|
|
+----------+------------------------+
|
|
|
|
----
|
|
|
|
.. _class_VisualScriptPropertySet_property_base_type:
|
|
|
|
- :ref:`String<class_String>` **base_type**
|
|
|
|
+-----------+----------------------+
|
|
| *Default* | ``"Object"`` |
|
|
+-----------+----------------------+
|
|
| *Setter* | set_base_type(value) |
|
|
+-----------+----------------------+
|
|
| *Getter* | get_base_type() |
|
|
+-----------+----------------------+
|
|
|
|
----
|
|
|
|
.. _class_VisualScriptPropertySet_property_basic_type:
|
|
|
|
- :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **basic_type**
|
|
|
|
+----------+-----------------------+
|
|
| *Setter* | set_basic_type(value) |
|
|
+----------+-----------------------+
|
|
| *Getter* | get_basic_type() |
|
|
+----------+-----------------------+
|
|
|
|
----
|
|
|
|
.. _class_VisualScriptPropertySet_property_index:
|
|
|
|
- :ref:`String<class_String>` **index**
|
|
|
|
+----------+------------------+
|
|
| *Setter* | set_index(value) |
|
|
+----------+------------------+
|
|
| *Getter* | get_index() |
|
|
+----------+------------------+
|
|
|
|
----
|
|
|
|
.. _class_VisualScriptPropertySet_property_node_path:
|
|
|
|
- :ref:`NodePath<class_NodePath>` **node_path**
|
|
|
|
+----------+----------------------+
|
|
| *Setter* | set_base_path(value) |
|
|
+----------+----------------------+
|
|
| *Getter* | get_base_path() |
|
|
+----------+----------------------+
|
|
|
|
----
|
|
|
|
.. _class_VisualScriptPropertySet_property_property:
|
|
|
|
- :ref:`String<class_String>` **property**
|
|
|
|
+-----------+---------------------+
|
|
| *Default* | ``""`` |
|
|
+-----------+---------------------+
|
|
| *Setter* | set_property(value) |
|
|
+-----------+---------------------+
|
|
| *Getter* | get_property() |
|
|
+-----------+---------------------+
|
|
|
|
----
|
|
|
|
.. _class_VisualScriptPropertySet_property_set_mode:
|
|
|
|
- :ref:`CallMode<enum_VisualScriptPropertySet_CallMode>` **set_mode**
|
|
|
|
+-----------+----------------------+
|
|
| *Default* | ``0`` |
|
|
+-----------+----------------------+
|
|
| *Setter* | set_call_mode(value) |
|
|
+-----------+----------------------+
|
|
| *Getter* | get_call_mode() |
|
|
+-----------+----------------------+
|
|
|
|
.. |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.)`
|