Docs4dev
Docs
godot / 3.4 / classes / class_visualscriptyieldsignal.html

VisualScriptYieldSignal

Inherits: VisualScriptNode < Resource < Reference < Object

A Visual Script node yielding for a signal.

Description

VisualScriptYieldSignal will pause the function execution until the provided signal is emitted.

Properties

String

base_type

"Object"

CallMode

call_mode

0

NodePath

node_path

String

signal

""

Enumerations

enum CallMode:

  • CALL_MODE_SELF = 0 --- A signal from this Object will be used.
  • CALL_MODE_NODE_PATH = 1 --- A signal from the given Node in the scene tree will be used.
  • CALL_MODE_INSTANCE = 2 --- A signal from an instanced node with the given type will be used.

Property Descriptions

String base_type

Default

"Object"

Setter

set_base_type(value)

Getter

get_base_type()

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

CallMode call_mode

Default

0

Setter

set_call_mode(value)

Getter

get_call_mode()

call_mode determines the target object to wait for the signal emission. See CallMode for options.

NodePath node_path

Setter

set_base_path(value)

Getter

get_base_path()

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

String signal

Default

""

Setter

set_signal(value)

Getter

get_signal()

The signal name to be waited for.

© 2014–2022 Juan Linietsky, Ariel Manzur, Godot Engine contributors
Licensed under the MIT License.
https://docs.godotengine.org/en/3.4/classes/class_visualscriptyieldsignal.html