Component:ButtonStringErase

From Resonite Wiki
Revision as of 00:04, 12 September 2024 by AmasterAmaster (talk | contribs) (This is no longer a stub. Style. Updated descriptions. Added links.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Component image 
Button String Erase component as seen in the Scene Inspector


The ButtonStringErase component can be used to remove characters from the beginning or end of a string whenever an IButton is pressed.

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.
TargetString IField`1<String> The string from which characters will be removed.
Count Int How many characters to remove.
EraseFromBeginning Bool Whether or not to remove characters from the beginning of the string.

Usage

To function, the component simply needs to be attached to a slot that also has a button component attached to it. From then on, pressing that button will activate the ButtonStringErase, making it erase the first or last Count characters from its TargetString.

Examples

Related Components