Created a tutorial page for dynamic variables. |
Added example steps for the Dynamic Variable Input. |
||
Line 37: | Line 37: | ||
=== Setup === | === Setup === | ||
[[File:Dynamic Variable Input Example.png|alt=An example of using the Dynamic Variable Input node.|thumb|An example of using the [[ProtoFlux:Dynamic Variable Input|Dynamic Variable Input]] node.]] | |||
# Spawn any [[Slot]] to use as your space (the example uses a box), then set up the [[Component:DynamicVariableSpace|DynamicVariableSpace]] component on your slot. | |||
## Pick a name for this space. (The example uses <code>Example</code>) | |||
# Spawn the [[ProtoFlux:Dynamic Variable Input|Dynamic Variable Input]] node. | |||
## Setup the name for this node. (The example uses <code>Example/MyBox</code>) | |||
# Make a child object of that slot, then add the [[Component:DynamicValueVariable|DynamicValueVariable]] or [[Component:DynamicReferenceVariable|DynamicReferenceVariable]] component. (The exmaple uses [[Component:DynamicReferenceVariable|DynamicReferenceVariable]]) | |||
## Setup the name for this component. (The example uses <code>Example/MyBox</code>) | |||
# Pack the [[ProtoFlux:Dynamic Variable Input|Dynamic Variable Input]] node under the child slot (or anywhere under the slot that has the [[Component:DynamicVariableSpace|DynamicVariableSpace]]), and it should work. (The example uses [[Redprint|Red Print]] to do this.) | |||
---- | ---- |
Revision as of 16:30, 13 July 2024
This article or section is a Stub. You can help the Resonite Wiki by expanding it.
As the Dynamic Variables page itself is quite information dense, this tutorial will serve as a quick guide to create, write and read these variables and components, and is also designed to get you started immediately with them, in a step by step process. This should also be simpler to understand in comparison to the main page.
Since you can use dynamic variables in many different configurations, this tutorial will be split up based on what your needs and requirements are.
Triggers & Receivers
Use this when you just want to send a signal across different code groups (and also sometimes with data)
What You Need
- The Dynamic Impulse Trigger & Dynamic Impulse Receiver nodes.
- (Optional) Slot hierarchy.
Setup
- Spawn both Dynamic Impulse Trigger & Dynamic Impulse Receiver nodes with the ProtoFlux Tool.
- Add a tag for both nodes to send and listen for. We are using
Example
for both nodes. - Add a Slot hierarchy for the trigger node.
Dynamic Input Variables & Dynamic Spaces
Use this when you have a value that can be grabbed and used anywhere.
What You Need
- The Dynamic Variable Input node. (Must be under a slot with a DynamicVariableSpace)
- A Slot that contains a DynamicVariableSpace.
Setup
- Spawn any Slot to use as your space (the example uses a box), then set up the DynamicVariableSpace component on your slot.
- Pick a name for this space. (The example uses
Example
)
- Pick a name for this space. (The example uses
- Spawn the Dynamic Variable Input node.
- Setup the name for this node. (The example uses
Example/MyBox
)
- Setup the name for this node. (The example uses
- Make a child object of that slot, then add the DynamicValueVariable or DynamicReferenceVariable component. (The exmaple uses DynamicReferenceVariable)
- Setup the name for this component. (The example uses
Example/MyBox
)
- Setup the name for this component. (The example uses
- Pack the Dynamic Variable Input node under the child slot (or anywhere under the slot that has the DynamicVariableSpace), and it should work. (The example uses Red Print to do this.)
Dynamic Field Variables & Dynamic Spaces
Use this when you have component values you want to dynamically use.
What You Need
- Either a DynamicValueVariable or a DynamicReferenceVariable node. (Must be under a slot with a DynamicVariableSpace)
- A Slot that contains a DynamicVariableSpace.
Setup
- To be written...