Skip to content
Bit Quirky Round Trip
Visual Scripting

Search documentation

All topics and APIs

Close returns focus to Search.

What are you looking for?

Try a common topic or a C# feature.

Browse the reference instead

Esc closes · Tab reaches results · Enter opens the focused link

v1.0.0
Menu

Identity and inspector

Read and edit the right rail's identity header, method comment, inputs and outputs, node details, and pending-changes panel.

The right rail answers the question a crowded canvas cannot: what exactly is selected, and what can I change about it?

A node named for a method is easy to recognize. A pill, a comparison, or the method itself needs more context: what kind of thing it is, who can use it, what it gives back, and what its comment says. The right rail shows that for whatever you click, and holds the controls to change it: the method’s name, its comment, its inputs and outputs, and the settings of the selected node.

Use the inspector when you give a new method its inputs, such as the amount of damage a hit deals or the item a pickup grants. Use it when two nodes look alike and you need to know which is which, when a pin needs an exact type, or when you are about to rename something. It is also where every change waiting for Compile is counted.

Read an identity and recognize a pending edit

Select a screenshot to enlarge it.

CollectCoin has public access and void return type. A two-guarded-values badge sits above its XML method comment.
Figure 1. Read the method identity CollectCoin has public access and returns void. METHOD COMMENT is directly below the identity. Simple and XML choose its style; Edit changes its text.
A separate CelebrateCoin method draft with its entry node, Signature, Inputs, Outputs and Previewing your changes panel.
Figure 2. Find the editable method sections In this separate new-method example, Signature reads public void CelebrateCoin(). Inputs and Outputs each have a +. The pinned Previewing your changes panel says this method is not in the C# yet; Compile is highlighted.

Give a method an identity, then compile it

  1. Add a method

    In the left rail, click + on the Methods header and press Enter. The new method is selected.

    PlayerController's left rail with the + beside the Methods header highlighted and an arrow pointing at it.
    The right rail after the new method is added: the pinned Previewing your changes panel reads 1 method isn't in the C# yet, and the header beneath it reads PlayerController.New... with public · void, highlighted.
  2. Add a comment

    Under METHOD COMMENT, click Add a comment… and type what the method is for.

    The top of the right rail for the new method. Under METHOD COMMENT, the empty Add a comment… box is highlighted with an arrow pointing at it; above it sit the Previewing your changes panel and the PlayerController.New… header.
    After typing, the METHOD COMMENT card, highlighted, holds the text Removes health when the player takes a hit, under the // Simple and /// XML toggle.
  3. Add an input

    Click + on the Inputs header. A row appears with a type dropdown, a name box and a ✕. Click the type dropdown and choose int, then type amount in the name box and click away.

    The + beside the Inputs header, with an arrow pointing at it, and the new input row int amount are highlighted. The Signature box reads public void NewMethod(int amount).
  4. Add an output

    Click + on the Outputs header the same way and pick a type to have the method give back a value.

    The + beside the Outputs header, with an arrow pointing at it, and the new output row int newParameter are highlighted. The Signature box now reads public void NewMethod(int amount, out int newParameter).
  5. Rename the method

    Click the method’s name at the top of the right rail and press F2, then type a new name. Press Enter to keep it or Escape to cancel; clicking away also keeps it.

    The method name at the top of the right rail, highlighted. The header and Signature box now read TakeDamage instead of NewMethod, with the same int amount input and int newParameter output.
  6. Click a node

    Click a node on the canvas. The header changes to the node. An input that takes a typed value carries the same box as its pin: type into it or tick it, and the pin on the canvas changes with it. Click the method’s row in the left rail to bring the method back.

    A Log node is selected: the right rail header, highlighted, now reads Log, impure · log, with a Call section (Method Log, Type Debug) and an empty message : object input box.
  7. Compile

    Press Compile, in the pinned panel or in the toolbar. The panel disappears and the canvas reloads.

    The pinned Previewing your changes panel at the top of the right rail, with its Compile button highlighted and an arrow pointing at it.
    The toolbar at the top of the window before Compile is pressed: the amber Compile button at its left, next to the back and forward arrows, is highlighted with an arrow pointing at it.
    After Compile the toolbar's Compile button, highlighted, is inactive and the pinned Previewing your changes panel is gone; the right rail reads PlayerController.Take... with an empty METHOD COMMENT.

If you also work in C#, renaming a method to RefreshState and giving it an int amount input writes this declaration into the script when you press Compile:

Looking at the header writes nothing. Lifecycle names stay locked, so no change is ever made to them.

When it goes wrong

SymptomCheckFix
F2 does not open the name editor.Check whether the selected method is a Unity lifecycle method, such as Update.Keep the lifecycle name and change its nodes or comment instead.
The right rail describes a node instead of the method.Look for a selected node on the canvas.Click the method's row in the left rail to bring the method back into the inspector.
A change seems to disappear when you select another node.Read the pinned Previewing your changes panel at the top of the rail.The panel still counts them. Press Compile to save them, or Revert to discard them. Changes belong to the method, not to the selected node.
A new input pin does not appear on the entry node.Look at the input row: its name box is empty or still has focus.Type a name and click away from the box.
Full-size image