Component:TouchableTextField: Difference between revisions

From Resonite Wiki
Automated: update component fields
This is no longer a stub. Added a description, added field descriptions, added a usage description.
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=TouchableTextFieldComponent.png
|Image=TouchableTextFieldComponent.png
|Name=Touchable Text Field
|Name=Touchable Text Field
}}
}}
The '''TouchableTextField''' component, similar to a [[Component:TextField|TextField]] for [[UIX]], this component when combined with a [[Component:TextEditor|TextEditor]] on the same [[Slot|slot]], will allow any text in the [[World|world]] to be clicked on to make it become editable.
This allows the text to be edited in both directions: In the component and in the world directly.


<!--T:2-->
<!--T:2-->
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|TextEditor|'''[[Component:TextEditor|TextEditor]]'''|TypeAdv0=true|
|TextEditor|'''[[Component:TextEditor|TextEditor]]'''|TypeAdv0=true| The [[Component:TextField|TextField]] to allow for bi-directional editing.
|AcceptOutOfSightTouch|Bool|
|AcceptOutOfSightTouch|Bool| Allows the user to click and edit while not looking directly at the editable text.
|AcceptPhysicalTouch|Bool|
|AcceptPhysicalTouch|Bool| Allows a user to physically touch on the text.
|AcceptRemoteTouch|Bool|
|AcceptRemoteTouch|Bool| Allows a user to click on the text with the laser.
|EditModeOnly|Bool|
|EditModeOnly|Bool| Allows for the user to only edit this text in [[Edit Mode]].
|ActiveUserRootOnly|Bool|
|ActiveUserRootOnly|Bool| Allows to only be editable when under the active user.
}}
}}


<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
Great for when you don't want to be bound by [[UIX]] to make editable texts.


<!--T:4-->
<!--T:4-->
Line 28: Line 32:
== Related Components ==
== Related Components ==
</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:Components{{#translation:}}|Touchable Text Field]]
[[Category:Components{{#translation:}}|Touchable Text Field]]
[[Category:Components:Common UI:Editors{{#translation:}}|Touchable Text Field]]
[[Category:Components:Common UI:Editors{{#translation:}}|Touchable Text Field]]

Revision as of 23:28, 12 September 2024

Component image 
Touchable Text Field component as seen in the Scene Inspector


The TouchableTextField component, similar to a TextField for UIX, this component when combined with a TextEditor on the same slot, will allow any text in the world to be clicked on to make it become editable.

This allows the text to be edited in both directions: In the component and in the world directly.

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.
TextEditor TextEditor The TextField to allow for bi-directional editing.
AcceptOutOfSightTouch Bool Allows the user to click and edit while not looking directly at the editable text.
AcceptPhysicalTouch Bool Allows a user to physically touch on the text.
AcceptRemoteTouch Bool Allows a user to click on the text with the laser.
EditModeOnly Bool Allows for the user to only edit this text in Edit Mode.
ActiveUserRootOnly Bool Allows to only be editable when under the active user.

Usage

Great for when you don't want to be bound by UIX to make editable texts.

Examples

Related Components