visual script nodes

Author: jankrassnigg

pages/docs/custom-code/visual-script/nodes/index.md

@@ -0,0 +1,34 @@
+# Visual Script Node Reference
+
+This section documents all the node types available in visual scripts.
+
+## Node Categories
+
+- [Event Handler Nodes](vscript-nodes-events.md) - React to messages and events
+- [Blackboard Nodes](vscript-nodes-blackboard.md) - Work with blackboards
+- [Time and Clock Nodes](vscript-nodes-time.md) - Access global and world clocks
+- [Component Nodes](vscript-nodes-component.md) - Component operations
+- [Property Nodes](vscript-nodes-property.md) - Read and write component properties
+- [Coroutine Nodes](vscript-nodes-coroutine.md) - Manage coroutines
+- [CVar Nodes](vscript-nodes-cvar.md) - Read and write CVars
+- [Debug Nodes](vscript-nodes-debug.md) - Debug rendering
+- [Enum Nodes](vscript-nodes-enum.md) - Work with enum values
+- [Game Object Nodes](vscript-nodes-game-object.md) - Game object operations
+- [World Nodes](vscript-nodes-world.md) - Access the world
+- [Logic Nodes](vscript-nodes-logic.md) - Conditionals and loops
+- [Math Nodes](vscript-nodes-math.md) - Mathematical operations
+- [Message Nodes](vscript-nodes-messages.md) - Send messages
+- [Physics Nodes](vscript-nodes-physics.md) - Physics engine functions
+- [Prefab Nodes](vscript-nodes-prefabs.md) - Spawn prefabs
+- [Spatial Nodes](vscript-nodes-spatial.md) - Spatial queries and transforms
+- [Sound Nodes](vscript-nodes-sound.md) - Play sounds
+- [State Machine Nodes](vscript-nodes-statemachine.md) - Interact with state machines
+- [String Nodes](vscript-nodes-string.md) - String operations
+- [Logging Nodes](vscript-nodes-log.md) - Log messages
+- [Variable and Type Conversion Nodes](vscript-nodes-variables.md) - Variables and type conversion
+
+## See Also
+
+- [Visual Script Class Asset](../visual-script-class-asset.md)
+- [Visual Script Overview](../visual-script-overview.md)
+- [Script Component](../script-component.md)

pages/docs/custom-code/visual-script/nodes/vscript-nodes-blackboard.md

@@ -0,0 +1,11 @@
+# Visual Script: Blackboard Nodes
+
+## Blackboards
+
+[Blackboards](../../misc/blackboards.md) are shared data storage systems that allow different game objects and components to communicate by reading and writing named values. The blackboard nodes in visual scripts provide access to blackboard entries for reading and modifying shared state.
+
+## See Also
+
+* [Visual Script Class Asset](../visual-script-class-asset.md)
+* [Visual Script Overview](../visual-script-overview.md)
+* [Script Component](../script-component.md)

pages/docs/custom-code/visual-script/nodes/vscript-nodes-component.md

@@ -0,0 +1,22 @@
+# Visual Script: Component and Property Nodes
+
+## Component
+
+Component nodes provide access to functionality shared by all [components](../../runtime/world/components.md). These are essential nodes for interacting with the component system and navigating the object hierarchy.
+
+Common component operations:
+
+* `GetOwner`: Returns the component's owner [game object](../../runtime/world/game-objects.md)
+* `GetWorld`: Returns the [world](../../runtime/world/worlds.md) that the component belongs to
+
+Additionally, each component type has its own specialized nodes available in the sub-menus, providing access to component-specific functionality. Use these together with [property nodes](vscript-nodes-property.md) to read and modify component state.
+
+## See Also
+
+* [Visual Script Class Asset](../visual-script-class-asset.md)
+* [Visual Script Overview](../visual-script-overview.md)
+* [Script Component](../script-component.md)
+* [Components](../../runtime/world/components.md)
+* [Game Object Nodes](vscript-nodes-game-object.md)
+* [World Nodes](vscript-nodes-world.md)
+* [Property Nodes](vscript-nodes-property.md)

