Automated: update Fields |
add last info for now |
||
(One intermediate revision by one other user not shown) | |||
Line 4: | Line 4: | ||
{{stub}} | {{stub}} | ||
[[File:Hyperlink Component.webp|thumb|The Hyperlink as seen in the [[Scene Inspector]]]] | [[File:Hyperlink Component.webp|thumb|The Hyperlink as seen in the [[Scene Inspector]]]] | ||
The '''Hyperlink''' component allows you to turn an object with a collider into a clickable link that will prompt the user in [[Userspace]] to open the provided link in their web browser. | The '''Hyperlink''' component allows you to turn an object with a collider into a clickable link that will prompt the user in [[Userspace]] to open the provided link in their default web browser. | ||
{{Note|This component requires the start to contain <code>http://</code>, <code>ws://</code>, or something similar at the beginning of the URL, or this component will not prompt for a connection. | |||
Example for connecting to the local host of the device: <code>http://localhost:5000</code>|warning}} | |||
<!--T:2--> | <!--T:2--> | ||
Line 10: | Line 14: | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|URL|Uri|The hyperlink to open. | |URL|Uri|The hyperlink to open. | ||
|OpenOnce|Bool| | |OpenOnce|Bool| Prevents the user from clicking on the URL more than once and bringing up multiple confirmation dialouges | ||
|Reason|String|The reason that the hyperlink is being opened. Displayed to the user when they click it in the security dialog. | |Reason|String|The reason that the hyperlink is being opened. Displayed to the user when they click it in the security dialog. | ||
}} | }} | ||
Line 16: | Line 20: | ||
<!--T:3--> | <!--T:3--> | ||
== Usage == | == Usage == | ||
It can be triggered or activated in the following ways: | |||
* Using a collider and physically touching the object to prompt for a connection. | |||
* Attaching a [[UIX]] [[Component:Button|button]] component along with this component on the same [[Slot|slot]], then clicking on the UIX button will prompt for a connection. | |||
<!--T:4--> | <!--T:4--> | ||
Line 23: | Line 30: | ||
== Related Components == | == Related Components == | ||
</translate> | </translate> | ||
[[Category:Components{{#translation:}}|Hyperlink]] | [[Category:Components{{#translation:}}|Hyperlink]] | ||
[[Category:Components:Utility{{#translation:}}|Hyperlink]] | [[Category:Components:Utility{{#translation:}}|Hyperlink]] |
Latest revision as of 13:39, 20 October 2024
This article or section is a Stub. You can help the Resonite Wiki by expanding it.
The Hyperlink component allows you to turn an object with a collider into a clickable link that will prompt the user in Userspace to open the provided link in their default web browser.
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. |
URL
|
Uri | The hyperlink to open. |
OpenOnce
|
Bool | Prevents the user from clicking on the URL more than once and bringing up multiple confirmation dialouges |
Reason
|
String | The reason that the hyperlink is being opened. Displayed to the user when they click it in the security dialog. |
Usage
It can be triggered or activated in the following ways: