Difference between revisions of "ButtonStringErase (Component)"
Jump to navigation
Jump to search
Mysticporo (talk | contribs) (Created page with "<languages></languages> <translate> <!--T:1--> {{stub}} {{Infobox Component |Image=ButtonStringEraseComponent.png |Name=Button String Erase }} <!--T:2--> == Fields == {{Table...") |
(Wrote article.) |
||
Line 7: | Line 7: | ||
|Name=Button String Erase | |Name=Button String Erase | ||
}} | }} | ||
+ | |||
+ | The ButtonStringErase component can be used to remove characters from the beginning or end of a string whenever a button is pressed. | ||
<!--T:2--> | <!--T:2--> | ||
== Fields == | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
− | |TargetString|IField`1|TypeString0=IField<string>| | + | |TargetString|IField`1|TypeString0=IField<string>| The string from which characters will be removed. |
− | |Count|Int| | + | |Count|Int| How many characters to remove. |
− | |EraseFromBeginning|Bool| | + | |EraseFromBeginning|Bool| Whether or not to remove characters from the beginning of the string. |
}} | }} | ||
<!--T:3--> | <!--T:3--> | ||
== Usage == | == 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 ButtonStringErade, making it erase the first or last <code>Count</code> characters from its <code>TargetString</code>. | ||
<!--T:4--> | <!--T:4--> |
Latest revision as of 09:23, 27 December 2021
This article or section is a Stub. You can help the Neos Wiki by expanding it.
The ButtonStringErase component can be used to remove characters from the beginning or end of a string whenever a button 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<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 ButtonStringErade, making it erase the first or last Count
characters from its TargetString
.