Component:PointerInteractionController: Difference between revisions

Latest revision as of 21:32, 7 April 2025

Component image

File:PointerInteractionControllerComponent.png

Pointer Interaction Controller component as seen in the Scene Inspector

The PointerInteractionController component is used by the game internally to handle tip touch source behavior on a user.

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. Some components stop their functionality when this field is disabled, but some don't.

Sync Delegates

Triggers
Method Name	Method type and Arguments.	Is the method hidden?	Description
GetTipPosition:Func`2<RelayTouchSource, Float3>	Func`2<RelayTouchSource, Float3>	✓	Can be called to get where the tip position of the pointer is given a RelayTouchSource component.
GetTipDirection:Func`2<RelayTouchSource, Float3>	Func`2<RelayTouchSource, Float3>	✓	Can be called to get where the tip direction of the pointer is given a RelayTouchSource component.
GetTouchType:Func`2<RelayTouchSource, TouchType>	Func`2<RelayTouchSource, TouchType>	✓	Can be called to get where the touch type of the pointer is currently, given a RelayTouchSource component.
`GetTouchable:TouchableGetter`	TouchableGetter	✓	Can be called to get the touchable target object of this component.

Usage

Not to be used by the user, is used in internal game behavior.

Examples

Tip touch source system execution.

@@ Line 3: / Line 3: @@
 |Name=Pointer Interaction Controller
 }}
-{{stub}}
+The '''PointerInteractionController''' component is used by the game internally to handle tip touch source behavior on a user.
-== Usage ==
+== Fields ==
 {{Table ComponentFields
 }}
@@ Line 11: / Line 11: @@
 == Sync Delegates ==
 {{Table ComponentTriggers
-|GetTipPosition:[[Type:Func`2|Func`2]]&lt;[[Component:RelayTouchSource|RelayTouchSource]], [[Type:Float3|Float3]]&gt;|[[Type:Func`2|Func`2]]&lt;[[Component:RelayTouchSource|RelayTouchSource]], [[Type:Float3|Float3]]&gt;|true|
+|GetTipPosition:[[Type:Func`2|Func`2]]&lt;[[Component:RelayTouchSource|RelayTouchSource]], [[Type:Float3|Float3]]&gt;|[[Type:Func`2|Func`2]]&lt;[[Component:RelayTouchSource|RelayTouchSource]], [[Type:Float3|Float3]]&gt;|true| Can be called to get where the tip position of the pointer is given a [[Component:RelayTouchSource|RelayTouchSource]] component.
-|GetTipDirection:[[Type:Func`2|Func`2]]&lt;[[Component:RelayTouchSource|RelayTouchSource]], [[Type:Float3|Float3]]&gt;|[[Type:Func`2|Func`2]]&lt;[[Component:RelayTouchSource|RelayTouchSource]], [[Type:Float3|Float3]]&gt;|true|
+|GetTipDirection:[[Type:Func`2|Func`2]]&lt;[[Component:RelayTouchSource|RelayTouchSource]], [[Type:Float3|Float3]]&gt;|[[Type:Func`2|Func`2]]&lt;[[Component:RelayTouchSource|RelayTouchSource]], [[Type:Float3|Float3]]&gt;|true| Can be called to get where the tip direction of the pointer is given a [[Component:RelayTouchSource|RelayTouchSource]] component.
-|GetTouchType:[[Type:Func`2|Func`2]]&lt;[[Component:RelayTouchSource|RelayTouchSource]], [[Type:TouchType|TouchType]]&gt;|[[Type:Func`2|Func`2]]&lt;[[Component:RelayTouchSource|RelayTouchSource]], [[Type:TouchType|TouchType]]&gt;|true|
+|GetTouchType:[[Type:Func`2|Func`2]]&lt;[[Component:RelayTouchSource|RelayTouchSource]], [[Type:TouchType|TouchType]]&gt;|[[Type:Func`2|Func`2]]&lt;[[Component:RelayTouchSource|RelayTouchSource]], [[Type:TouchType|TouchType]]&gt;|true|  Can be called to get where the touch type of the pointer is currently, given a [[Component:RelayTouchSource|RelayTouchSource]] component.
-|GetTouchable:[[Type:TouchableGetter|TouchableGetter]]|[[Type:TouchableGetter|TouchableGetter]]|true|
+|GetTouchable:[[Type:TouchableGetter|TouchableGetter]]|[[Type:TouchableGetter|TouchableGetter]]|true| Can be called to get the touchable target object of this component.
 }}
-== Behavior ==
+== Usage ==
+Not to be used by the user, is used in internal game behavior.
 == Examples ==
+Tip touch source system execution.
 == See Also ==
@@ Line 25: / Line 27: @@
 [[Category:Components:Uncategorized{{#translation:}}|Pointer Interaction Controller]]
 [[Category:Components{{#translation:}}|Pointer Interaction Controller]]
-[[Category:ComponentStubs]]