m ProbablePrime moved page ButtonStringAppend (Component) to Component:ButtonStringAppend: Creating component Namespace |
This is no longer a stub. Updated descriptions, added links. |
||
(One intermediate revision by one other user not shown) | |||
Line 2: | Line 2: | ||
<translate> | <translate> | ||
<!--T:1--> | <!--T:1--> | ||
{{Infobox Component | {{Infobox Component | ||
|Image=ButtonStringAppendComponent.png | |Image=ButtonStringAppendComponent.png | ||
Line 8: | Line 7: | ||
}} | }} | ||
The ButtonStringAppend component can be used to add a string to the beginning or end of a string whenever | The '''ButtonStringAppend''' component can be used to add a [[Type:string|string]] to the beginning or end of a string whenever an [[Type:IButton|IButton]] is pressed. | ||
<!--T:2--> | <!--T:2--> | ||
== Fields == | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|TargetString|IField`1| | |TargetString|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv0=true| The string to which <code>AppendString</code> will be added. | ||
|AppendString|String| The string to add to <code>TargetString</code>. | |AppendString|String| The string to add to <code>TargetString</code>. | ||
|AppendInFront|Bool| Whether or not to add <code>AppendString</code> to the beginning of the string. (This does not reverse <code>AppendString</code>.) | |AppendInFront|Bool| Whether or not to add <code>AppendString</code> to the beginning of the string. (This does not reverse <code>AppendString</code>.) | ||
Line 20: | Line 19: | ||
<!--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 ButtonStringAppend, making it append its <code>AppendString</code> to its <code>TargetString</code>. | To function, the component simply needs to be attached to a [[Slot|slot]] that also has a button component attached to it. From then on, pressing that button will activate the '''ButtonStringAppend''', making it append its <code>AppendString</code> to its <code>TargetString</code>. | ||
<!--T:4--> | <!--T:4--> | ||
Line 28: | Line 27: | ||
== Related Components == | == Related Components == | ||
</translate> | </translate> | ||
[[Category:Components{{#translation:}}|Button String Append]] | [[Category:Components{{#translation:}}|Button String Append]] | ||
[[Category:Components:Common UI:Button Interactions{{#translation:}}|Button String Append]] | [[Category:Components:Common UI:Button Interactions{{#translation:}}|Button String Append]] |
Latest revision as of 23:55, 11 September 2024
Component image
The ButtonStringAppend component can be used to add a string to the beginning or end of a string whenever an IButton is pressed.
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 to which AppendString will be added.
|
AppendString
|
String | The string to add to TargetString .
|
AppendInFront
|
Bool | Whether or not to add AppendString to the beginning of the string. (This does not reverse AppendString .)
|
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 ButtonStringAppend, making it append its AppendString
to its TargetString
.