Component:TextDisplayInterface: Difference between revisions

From Resonite Wiki
add template
add info
 
Line 3: Line 3:
|Name=Text Display Interface
|Name=Text Display Interface
}}
}}
{{stub}}
The '''TextDisplayInterface''' component is used to specify what the user's favorite display of clipboard contents should be when pasting text not into a text field and the text is not a link.


== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|ItemName|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv0=true|
|ItemName|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv0=true| The name of this favoritable item.
|SpawningUser|UserRef|
|SpawningUser|UserRef| The user that spawned this favoritable item.
|SpawningUserID|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv2=true|
|SpawningUserID|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv2=true| The field containing the ID of the user that spawned this favoritable item.
|IsInstance|Bool|
|IsInstance|Bool| Whether this item was spawned by the player (false) or was spawned by the game as part of the favorites system (true).
|Heading|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv4=true|
|Heading|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv4=true| The field to fill with what the header text is upon spawn.
|Text|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv5=true|
|Text|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv5=true| The field to fill with what the text the user pasted was upon spawn.
|RTF|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv6=true|
|RTF|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv6=true| The field to fill with whether the text should be interpreted as Rich Text Format. This is usually the RTF field on a text rendering Component for the UI.
}}
}}


== Usage ==
== Usage ==
Spawn the default resonite one from resonite essentials and edit it, or attach a new one and create a UI for it yourself. Once done, save to your inventory and set as your text display to make it your active one.


== Examples ==
== Examples ==
The default Resonite text display in Resonite Essentials.


== See Also ==
== See Also ==
Line 25: Line 27:
[[Category:Components:Utility:Entity Interfaces{{#translation:}}|Text Display Interface]]
[[Category:Components:Utility:Entity Interfaces{{#translation:}}|Text Display Interface]]
[[Category:Components{{#translation:}}|Text Display Interface]]
[[Category:Components{{#translation:}}|Text Display Interface]]
[[Category:ComponentStubs]]

Latest revision as of 17:53, 4 February 2025

Component image 
Text Display Interface component as seen in the Scene Inspector

The TextDisplayInterface component is used to specify what the user's favorite display of clipboard contents should be when pasting text not into a text field and the text is not a link.

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. Some components stop their functionality when this field is disabled, but some don't.
ItemName IField`1<String> The name of this favoritable item.
SpawningUser UserRef The user that spawned this favoritable item.
SpawningUserID IField`1<String> The field containing the ID of the user that spawned this favoritable item.
IsInstance Bool Whether this item was spawned by the player (false) or was spawned by the game as part of the favorites system (true).
Heading IField`1<String> The field to fill with what the header text is upon spawn.
Text IField`1<String> The field to fill with what the text the user pasted was upon spawn.
RTF IField`1<Bool> The field to fill with whether the text should be interpreted as Rich Text Format. This is usually the RTF field on a text rendering Component for the UI.

Usage

Spawn the default resonite one from resonite essentials and edit it, or attach a new one and create a UI for it yourself. Once done, save to your inventory and set as your text display to make it your active one.

Examples

The default Resonite text display in Resonite Essentials.

See Also