Component:AvatarAnchorTouchTrigger: Difference between revisions

From Resonite Wiki
m ProbablePrime moved page AvatarAnchorTouchTrigger (Component) to Component:AvatarAnchorTouchTrigger: Creating component Namespace
add info
 
(One intermediate revision by one other user not shown)
Line 7: Line 7:
|Name=AvatarAnchorTouchTrigger
|Name=AvatarAnchorTouchTrigger
}}
}}
 
Used often for a way of entering and exiting an [[Component:AvatarAnchor|Avatar Anchor]] when the user wants to.
<!--T:2-->
== Intoduction ==


<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|Anchor|AvatarAnchor|  
|Anchor|'''[[Component:AvatarAnchor|AvatarAnchor]]'''|TypeAdv0=true| The anchor to enter after confirming the enter anchor.
|EnterText|String|  
|EnterText|String| The text for when the user is being prompted to enter the anchor.
|ExitText|String|  
|ExitText|String| The text for when the user is being prompted to exit the anchor.
|Enter|Bool|  
|Enter|Bool| Whether to allow this component to be used for entering the anchor.
|Exit|Bool|  
|Exit|Bool| Whether to allow this component to be used for exiting the anchor.
|AcceptOutOfSightTouch|Bool|  
|AcceptOutOfSightTouch|Bool| Wether to allow the user to click outside of their view and still bring up the prompt for entering or exiting.
|AcceptPhysicalTouch|Bool|  
|AcceptPhysicalTouch|Bool| Allow the user to use a tip touch source like the tip of their finger to bring up the enter or exiting prompt.
|AcceptRemoteTouch|Bool|  
|AcceptRemoteTouch|Bool| Allow the user to use their laser to bring up the enter or exiting prompt.
|Vibrate|VibratePreset|  
|Vibrate|VibratePreset| What kind of haptics vibration feedback to send to the user's controller when bringing up the enter or exiting prompt.
}}
}}


<!--T:4-->
<!--T:4-->
== Behavior ==
== Behavior ==
This needs a collider on the same slot to allow for clicking and bringing up the prompt. The <code>EnterText</code> and <code>ExitText</code> fields are usually driven by a component. The component automatically translates the dialogues for them in their context menu to their selected locale language.


<!--T:5-->
<!--T:5-->
Line 33: Line 32:
<!--T:6-->
<!--T:6-->
== Related Components ==
== Related Components ==
[[Component:AvatarAnchor|Avatar Anchor]]
</translate>
</translate>
[[Category:Components{{#translation:}}|AvatarAnchorTouchTrigger (Component){{#translation:}}]]
[[Category:Components{{#translation:}}|Avatar Anchor Touch Trigger]]
[[Category:ComponentStubs]]
[[Category:Components:Users:Common Avatar System:Anchors{{#translation:}}|Avatar Anchor Touch Trigger]]
[[Category:Components:Users:Common Avatar System:Anchors{{#translation:}}|AvatarAnchorTouchTrigger (Component){{#translation:}}]]

Latest revision as of 22:57, 24 October 2024


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


Component image 
AvatarAnchorTouchTrigger component as seen in the Scene Inspector

Used often for a way of entering and exiting an Avatar Anchor when the user wants to.

Usage

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.
Anchor AvatarAnchor The anchor to enter after confirming the enter anchor.
EnterText String The text for when the user is being prompted to enter the anchor.
ExitText String The text for when the user is being prompted to exit the anchor.
Enter Bool Whether to allow this component to be used for entering the anchor.
Exit Bool Whether to allow this component to be used for exiting the anchor.
AcceptOutOfSightTouch Bool Wether to allow the user to click outside of their view and still bring up the prompt for entering or exiting.
AcceptPhysicalTouch Bool Allow the user to use a tip touch source like the tip of their finger to bring up the enter or exiting prompt.
AcceptRemoteTouch Bool Allow the user to use their laser to bring up the enter or exiting prompt.
Vibrate VibratePreset What kind of haptics vibration feedback to send to the user's controller when bringing up the enter or exiting prompt.

Behavior

This needs a collider on the same slot to allow for clicking and bringing up the prompt. The EnterText and ExitText fields are usually driven by a component. The component automatically translates the dialogues for them in their context menu to their selected locale language.

Examples

Related Components

Avatar Anchor