pages/docs/custom-code/visual-script/nodes/vscript-nodes-coroutine.md

@@ -0,0 +1,21 @@
+# Visual Script: Coroutine Nodes
+
+## Coroutine
+
+[Coroutines](../visual-script-class-asset.md#coroutines) allow you to pause script execution at any point and resume it later, enabling complex temporal behaviors without blocking the entire script. This is particularly useful for sequencing AI tasks, quest objectives, or any operations that need to wait for conditions or time to pass.
+
+Common coroutine operations include:
+
+* **Starting and stopping coroutines** - Launch new execution threads or cancel existing ones
+* **Waiting** - Pause execution for a specified duration
+* **Yielding** - Pause until the next frame
+* **Coroutine management** - Track and control multiple concurrent execution paths
+
+Each [entry point node](vscript-nodes-events.md) can be configured with a coroutine mode (Stop Other, Don't Create New, or Allow Overlap) to control how multiple coroutines interact. See the [coroutines documentation](../visual-script-class-asset.md#coroutines) for detailed information on coroutine modes and advanced features.
+
+## See Also
+
+* [Visual Script Class Asset](../visual-script-class-asset.md)
+* [Visual Script Overview](../visual-script-overview.md)
+* [Script Component](../script-component.md)
+* [Event Handler Nodes](vscript-nodes-events.md)

pages/docs/custom-code/visual-script/nodes/vscript-nodes-cvar.md

@@ -0,0 +1,21 @@
+# Visual Script: CVar Nodes
+
+## CVar
+
+CVar nodes allow you to read and write [console variables (CVars)](../../debugging/cvars.md) from within visual scripts. CVars are configuration values that can be modified at runtime through the console, making them useful for debugging, testing, and exposing tunable parameters.
+
+Use CVar nodes to:
+
+* **Read CVar values** - Access configuration settings and debug flags
+* **Write CVar values** - Modify settings programmatically based on game state
+* **Dynamic configuration** - Change behavior without recompiling
+* **Debug controls** - Toggle features or adjust parameters during development
+
+CVars are particularly useful during development for tweaking gameplay values, enabling debug features, or testing different configurations. They can also be used to expose user settings that players can modify through the console.
+
+## See Also
+
+* [Visual Script Class Asset](../visual-script-class-asset.md)
+* [Visual Script Overview](../visual-script-overview.md)
+* [Script Component](../script-component.md)
+* [Console Variables](../../debugging/cvars.md)

pages/docs/custom-code/visual-script/nodes/vscript-nodes-debug.md

@@ -0,0 +1,24 @@
+# Visual Script: Debug Nodes
+
+## Debug
+
+Debug nodes provide functionality for [debug rendering](../../debugging/debug-rendering.md), allowing you to visualize information directly in the game viewport. These nodes are invaluable for understanding game logic, troubleshooting issues, and verifying that scripts are working as expected.
+
+Common debug rendering operations:
+
+* **Draw shapes** - Render lines, boxes, spheres, and other geometric primitives
+* **Draw text** - Display debug information in 3D space or on screen
+* **Visualize vectors** - Show directions, normals, and rays
+* **Temporary visuals** - Create visual aids that only appear during development
+
+Debug rendering is visible in both the editor and game viewports and can be toggled on/off through the [debug rendering system](../../debugging/debug-rendering.md). Use debug nodes liberally during development to visualize raycasts, AI decisions, trigger volumes, or any other abstract concepts that are hard to understand without visual feedback.
+
+Combine debug nodes with [logging nodes](vscript-nodes-log.md) for comprehensive debugging capabilities.
+
+## See Also
+
+* [Visual Script Class Asset](../visual-script-class-asset.md)
+* [Visual Script Overview](../visual-script-overview.md)
+* [Script Component](../script-component.md)
+* [Debug Rendering](../../debugging/debug-rendering.md)
+* [Logging Nodes](vscript-nodes-log.md)

pages/docs/custom-code/visual-script/nodes/vscript-nodes-enum.md

@@ -0,0 +1,18 @@
+# Visual Script: Enum Nodes
+
+## Enums
+
+Enum nodes allow you to work with enumeration values in visual scripts. Enumerations are predefined sets of named constants that make scripts more readable and less error-prone than using magic numbers.
+
+For each enum type, visual scripts provide two categories of nodes:
+
+* **Value nodes** - Return a specific enum constant. Use these to pass enum values to other nodes or compare against enum properties.
+* **Switch nodes** - Branching nodes that execute different code paths based on an enum value. Similar to a switch statement in programming, these nodes have one execution pin for each possible enum value.
+
+
+## See Also
+
+* [Visual Script Class Asset](../visual-script-class-asset.md)
+* [Visual Script Overview](../visual-script-overview.md)
+* [Script Component](../script-component.md)
+* [Logic Nodes](vscript-nodes-logic.md)

pages/docs/custom-code/visual-script/nodes/vscript-nodes-events.md

@@ -0,0 +1,11 @@
+# Visual Script: Event Handler Nodes
+
+## Event Handlers
+
+Event handlers are nodes that get executed when a certain [message](../../runtime/world/world-messaging.md) is sent to any of the objects that this script is responsible for. All event handlers are *entry points* into the script and most scripts will only execute as a reaction to an event.
+
+## See Also
+
+- [Visual Script Class Asset](../visual-script-class-asset.md)
+- [Visual Script Overview](../visual-script-overview.md)
+- [Script Component](../script-component.md)

pages/docs/custom-code/visual-script/nodes/vscript-nodes-game-object.md

@@ -0,0 +1,25 @@
+# Visual Script: Game Object Nodes
+
+## Game Object
+
+[Game object](../../runtime/world/game-objects.md) nodes provide functionality for working with game objects in the scene hierarchy. These nodes allow you to navigate the object tree, manipulate transforms, and access components.
+
+Common game object operations:
+
+* **Transform access** - Read and write position, rotation, and scale
+* **Hierarchy navigation** - Find parent and child objects, search by name
+* **Component access** - Get components attached to game objects
+* **Object state** - Check if objects are active, valid, or tagged
+* **Object creation** - Spawn and destroy game objects dynamically
+
+Game object nodes are fundamental to most visual scripts, as they allow you to locate and manipulate objects in the scene. Use them together with [component nodes](vscript-nodes-component.md) to access specific functionality, and [prefab nodes](vscript-nodes-prefabs.md) to instantiate new objects.
+
+## See Also
+
+* [Visual Script Class Asset](../visual-script-class-asset.md)
+* [Visual Script Overview](../visual-script-overview.md)
+* [Script Component](../script-component.md)
+* [Game Objects](../../runtime/world/game-objects.md)
+* [Component Nodes](vscript-nodes-component.md)
+* [Prefab Nodes](vscript-nodes-prefabs.md)
+* [Spatial Nodes](vscript-nodes-spatial.md)

pages/docs/custom-code/visual-script/nodes/vscript-nodes-log.md

@@ -0,0 +1,23 @@
+# Visual Script: Logging Nodes
+
+## Log
+
+Logging nodes output messages to the [engine's log system](../../debugging/logging.md), allowing you to track script execution, debug issues, and monitor runtime behavior. These nodes are essential for understanding what your scripts are doing and troubleshooting problems.
+
+Logging features:
+
+* **Formatted messages** - Create log messages with variable substitution using format strings
+* **Multiple inputs** - Add any number of input values to include in the log message
+* **Format syntax** - Reference input values using `{0}`, `{1}`, `{2}` and so on in your format string
+* **Log levels** - Output at different severity levels (info, warning, error)
+
+Example: A log message with format string `"Player health: {0}, position: {1}"` with two inputs will substitute the values into the message.
+
+## See Also
+
+* [Visual Script Class Asset](../visual-script-class-asset.md)
+* [Visual Script Overview](../visual-script-overview.md)
+* [Script Component](../script-component.md)
+* [Logging](../../debugging/logging.md)
+* [Debug Nodes](vscript-nodes-debug.md)
+* [String Nodes](vscript-nodes-string.md)