ProtoFlux:Begin Undo Batch: Difference between revisions

From Resonite Wiki
m typoo
Fixing typos, spelling, and grammer in some places.
 
(9 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{#Invoke:ProtoFlux|GenerateUI
{{#Invoke:ProtoFlux|GenerateUI
|Name=ProtoFlux Node
|Name=Begin Undo Batch
|Category=Wiki
|Category=Undo
|Inputs=
|Inputs=
[
[
{"Name":"Input", "Type":"Impulse"},
{"Name":"*", "Type":"Call"},
{"Name":"Description", "Type":"String"}
{"Name":"Description", "Type":"String"}
]
]
|Outputs=
|Outputs=
[
[
{"Name":"Output", "Type":"Continuation"}
{"Name":"Next", "Type":"Continuation"}
]
]
|}}
|}}


A begin undo batch is used to batch together every undo step called after it, like [[ProtoFlux:Create Undo Spawn Step|Create Undo Spawn Step]], [[ProtoFlux:Create Undo Field Step|Create Undo Field Step]], and [[ProtoFlux:Create Undo Reference Step|Create Undo Spawn Step]] to name a few from the [[:Category:ProtoFlux:Undo| ProtoFlux Undoable Category]].
A begin undo batch is used to batch together every undo step called after it, like [[ProtoFlux:Create Spawn Undo Step|Create Spawn Undo Step]], [[ProtoFlux:Create Field Undo Step|Create Field Undo Step]], and [[ProtoFlux:Create Reference Undo Step|Create Undo Reference Step]] to name a few from the [[:Category:ProtoFlux:Undo| ProtoFlux Undoable Category]].


The node will create an undo step in the context menu of the person who the impulse came from.
The node will create an undo step in the context menu of the person who the impulse came from.


This then needs to be ended with a [[ProtoFlux:End Undo Batch|End Undo Batch]], to batch together every undo step call after this node and before the undo batch. Other nodes than just undo steps can be put between the begin and end undo batch nodes, but is not recommended.
This node needs to be ended with a [[ProtoFlux:End Undo Batch|End Undo Batch]], to batch together every undo step call after this node and before the end undo batch node. The other nodes undo steps can be put between the begin and end undo batch nodes, but is not recommended.


The undo step descriptions between these nodes will be ignored.
The undo step descriptions between these nodes will be ignored.
Line 24: Line 24:
== Inputs ==
== Inputs ==


=== Input (Call) ===  
=== Input ([[Impulses|Call]]) ===  
Start the undo batch.
Start the undo batch.


=== Description ([[Type:String|String]]) ===
=== Description ([[Type:String|String]]) ===
The description for this undo batch. The description will be automatically prepended with "Undo" in bigger text in the context menu.
 
The description for this undo batch. The description will be automatically prepended with "Undo" in bigger text in the context menu.


== Outputs ==
== Outputs ==


=== Output (Continuation) ===
=== Output ([[Impulses|Continuation]]) ===
The undo steps to batch with this undo batch followed by an [[ProtoFlux:End Undo Batch|End Undo Batch]].
The undo steps to batch with this undo batch followed by an [[ProtoFlux:End Undo Batch|End Undo Batch]].


== Examples ==
== Examples ==


{{Stub}}
<gallery widths=480px heights=480px>
File:ProtoFlux_example_undo_node_settup|This node being used in a set of nodes that undoes a bunch of actions that was done by a previous button
</gallery>


<nowiki>
[[Category:ProtoFlux:Undo]]
[[Category:ProtoFlux:Position:In:Node:Picker]]
</nowiki>

Latest revision as of 21:15, 15 April 2024

Begin Undo Batch
*
Next
Description
Undo

A begin undo batch is used to batch together every undo step called after it, like Create Spawn Undo Step, Create Field Undo Step, and Create Undo Reference Step to name a few from the ProtoFlux Undoable Category.

The node will create an undo step in the context menu of the person who the impulse came from.

This node needs to be ended with a End Undo Batch, to batch together every undo step call after this node and before the end undo batch node. The other nodes undo steps can be put between the begin and end undo batch nodes, but is not recommended.

The undo step descriptions between these nodes will be ignored.


Inputs

Input (Call)

Start the undo batch.

Description (String)

The description for this undo batch. The description will be automatically prepended with "Undo" in bigger text in the context menu.

Outputs

Output (Continuation)

The undo steps to batch with this undo batch followed by an End Undo Batch.

Examples