Souichirou/Singularity
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Singularity/Library/PackageCache/com.unity.visualscripting@1.../Documentation~/vs-configuration.md
2024-05-06 11:45:45 -07:00

4.7 KiB
Raw Permalink Blame History

Configure project settings

Note

To use Visual Scripting in a project for the first time, you must initialize it from the Editor's Project Settings window.

Use the Project Settings window with Visual Scripting to manage backups, node assemblies, type options, and regenerate your Node Library.

To open your Project Settings:

  1. [!includeopen-project-settings]
  2. Select Visual Scripting.

You can find the following configuration options in your Visual Scripting Project Settings. To use Visual Scripting in a project for the first time, you must regenerate your Node Library, as described in the table below.

Option Description
Initialize Visual Scripting You must select Initialize Visual Scripting the first time you use Visual Scripting in a project. Initialize Visual Scripting to parse all assemblies and types for the Visual Scripting Node Library. After you initialize Visual Scripting, regenerate your Node Library. See Regenerate Nodes, below.
Type Options Use the Type Options list to add or remove types for your node inputs and outputs. After you add or remove a type, you must regenerate your Node Library. See Regenerate Nodes, below.
For more information on how to add or remove types, see Add or remove types.
Node Library Use the Node Library list to add or remove nodes and their assemblies in Visual Scripting. You must add any new types to your Type Options after you add new nodes to Visual Scripting. You must also regenerate your Node Library after you add or remove nodes. See Regenerate Nodes, below.
For more information on how to add or remove nodes from your Node Library, see Add or remove available nodes.
Regenerate Nodes Regenerate your Node Library to make all nodes available for use in a project.
To use Visual Scripting for the first time in a project, you must Initialize Visual Scripting and regenerate your Node Library.
To regenerate your Node Library:

  1. Select Regenerate Nodes.

  2. Select OK.

NOTE

You must regenerate your Node Library in the following circumstances:

  • Before you use Visual Scripting in your project for the first time.
  • After you add or remove nodes from your Node Library.
  • After you add or remove types from your Type Options.
  • After you change the inputs or outputs for a Custom C# node.
Generate To generate required property provider scripts for custom drawers, select Generate.
These scripts are necessary for Unity to use custom drawers for custom classes and script variables inside Visual Scripting. To assign a default value to a custom variable type through the Unity Editor’s Inspector, you must either have access to the source code for the class, or provide a custom PropertyDrawer. For more information, see Custom types.
Create Backup To create a new backup of your Visual Scripting graphs and settings, select Create Backup.
For more information about backups, see Create or restore a backup.
Restore Backup To open the folder where Visual Scripting stores your backups, select Restore Backup.
For more information about backups, see Create or restore a backup.
Fix Missing Scripts To correct any issues that might occur after migration from the Unity Asset Store version of Visual Scripting to the package version, select Fix Missing Scripts. This resolves any missing references to Visual Scripting Script Graphs and State Graphs in Script Machine or State Machine components.

Note

If your settings don't apply after you make a change, report a bug through the Unity Editor.