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

Settings and preferences

Choose shared source folders and recognition rules in Project Settings, while keeping canvas feel in your own Preferences.

One teammate likes a visible grid. Another zooms with the scroll wheel in the opposite direction. Neither preference should change which classes Round Trip finds or how it recognizes a guard.

A Unity project needs one shared answer to which script folders Round Trip reads and how it recognizes patterns such as guards, while each person wants a canvas that feels right to them. Mixing the two would put one person’s grid color into everyone’s commits.

Round Trip follows Unity’s own boundary: project behavior in Project Settings > Round Trip, personal canvas feel in Preferences > Round Trip.

Open Project Settings > Round Trip when you add a script folder, choose where canvas arrangements are saved, or change a rule that should mean the same thing for everyone. Open Preferences > Round Trip when only how the canvas looks or responds to your mouse should change.

Choose the right settings page

Select a screenshot to enlarge it.

Actual Round Trip Project Settings show the source folder and Local layout scope. The Include Paths row and the Layout Scope dropdown are highlighted, with an arrow pointing down at the dropdown.
Figure 1. Project: which code and where layouts live Use Project Settings for Include Paths and Layout Scope. This example indexes the Platformer runtime folder. Changes here belong to the shared settings asset.
The actual Guard recognition settings show the pattern list and separate default categories.
Figure 2. Project: recognition rules Guard recognition is also project behavior. Keep the same rule library for the team; the Guard rules guide explains its fields.
Preferences shows its live grid preview and Snap to grid switch. The Snap to grid switch is highlighted, with an arrow pointing at it.
Figure 3. Personal: canvas and grid Use Preferences to change the grid and mouse feel. These choices stay in your editor profile.
The TOOLBAR preferences section has Show coverage switched off. The Show coverage switch is highlighted, with an arrow pointing at it.
Figure 4. Personal: toolbar visibility Show coverage controls your own toolbar. It is independent of which folders the project indexes.
Surface Scope Stored in
Project Settings > Round Trip Whole project ProjectSettings/RoundTripSettings.asset
Preferences > Round Trip Current editor user Unity EditorPrefs
The Round Trip window’s last open class and method Current user, this project UserSettings/RoundTripUserState.asset, which Unity’s version-control conventions ignore

The Project Settings > Round Trip page has these headings, top to bottom:

  • Under Source indexing, Include Paths lists script folders under Assets/..., Packages/..., or a configured external folder.
  • Under Version Control, Version Control Baseline chooses the version the change markers compare against.
  • Under Layout storage, Layout Scope is Local by default; you can choose Shared.
  • Under Guard recognition, edit Guard Patterns and method requirements. You can also set pin-check defaults and the default return value for a skipped method. Guard rules explains each setting and walks through choosing a default or adding your own C# pattern.
  • Under Lifecycle recognition, choose whether Unity callbacks are recognized. Configure the catalog version and host definitions there, as well as the required lifecycle entries.
  • Under Field defaults, configure the resolver style and condition. You can also set safe-lookup behavior and initializer recipes.
  • Under Naming, Backing field prefix and Backing field lowercase first letter decide what Round Trip names the private field it writes behind a property shown in the Inspector. See Change how backing fields are named.

Preferences contain:

  • Under TOOLBAR, Show coverage controls whether the Round Trip window’s toolbar draws the Coverage pill. It is off by default.
  • Under READ PILLS, Split long read wires and Split distance control whether the next full automatic layout gives distant uses of a value a pill of their own. Splitting is on by default; turning it off keeps every read as one pill. Split distance sets how far a node can sit from the value’s source, or from other nodes sharing its pill, and still stay wired to it. The distance is measured in standard card widths: 2 by default, with a range of 0.5 to 10. The control is grayed out while splitting is off. Both settings apply at the next Auto layout, or the first open of a method with no saved layout, and never rearrange a saved diagram.
  • Show hidden members and List them last, under CALL MENU: how the canvas menus and the inspector’s Choose method list for a call node treat methods and static values marked [Obsolete] or hidden from IntelliSense with [EditorBrowsable(EditorBrowsableState.Never)], on the member or on a type containing it. By default they follow Rider: hidden members are left out, and obsolete ones, such as Object.FindObjectOfType, are listed after every other match. Neither is ever among the suggestions shown before you type. Show hidden members lists the hidden ones too. While it is on, List them last (on by default) keeps both kinds after every other match; off ranks them like any other member. List them last is grayed out while hidden members are left out.
  • Scroll-wheel behavior and zoom direction, plus zoom sensitivity.
  • Theme and canvas colors.
  • Grid visibility and Snap to grid, along with line and dot colors, spacing, frequency and dot radius.
  • Wire routing and appearance.

