Difference between revisions of "ButtonStringAppend (Component)"

From Neos Wiki
Jump to navigation Jump to search
(Created page with "<languages></languages> <translate> <!--T:1--> {{stub}} {{Infobox Component |Image=ButtonStringAppendComponent.png |Name=Button String Append }} <!--T:2--> == Fields == {{Tab...")
 
(Wrote article.)
 
Line 7: Line 7:
 
|Name=Button String Append
 
|Name=Button String Append
 
}}
 
}}
 +
 +
The ButtonStringAppend component can be used to add a string to 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 to which <code>AppendString</code> will be added.
|AppendString|String|
+
|AppendString|String| The string to add to <code>TargetString</code>.
|AppendInFront|Bool|
+
|AppendInFront|Bool| Whether or not to add <code>AppendString</code> to the beginning of the string. (This does not reverse <code>AppendString</code>.)
 
}}
 
}}
  
 
<!--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>.
  
 
<!--T:4-->
 
<!--T:4-->

Latest revision as of 11:12, 27 December 2021


This article or section is a Stub. You can help the Neos Wiki by expanding it.


Button String Append component as seen in the Scene Inspector

The ButtonStringAppend component can be used to add a string to 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 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.

Examples

Related Components