Added usage information for the hyperlink component. Added important note about this component when trying to connect while using it. Updated description noting that it is going to open in the user's defualt web browser of choice.
[[File:Hyperlink Component.webp|thumb|The Hyperlink as seen in the [[Scene Inspector]]]]
|Image=Hyperlink Component.webp
|Name=Hyperlink
}}
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.
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.
Line 14:
Line 16:
{{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.
}}
== Sync Delegates ==
{{Table ComponentTriggers
|Open:[[Type:Func`1|Func`1]]<[[Type:Bool|Bool]]>|[[Type:Func`1|Func`1]]<[[Type:Bool|Bool]]>|false| When called, this function will bring up the confirmation dialogue for the user that is executing the function (local user).
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.
This component requires the start to contain http://, ws://, or something similar at the beginning of the URL, or this component will not prompt for a connection.