Component:HyperlinkDisplayInterface: Difference between revisions

Latest revision as of 20:20, 20 January 2025

Component image

**Hyperlink Display Interface** component as seen in the Scene Inspector

The HyperlinkDisplayInterface component is spawned by the favorites system when a user pastes a link that is recognized as a website link rather than a specific media type.

See Favorites on favoritable items like this one.

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 is an instance.
`Url`	IField`1<Uri>	The field to fill with the URL this hyperlink display should leas to.
`UrlString`	IField`1<String>	The field to fill with the URL as a string so the hyperlink display can show what it leads to.

Usage

This component can be made part of a UI that can be modified and favorited to become the user's default hyperlink spawning UI.

Examples

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

needs an image of the default spawned link that spawns when users paste website links.

@@ Line 3: / Line 3: @@
 |Name=Hyperlink Display Interface
 }}
-{{stub}}
+The '''HyperlinkDisplayInterface''' component is spawned by the favorites system when a user pastes a link that is recognized as a website link rather than a specific media type.
-This Entity Interface allows users to set a custom URL display.
+See [[Favorites]] on favoritable items like this one.
-== Usage ==
+== Fields ==
 {{Table ComponentFields
-|ItemName|'''[[Type:IField`1|IField`1]]&lt;[[Type:String|String]]&gt;'''|TypeAdv0=true|
+|ItemName|'''[[Type:IField`1|IField`1]]&lt;[[Type:String|String]]&gt;'''|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]]&lt;[[Type:String|String]]&gt;'''|TypeAdv2=true|
+|SpawningUserID|'''[[Type:IField`1|IField`1]]&lt;[[Type:String|String]]&gt;'''|TypeAdv2=true| The field containing the ID of the user that spawned this favoritable item.
-|IsInstance|Bool|
+|IsInstance|Bool| Whether this item is an instance.
-|Url|'''[[Type:IField`1|IField`1]]&lt;[[Type:Uri|Uri]]&gt;'''|TypeAdv4=true|
+|Url|'''[[Type:IField`1|IField`1]]&lt;[[Type:Uri|Uri]]&gt;'''|TypeAdv4=true| The field to fill with the URL this hyperlink display should leas to.
-|UrlString|'''[[Type:IField`1|IField`1]]&lt;[[Type:String|String]]&gt;'''|TypeAdv5=true|
+|UrlString|'''[[Type:IField`1|IField`1]]&lt;[[Type:String|String]]&gt;'''|TypeAdv5=true| The field to fill with the URL as a string so the hyperlink display can show what it leads to.
 }}
-== Behavior ==
+== Usage ==
+This component can be made part of a UI that can be modified and favorited to become the user's default hyperlink spawning UI.
 == Examples ==
+{{stub}}
+* needs an image of the default spawned link that spawns when users paste website links.
 == See Also ==
+{{Template:EntityInterface SeeAlso}}
 [[Category:Components:Utility:Entity Interfaces{{#translation:}}|Hyperlink Display Interface]]
 [[Category:Components{{#translation:}}|Hyperlink Display Interface]]
-[[Category:ComponentStubs]]