Component:BatchAction: Difference between revisions

From Resonite Wiki
imported>AshtonSparx
 
Add info, no longer stub
 
(One intermediate revision by one other user not shown)
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=BatchActionComponent.png
|Image=BatchActionComponent.png
|Name=Batch Action
|Name=Batch Action
}}
}}
Batch action is a component that is used internally by the [[Undo]] Manager to handle keeping data that the user has done so that same user can Undo it later via the control menu(s).


<!--T:2-->
<!--T:2-->
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|_description|String|
|_description|String| a short description of what this group of items is undoing. Can be filled automatically with custom content when generated by a begin and end Undo Batch protoflux node
}}
}}


Line 21: Line 21:


== Examples ==
== Examples ==
This component can be generated in the Undo Manager when doing certain actions, or when a [[ProtoFlux:End Undo Batch|End Undo Batch ProtoFlux node]] is used successfully for a user.


<!--T:5-->
<!--T:5-->
== Related Components ==
== Related Components  
</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:Components{{#translation:}}|Batch Action]]
[[Category:Components{{#translation:}}|Batch Action]]
[[Category:Components:Uncategorized{{#translation:}}|Batch Action]]
[[Category:Components:Uncategorized{{#translation:}}|Batch Action]]

Latest revision as of 12:37, 16 October 2024

Component image 
Batch Action component as seen in the Scene Inspector

Batch action is a component that is used internally by the Undo Manager to handle keeping data that the user has done so that same user can Undo it later via the control menu(s).

Fields

Fields
Name Type Description
persistent Bool Determines whether or not this item will be saved to the server.
UpdateOrder Int Controls the order in which this component is updated.
Enabled Bool Controls whether or not this component is enabled.
_description String a short description of what this group of items is undoing. Can be filled automatically with custom content when generated by a begin and end Undo Batch protoflux node

Usage

Used for User group Undo Steps

Examples

This component can be generated in the Undo Manager when doing certain actions, or when a End Undo Batch ProtoFlux node is used successfully for a user.

== Related Components