Separate project settings from personal preferences

  1. Open Project Settings

    Open Edit > Project Settings and click Round Trip in the list on the left (or choose Tools > Round Trip > Project Settings).

    Project Settings open on Round Trip, with a note at the top saying these settings are stored in ProjectSettings/RoundTripSettings.asset and shared with the project.
  2. Add a source folder

    Under Source indexing, expand Include Paths. If your script folder is missing, press + at the bottom of the list and type its path, for example Assets/Scripts. You can also right-click the folder in Unity’s Project window and choose Round Trip > Add Folder to Round Trip.

    Include Paths expanded and highlighted, showing the project's one entry, Assets/Platformer/Runtime. The + button at the bottom of the list is highlighted with an arrow pointing at it.
  3. Leave Layout Scope on Local

    Under Layout storage, leave Layout Scope on Local unless your team has chosen to review shared arrangements.

    Layout Storage section with the Layout Scope dropdown highlighted, with an arrow pointing at it, set to Local.
    The Guard Recognition and Lifecycle Recognition sections appear above Field Defaults. Their sub-lists are collapsed by default.
  4. Commit the settings asset

    Commit ProjectSettings/RoundTripSettings.asset with the project whenever you change something on this page.

    The note at the top of the Project Settings page, with the file name ProjectSettings/RoundTripSettings.asset highlighted.
  5. Open your Preferences

    Open Preferences > Round Trip: choose Tools > Round Trip > Settings, or press the gear at the right end of the Round Trip window’s top rail.

    Preferences open on Round Trip.
  6. Make the canvas feel right

    Adjust the canvas colors and grid controls to suit you. You can also change scroll and zoom behavior or wire routing.

    Preferences GRID & CANVAS section. The Canvas background, Grid line, Grid dot and Grid spacing controls are highlighted, with an arrow pointing at them; the live preview sits above.
  7. Show the Coverage pill

    Under TOOLBAR, switch Show coverage on to put the Coverage pill on the Round Trip window’s top rail.

    The TOOLBAR section with the Show Coverage switch highlighted, with an arrow pointing at it, switched on.
  8. Choose how reads split

    Under READ PILLS, turn Split long read wires off if you want every read kept as one pill, or drag Split distance to change how far apart nodes can sit and still share one.

    The READ PILLS section with the Split long read wires switch highlighted, with an arrow pointing at it, switched off, and the grayed-out Split distance slider highlighted.

When a variable is a property and also Shown in the Inspector, Round Trip writes it as a field-backed property, because Unity only shows fields in the Inspector. For a property called Speed that you add with Property on and Shown in the Inspector on, the default is:

Set Setter to None in the right rail and the property is written as the shorter public float Speed => _speed;.

Teams name that private field differently, so the name is a project setting:

Name the backing field

  1. Open Round Trip's project settings

    Open Edit > Project Settings and click Round Trip (or choose Tools > Round Trip > Project settings). You can also type backing in the Project Settings search box.

    Unity's Project Settings window with Round Trip highlighted in the left list and an arrow pointing at it. The right pane starts with a note about ProjectSettings/RoundTripSettings.asset, then Source indexing, Version control, Layout storage, Guard recognition, Lifecycle recognition, Field defaults and Naming.
  2. Find Naming

    Naming is the last heading on the page. Scroll down to it if your window is short.

    The Naming heading at the foot of the page, highlighted with an arrow pointing at it. Backing field prefix holds an underscore and Backing field lowercase first letter is checked.
  3. Set the prefix

    Set Backing field prefix to what the field’s name starts with: _ (the default), m_, or nothing at all.

    Under Naming, the Backing field prefix box is highlighted and now reads m_. Backing field lowercase first letter is still checked.
  4. Choose the first letter's case

    Switch Backing field lowercase first letter on to lower the property name’s first letter after the prefix, or off to keep it.

    Under Naming, the Backing field lowercase first letter checkbox is highlighted with an arrow pointing at it, now unchecked. Backing field prefix reads m_.
  5. Share it with the team

    Commit ProjectSettings/RoundTripSettings.asset so the whole team writes the same names.

    The note at the top of the Round Trip page, with the file name ProjectSettings/RoundTripSettings.asset highlighted: These settings are stored in ProjectSettings/RoundTripSettings.asset and should be shared with the project.
Prefix Lowercase first letter Field behind Speed
_ On (default) _speed
_ Off _Speed
m_ Off m_Speed
(empty) On speed

The setting applies the next time you press Compile. Fields already in your scripts are renamed only when you switch an existing variable to Property: its field then takes the configured name, and Round Trip adds [FormerlySerializedAs("oldName")] so Unity keeps the value it saved. If the name it gives is already taken in the class, Round Trip leaves the property unwritten and says which name clashed, so you can rename the variable or change the setting.

Unity saves project settings in ProjectSettings/RoundTripSettings.asset.

Personal canvas preferences use Unity EditorPrefs keys with the RoundTrip.GraphPreference prefix, Show coverage uses RoundTrip.Toolbar.ShowCoverage, the READ PILLS settings use RoundTrip.ReadPills.SplitLongWires and RoundTrip.ReadPills.SplitDistanceCards, and the CALL MENU settings use RoundTrip.CallMenu.ShowDiscouragedMethods and RoundTrip.CallMenu.ListDiscouragedMethodsLast. They are not project assets.

When it goes wrong

SymptomCheckFix
A class is missing for everyone.Check the shared include paths.Add its source folder under Project Settings > Round Trip.
A class is missing only on one machine.Check whether an external include path resolves on that checkout.Point the shared entry at a stable project-relative location when possible.
Grid or zoom changes appear in a project commit.Check whether the project settings asset changed too.Keep appearance work in Preferences > Round Trip and revert unrelated project-setting edits.
The Coverage pill is missing from the toolbar.Show coverage is off by default.Switch it on under TOOLBAR in Preferences > Round Trip.
A method or static value you know exists is not in the right-click menu, or only at the bottom of it.Its library hides it from IntelliSense with [EditorBrowsable(Never)], which leaves it out by default, or marks it [Obsolete], such as Object.FindObjectOfType, which lists it after every other match.Type more of the name so fewer matches list ahead of an obsolete member, or switch on Show hidden members under CALL MENU in Preferences > Round Trip.
A property shown in the Inspector was not written, and the reason names a member that already exists.The class already has a member with the name your backing field naming gives its field, such as _speed for Speed.Rename the variable, or change Naming in Project Settings > Round Trip.
Team members recognize guards differently.Compare ProjectSettings/RoundTripSettings.asset.Share one guard catalog through project settings.
Full-size image