Added instructions for handling variant type nodes |
fix error |
||
| (16 intermediate revisions by 3 users not shown) | |||
| Line 4: | Line 4: | ||
|Inputs= | |Inputs= | ||
[ | [ | ||
{"Name":"Input", "Type":" | {"Name":"Input", "Type":"Call"}, | ||
{"Name":"Dummy", "Type":"Dummy"} | {"Name":"Dummy", "Type":"Dummy"}, | ||
{"Name":"Multi", "Multi": 4, "Type":"float"} | |||
] | ] | ||
|Outputs= | |Outputs= | ||
| Line 17: | Line 18: | ||
|}} | |}} | ||
: | {{Template:Note|This page is meant for wiki editors to have a standard, this node doesn't actually exists in Resonite; instead look at [[:Category:ProtoFlux | the ProtoFlux category]] for documentation!|warning}} | ||
This page shows an example of a [[ProtoFlux]] node page. Do not hesitate to look at the source of this page and use it as a template. If using this page as a template, you will need to remove the tags <code><nowiki><nowiki></nowiki></nowiki></code> around the category part at the bottom. | This page shows an example of a [[ProtoFlux]] node page. Do not hesitate to look at the source of this page and use it as a template. If using this page as a template, you will need to remove the tags <code><nowiki><nowiki></nowiki></nowiki></code> around the category part at the bottom. | ||
| Line 23: | Line 24: | ||
ProtoFlux node pages are using the [[Module:ProtoFlux | ProtoFlux module]] to generate the visuals. | ProtoFlux node pages are using the [[Module:ProtoFlux | ProtoFlux module]] to generate the visuals. | ||
When a new page for a node is created, the name of the wiki page needs to follow <code>I Am A Flux Node | When a new page for a node is created, the name of the wiki page needs to follow <code>ProtoFlux:I Am A Flux Node</code>. In this example, the node would appear as <code>IAmAFluxNode</code> in the ProtoFlux node browser. | ||
Currently, the system in place for dealing with nodes that can have a select few different inputs/outputs | |||
Currently, the system in place for dealing with nodes that can have a select few different inputs/outputs is to label the connector in the page with a "Pseudo-Generic" type. Then give the [[Module:ProtoFlux | ProtoFlux module]] on the page the type "Dummy" like on this page. Lastly list or describe the types it can take. | |||
{{Template:Note|If the colors on the node UI look wrong, then your type is spelled incorrectly. You can take a look at [[Module:ProtoFlux_Type_Color#Examples | Type Color Examples]] for a list of types and colors. Asking the discord or looking at other pages on how to spell it is fine.|warning}} | |||
If the node has an input/output that takes any type, give the [[Module:ProtoFlux | ProtoFlux module]] on the page the type "Dummy" like on this page. Then label the connector on the page with a "Generic" type. | If the node has an input/output that takes any type, give the [[Module:ProtoFlux | ProtoFlux module]] on the page the type "Dummy" like on this page. Then label the connector on the page with a "Generic" type. | ||
If a Non generic type is used for an input, please link it like the Woah Globals section title below | |||
Please remember, <nowiki>[[Type:ValueNameHere|ValueNameHere]]</nowiki> not <nowiki>[[Types:ValueNameHere|ValueNameHere]]</nowiki> | |||
When making examples, please use [[User:Colin_The_Cat/FluxShot|FluxShot]] to make your example images. | |||
With nodes that have a set number of different types, please add a section like this: | |||
This node has the following variants, with their respective outputs: | |||
== Variants == | |||
{| class="wikitable" | |||
! Variant !! Node Type !! some condition here !! another condition here | |||
|- | |||
|Example ProtoFlux Node ([[Types:Float|float]]) || <code>Example ProtoFlux Node Float</code>|| 99.69 || 8.420 | |||
|- | |||
|Example ProtoFlux Node ([[Types:Int|int]]) || <code>Example ProtoFlux Node Int</code>|| 88 || 6 | |||
|- | |||
|} | |||
== Inputs == | == Inputs == | ||
=== Input === | === Input ([[Impulses|Call]]) === | ||
This is the description for the input. | This is the description for the input. | ||
=== Dummy (Pseudo-Generic) === | |||
I am an input that has X done to it. | |||
<br>Example inputs: type1, type2, type 5,000,000,000 | |||
== Outputs == | == Outputs == | ||
=== Output === | === Output ([[Impulses|Continuation]]) === | ||
This is the description for the output. | This is the description for the output. | ||
| Line 44: | Line 71: | ||
== Globals == | == Globals == | ||
=== Woah Globals === | === Woah Globals ([[Type:User|User]]) === | ||
This is the description of the global. | This is the description of the global. | ||
| Line 51: | Line 78: | ||
Put example pics here in a gallery. | Put example pics here in a gallery. | ||
<gallery widths=480px heights=480px> | |||
File:Protoflux_example_to_string.webp|Description for an image. (from another page that doesn't actually belong here) | |||
File:Protoflux_example_to_string.webp|Description for image 2. (from another page that doesn't actually belong here) | |||
</gallery> | |||
<nowiki> | <nowiki> | ||
[[Category:ProtoFlux:Position:In:Node:Picker]] | [[Category:ProtoFlux:Position:In:Node:Picker]] | ||
</nowiki> | </nowiki> | ||
Latest revision as of 17:28, 17 February 2024
This page shows an example of a ProtoFlux node page. Do not hesitate to look at the source of this page and use it as a template. If using this page as a template, you will need to remove the tags <nowiki></nowiki> around the category part at the bottom.
ProtoFlux node pages are using the ProtoFlux module to generate the visuals.
When a new page for a node is created, the name of the wiki page needs to follow ProtoFlux:I Am A Flux Node. In this example, the node would appear as IAmAFluxNode in the ProtoFlux node browser.
Currently, the system in place for dealing with nodes that can have a select few different inputs/outputs is to label the connector in the page with a "Pseudo-Generic" type. Then give the ProtoFlux module on the page the type "Dummy" like on this page. Lastly list or describe the types it can take.
If the node has an input/output that takes any type, give the ProtoFlux module on the page the type "Dummy" like on this page. Then label the connector on the page with a "Generic" type.
If a Non generic type is used for an input, please link it like the Woah Globals section title below Please remember, [[Type:ValueNameHere|ValueNameHere]] not [[Types:ValueNameHere|ValueNameHere]]
When making examples, please use FluxShot to make your example images.
With nodes that have a set number of different types, please add a section like this:
This node has the following variants, with their respective outputs:
Variants
| Variant | Node Type | some condition here | another condition here |
|---|---|---|---|
| Example ProtoFlux Node (float) | Example ProtoFlux Node Float |
99.69 | 8.420 |
| Example ProtoFlux Node (int) | Example ProtoFlux Node Int |
88 | 6 |
Inputs
Input (Call)
This is the description for the input.
Dummy (Pseudo-Generic)
I am an input that has X done to it.
Example inputs: type1, type2, type 5,000,000,000
Outputs
Output (Continuation)
This is the description for the output.
Globals
Woah Globals (User)
This is the description of the global.
Examples
Put example pics here in a gallery.
-
Description for an image. (from another page that doesn't actually belong here) -
Description for image 2. (from another page that doesn't actually belong here)
[[Category:ProtoFlux:Position:In:Node:Picker]]