Component:ContactLink: Difference between revisions

From Resonite Wiki
m ProbablePrime moved page FriendLink (Component) to Component:FriendLink: Creating component Namespace
fix bad Category tag and clean up
 
(9 intermediate revisions by 5 users not shown)
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=FriendLinkComponent.png
|Image=ContactLinkComponent.png
|Name=Friend Link
|Name=Contact Link
}}
}}
The '''ContactLink''' component allows a [[Slot|slot]] to be clicked on by a [[User|user]] to open their [[Dash Menu]] to the [[Contacts Menu]] of a specific user (by using a provided <code>UserId</code>).


<!--T:2-->
<!--T:2-->
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|UserId|String|
|UserId|String|The [[User_ID|User ID]] of the User whose contact page will be opened upon clicking the object.
}}
}}


<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
Add the ContactLink component to an object, clicking on that object will open up the [[Contacts Menu]] and will show the User page of the user defined in the <code>UserId</code> field. When you attach it, your own [[User ID]] will be automatically filled in.


<!--T:4-->
<!--T:4-->
== Examples ==
== Examples ==
This is the component that allows Users to click on the [[Nameplate]] of another user and open their contact page quickly. You can find an example on by selecting your own nameplate and viewing the components


<!--T:5-->
<!--T:5-->
== Related Components ==
== See Also ==
On the default nameplate, a [[Component:AvatarNameTagAssigner|AvatarNameTagAssigner]] is set up to write the current user's [[User ID]] to the ContactLink UserId field.
 
</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:Components{{#translation:}}|Contact Link]]
[[Category:Components{{#translation:}}|Friend Link]]
[[Category:Components:Cloud{{#translation:}}|Contact Link]]
[[Category:Components:Cloud{{#translation:}}|Friend Link]]

Latest revision as of 00:56, 23 December 2024

Component image 
Contact Link component as seen in the Scene Inspector


The ContactLink component allows a slot to be clicked on by a user to open their Dash Menu to the Contacts Menu of a specific user (by using a provided UserId).

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.
UserId String The User ID of the User whose contact page will be opened upon clicking the object.

Usage

Add the ContactLink component to an object, clicking on that object will open up the Contacts Menu and will show the User page of the user defined in the UserId field. When you attach it, your own User ID will be automatically filled in.

Examples

This is the component that allows Users to click on the Nameplate of another user and open their contact page quickly. You can find an example on by selecting your own nameplate and viewing the components

See Also

On the default nameplate, a AvatarNameTagAssigner is set up to write the current user's User ID to the ContactLink UserId field.