add nodes index

Lera Elvoé 2023-12-15 21:04:06 +03:00
parent 490624adc1
commit 4464d54579
No known key found for this signature in database
2 changed files with 74 additions and 1 deletions

@ -1,3 +1,3 @@
# StreamGraph Wiki
This is the home of the StreamGraph wiki
For a list of nodes, check out the [Nodes index.](/Nodes)

73
Nodes.md Normal file

@ -0,0 +1,73 @@
# List of nodes
Every node that exists in StreamGraph as of the latest revision is listed here, separated by category.
## General
General-purpose nodes.
### Bool Constant
A checkbox output.
### Expression
A node returning the result of a mathematical expression. Uses Godot's `Expression` class. [See the Godot documentation for more details.](https://docs.godotengine.org/en/4.2/classes/class_expression.html)
Has a Dictionary input that can be accessed in the expression with `input`.
Also has access to the parent Deck's variables, accessed with `deck_var`.
### Button
A button to trigger certain nodes that have a trigger input.
### String Constant
A text field output.
### Pass If True
Passes received input if *and only if* the condition input is true.
### Get Dictionary Key
Returns the value of a key from a dictionary input, if it exists, or null otherwise.
### Delay
Passes through a received input after the set time.
### Print
Print a value to the console. Prioritizes input port connections over the text entered in the text field.
### Set Deck Var
Set a variable on the parent deck on trigger.
### Get Deck Var
Returns a previously set deck variable, or null if it does not exist.
### Process Loop
Sends a trigger output every frame, and returns the delta value (time since last frame in seconds).
## Math
Nodes for working with math.
### Compose Vector
Returns a vector from two numeric inputs.
### Decompose Vector
Returns the X and Y components of a vector.
### Add Vectors
Adds two 2D vector inputs and returns the result.
### Subtract Vectors
Subtracts each component of the given vectors and returns the result.
### Normalize Vector
Normalizes a vector so its' length (magnitude) is exactly 1.
### Vector Dot Product
Returns the dot product of two vectors.
### Multiply Vector by Scalar
Multiplies a vector by a numeric value.
## OBS
Nodes for interacting with OBS.
### Set Scene
Sets the current scene in OBS.
### Set Source Transform
Sets an OBS source's transform, which includes position and rotation, among other things.
### Decompose OBS Transform
Splits an OBS transform from one object into multiple outputs.
### OBS WS Generic Request
Makes an OBS request and sends its result through. Use if if you really know what you're doing.
### Vector To OBS Position
Transforms a Vector into a position vector accepted by OBS transform inputs.
### Get Source ID
Searches for an OBS source in a scene by name and returns its ID.
### Scene Selector
Provides a dropdown list of scenes in a current OBS connection. Returns the scene name selected from the dropdown.
## Twitch
Nodes for interacting with Twitch.
### Twitch Chat Received
Sends an output when a chat is received on the current channel.
### Twitch Send Chat
Sends a message to the current channel.