Previously known as VisualScriptingPlus (name changed due to overlap with existing Asset Store product).
Quality-of-life extensions to Unity Visual Scripting. Features not just a node search tool, but also other debugging tools as well. Visual Scripting Kai aims to give Unity Visual Scripting much-needed features to actually make it production-ready and competitive against well-known solutions like the Playmaker, and of course Unreal's Blueprint.
Live demo featuring a non-trivial Visual Scripting project:
vsplus_demo_edited.mp4
(The project above has over 700 graph units, over 50 states, and over 40 state transitions, yet Visual Scripting Kai still performs extremely smoothly!)
Feel free to request additional features in the Issues page.
(Window > Visual Scripting > Graph Lens)
A fuzzy search tool that can hunt down nodes, sticky notes, states, and state transitions in your graphs. Clicking the search results lets you jump straight to where the node is.
You can also use the sticky note search tool as a way to hunt down TODOs. This can be a powerful tool that lets you navigate through a large graph with ease.
Note that for elements that can have their names changed manually (Sticky Notes and State Transitions for example), they won't be reflected right away in the search results. Save the graph with Ctrl+S if you want to see it quickly.
(Window > Visual Scripting > Graph Analyzer)
A tool that can hunt down graph warnings. You can specify the minimum warning level to filter out unimportant warnings. Useful for cleaning up unused nodes and finding broken nodes quickly.
(Window > Visual Scripting > Graph Debugger)
A runtime tool that automatically pauses the game in Play Mode whenever a graph encounters an exception. The stack trace is laid out as well so you can quickly figure out why the exception happened. This can save you a lot of time by skipping the part where you have to dig through a long chain of red nodes to find the exception-causing node.
vskai-TestUnit.mp4
(Events > VS Kai > Test)
A powerful debugging node that lets you run Visual Scripting code anytime, anywhere, by just clicking on the "Run" button. Use it as a way to test logic quickly.
(VSKai > Functions)
Functions are a more powerful and safer version of Events, defined using a Script Graph Asset, like this:
With the Function Start and Function Return nodes, you can implement a function that has the same ports as a Script Graph Asset (this asset is called the function definition).
Other Script Machines can then use the Check Function or Has Function nodes to check if a GameObject implements a function, and if so, call it using the Call Function node.
Every Function node must be assigned a function definition through the Graph Inspector (on your left).
This feature unlocks Visual Scripting's potential for object-oriented programming, similar to Unreal's Blueprint interfaces. For example, you can use it to check if a bullet is colliding with something that can take damage (e.g., the player) or not (e.g., the wall).
Notes:
- You cannot implement the same function twice on the same GameObject.
- A complete function implementation must include a Function Start and a Function Return, and they must be in the same Script Machine. The nodes Function Start and Function Return must be on the top level of the Script Machine's graph (if you put them inside Subgraphs, they will be ignored).
- Calling a function on a GameObject that doesn't implement it is undefined behavior. You should always use Check Function to check if a target implements a function first. Or use Has Function with an If node.
vskai-FlowCoroutines.mp4
(VSKai > Coroutines)
Flow Coroutines are coroutines that can be launched from any node, and not just Events. The Start Flow Coroutine node can be used to launch a new Flow Coroutine. The logic of the Flow Coroutine is defined by the "Coroutine Start" port. You can also use the Flow Coroutine object returned by Start Flow Coroutine later, for example stopping it with the Stop Flow Coroutine node.
Flow Coroutines follow the same rules as any other coroutine - they belong to the GameObject they are spawned on, and will be stopped when the GameObject becomes inactive.
- This project is developed using Unity 2021.3.30f1, but should work with version 2021.3 and above in general.
- Visual Scripting Kai is distributed as a git package. Use Unity's Package Manager and install using this repository's URL:
https://github.com/chocola-mint/VisualScriptingKai.git - After installing, go to
Project Settings > Visual Scriptingand clickRegenerate Nodesto enable the Test Node and Function Nodes feature, if needed.
Support for embedded graphs inside scenes and prefabs is limited due to technical limitations. (For example, Graph Lens and the like can only detect them if they are currently open) Avoid them whenever possible to make the best use out of Visual Scripting Kai.