Component:TextEditor

From Resonite Wiki
Revision as of 23:16, 12 September 2024 by AmasterAmaster (talk | contribs) (This is no longer a stub. added a description, added field description, added a usage description.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Component image 
Text Editor component as seen in the Scene Inspector


The TextEditor component takes in a reference to a Text or TextRenderer, and then outputs the result into that reference along with the parameters given and by what actions it should do so.

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.
Text IText The output of where the text is going to be placed at.
Undo Bool If true, the setting of the text is undoable.
UndoDescription String This gets shown on the undo button on the Context menu.
FinishHandling FinishAction Lets the Text editor know what to do when the user leaves a text input.
AutoCaretColorField Bool Automatically sets the color of the caret (based on text color).
CaretColorField ColorX Sets the caret color.
SelectionColorField ColorX Sets the selection color for this caret.
EditingStarted Action`1<TextEditor> Gives the TextEditor an action when the editing has started.
EditingChanged Action`1<TextEditor> Gives the TextEditor an action when the editing has changed.
EditingFinished Action`1<TextEditor> Gives the TextEditor an action when the editing has finished.
SubmitPressed Action`1<TextEditor> Gives the TextEditor an action when the editing has been submitted.

Usage

This component is used in many places, including:

Examples

Related Components