Component:ButtonStringAppend: Difference between revisions

From Resonite Wiki
m ProbablePrime moved page ButtonStringAppend (Component) to Component:ButtonStringAppend: Creating component Namespace
Automated: update component fields
Line 13: Line 13:
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|TargetString|IField`1|TypeString0=IField<string>| The string to which <code>AppendString</code> will be added.
|TargetString|'''[[Type:IField`1|IField`1]]&lt;[[Type:String|String]]&gt;'''|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>.)

Revision as of 10:39, 1 March 2024


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


Component image 
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`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.

Examples

Related Components