add last info for now |
reformat, explain sync delegate, fix info box |
||
(2 intermediate revisions by the same user not shown) | |||
Line 2: | Line 2: | ||
<translate> | <translate> | ||
<!--T:1--> | <!--T:1--> | ||
{{ | {{Infobox Component | ||
|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 16: | Line 18: | ||
|OpenOnce|Bool| Prevents the user from clicking on the URL more than once and bringing up multiple confirmation dialouges | |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]]| When called, this function will bring up the confirmation dialogue for the user that is executing the function (local user). | |||
}} | }} | ||
Line 26: | Line 33: | ||
<!--T:4--> | <!--T:4--> | ||
== Examples == | == Examples == | ||
{{stub}} | |||
<!--T:5--> | <!--T:5--> | ||
== | == See Also == | ||
</translate> | </translate> | ||
[[Category:Components:Utility{{#translation:}}|Hyperlink]] | [[Category:Components:Utility{{#translation:}}|Hyperlink]] |
Latest revision as of 18:06, 13 November 2024
Component image
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. |
Sync Delegates
Method Name | Method type and Arguments. | Description |
---|---|---|
Open()
|
Func`1 | When called, this function will bring up the confirmation dialogue for the user that is executing the function (local user). |
Usage
It can be triggered or activated in the following ways:
Examples
This article or section is a Stub. You can help the Resonite Wiki by expanding it.