Eigene VisualScript Nodes

Warnung

Godot 4.0 wird kein VisualScript mehr haben. Deswegen empfehlen wir, keine neuen Projekte mit visuellem scripting in Godot zu beginnen. Für spätere Godot 4.x Versionen könnte VisualScript als eine Erweiterung implementiert werden.

Während Godot 3.x VisualScript weiterhin offiziell unterstützt, empfehlen wir stattdessen GDScript auszutesten, vor allem dann, wenn du vor hast dein Projekt zu Godot 4 zu migrieren.

Eigene Nodes werden in GDScript geschrieben und können dann in VisualScript genutzt werden. Dies ist nützlich um komplexen Code nach GDScript auszulagern und mehrfach zu nutzen.

Erstellen eines eigenen Nodes

Erstellen Sie ein neues Skript, das VisualScriptCustomNode erweitert und setzen Sie oben ein` tool`-Schlüsselwort ein. Dies ist erforderlich, damit das Skript im Editor ausgeführt werden kann.

Es gibt einige Funktionen, die implementiert werden können, um Parameter des benutzerdefinierten Nodes festzulegen. Fügen Sie nur Funktionen hinzu die benötigt werden. Eine _has_input_sequence_port Funktion ist nicht erforderlich, wenn sie beispielsweise false zurückgeben soll.

Der wichtigste Teil eines eigenen Nodes die _step Funktion. Die Logik des Nodes wird dort definiert.

Der inputs Parameter beinhaltet den Wert der Eingabe-Ports.

Der Parameter output ist ein Array, in dem die Indizes die IDs des Ausgabeports darstellen. Er kann geändert werden, um die Werte der Ausgangsports festzulegen.

start_mode hiermit kann überprüft werden, ob _step das erste Mal aufgerufen wird.

working_mem bleibt bei jedem _step Aufruf bestehen. Es kann zum Speichern von Informationen verwendet werden.

Wenn Sie einen Fehler auslösen möchten, z.B. wenn die Eingabetypen falsch sind, können Sie die Fehlermeldung als Zeichenfolge zurückgeben. Wenn alles richtig läuft, geben Sie die ID des Sequenzports zurück, der als nächstes aufgerufen werden soll. Wenn Ihr benutzerdefinierter Node keinen hat, geben Sie einfach 0 zurück.

Beispiel:

tool
extends VisualScriptCustomNode

# The name of the custom node as it appears in the search.
func _get_caption():
    return "Get Input Direction 2D"

func _get_category():
    return "Input"

# The text displayed after the input port / sequence arrow.
func _get_text():
    return ""

func _get_input_value_port_count():
    return 0

# The types of the inputs per index starting from 0.
func _get_input_value_port_type(idx):
    return TYPE_OBJECT

func _get_output_value_port_count():
    return 1

# The types of outputs per index starting from 0.
func _get_output_value_port_type(idx):
    return TYPE_VECTOR2

# The text displayed before each output node per index.
func _get_output_value_port_name(idx):
    return "Direction"

func _has_input_sequence_port():
    return true

# The number of output sequence ports to use
# (has to be at least one if you have an input sequence port).
func _get_output_sequence_port_count():
    return 1

func _step(inputs, outputs, start_mode, working_mem):
    # start_mode can be checked to see if it is the first time _step is called.
    # This is useful if you only want to do an operation once.

    # working_memory is persistent between _step calls.

    # The inputs array contains the value of the input ports.

    var x = int(Input.is_action_pressed("ui_right")) - int(Input.is_action_pressed("ui_left"))
    var y = int(Input.is_action_pressed("ui_down")) - int(Input.is_action_pressed("ui_up"))

    # The outputs array is used to set the data of the output ports.

    outputs[0] = Vector2(x, y)

    # Return the error string if an error occurred, else the id of the next sequence port.
    return 0

Einen benutzerdefinierten Node nutzen

Um das Skript zu verwenden fügen Sie einen CustomNode hinzu, wählen Sie ihn aus und ziehen Sie Ihr benutzerdefiniertes Node-Skript in die im Inspektor angezeigte Eigenschaft script.

Ergebnis: