VisualScriptPropertySet

Inherits: VisualScriptNode < Resource < Reference < Object

A Visual Script node that sets a property of an Object.

Description

VisualScriptPropertySet can set the value of any property from the current object or other objects.

Properties

AssignOp

assign_op

0

String

base_script

String

base_type

“Object”

Variant.Type

basic_type

String

index

NodePath

node_path

String

property

“”

CallMode

set_mode

0

Enumerations

enum CallMode:

  • CALL_MODE_SELF = 0 —- The property will be set on this Object.

  • CALL_MODE_NODE_PATH = 1 —- The property will be set on the given Node in the scene tree.

  • CALL_MODE_INSTANCE = 2 —- The property will be set on an instanced node with the given type and script.

  • CALL_MODE_BASIC_TYPE = 3 —- The property will be set on a GDScript basic type (e.g. Vector2).

enum AssignOp:

  • ASSIGN_OP_NONE = 0 —- The property will be assigned regularly.

  • ASSIGN_OP_ADD = 1 —- The value will be added to the property. Equivalent of doing +=.

  • ASSIGN_OP_SUB = 2 —- The value will be subtracted from the property. Equivalent of doing -=.

  • ASSIGN_OP_MUL = 3 —- The property will be multiplied by the value. Equivalent of doing *=.

  • ASSIGN_OP_DIV = 4 —- The property will be divided by the value. Equivalent of doing /=.

  • ASSIGN_OP_MOD = 5 —- A modulo operation will be performed on the property and the value. Equivalent of doing %=.

  • ASSIGN_OP_SHIFT_LEFT = 6 —- The property will be binarly shifted to the left by the given value. Equivalent of doing <<.

  • ASSIGN_OP_SHIFT_RIGHT = 7 —- The property will be binarly shifted to the right by the given value. Equivalent of doing >>.

  • ASSIGN_OP_BIT_AND = 8 —- A binary AND operation will be performed on the property. Equivalent of doing &=.

  • ASSIGN_OP_BIT_OR = 9 —- A binary OR operation will be performed on the property. Equivalent of doing |=.

  • ASSIGN_OP_BIT_XOR = 10 —- A binary XOR operation will be performed on the property. Equivalent of doing ^=.

Property Descriptions

Default

0

Setter

set_assign_op(value)

Getter

get_assign_op()

The additional operation to perform when assigning. See AssignOp for options.

Setter

set_base_script(value)

Getter

get_base_script()

The script to be used when set_mode is set to CALL_MODE_INSTANCE.

Default

“Object”

Setter

set_base_type(value)

Getter

get_base_type()

The base type to be used when set_mode is set to CALL_MODE_INSTANCE.

Setter

set_basic_type(value)

Getter

get_basic_type()

The type to be used when set_mode is set to CALL_MODE_BASIC_TYPE.

Setter

set_index(value)

Getter

get_index()

The indexed name of the property to set. See Object.set_indexed for details.

Setter

set_base_path(value)

Getter

get_base_path()

The node path to use when set_mode is set to CALL_MODE_NODE_PATH.

Default

“”

Setter

set_property(value)

Getter

get_property()

The name of the property to set. Changing this will clear index.

Default

0

Setter

set_call_mode(value)

Getter

get_call_mode()

set_mode determines the target object on which the property will be set. See CallMode for options.