Fixed link. |
add info |
||
| Line 1: | Line 1: | ||
<languages></languages> | <languages></languages> | ||
<translate> | <translate> | ||
{{Infobox Component | {{Infobox Component | ||
|Image=TouchEventRelayComponent.png | |Image=TouchEventRelayComponent.png | ||
|Name=Touch Event Relay | |Name=Touch Event Relay | ||
}} | }} | ||
The '''TouchEventRelay''' component is used to relay touch events recieved by a slot to other ITouchables. | |||
== Fields == | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|Touched|{{RootFieldType|SyncDelegate`1|[[Type:TouchEvent|TouchEvent]]}}|TypeAdv0=true| | |Touched|{{RootFieldType|SyncDelegate`1|[[Type:TouchEvent|TouchEvent]]}}|TypeAdv0=true| The sync delegate to call when this receives a touch event. | ||
|AcceptOutOfSightTouch|Bool| | |AcceptOutOfSightTouch|Bool| Whether this component allows touch events from a user not looking directly at the slot with this component. | ||
|TouchableTargets|{{RootFieldType|SyncRefList`1|[[Type:ITouchable|ITouchable]]}}|TypeAdv2=true| | |TouchableTargets|{{RootFieldType|SyncRefList`1|[[Type:ITouchable|ITouchable]]}}|TypeAdv2=true| Target touchable components to send the touch event to. | ||
}} | }} | ||
Latest revision as of 11:55, 3 August 2025
Component image 
Touch Event Relay component as seen in the Scene Inspector
The TouchEventRelay component is used to relay touch events recieved by a slot to other ITouchables.
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. |
Touched
|
delegate of identity TouchEvent | The sync delegate to call when this receives a touch event. |
AcceptOutOfSightTouch
|
Bool | Whether this component allows touch events from a user not looking directly at the slot with this component. |
TouchableTargets
|
list of ITouchable | Target touchable components to send the touch event to. |
Usage
- To trigger a hyperlink component without a touchable/interactable component you can use a TouchEventRelay. You a touch event relay on the collider of your object, then put a hyperlink or other touchables as children (with no colliders on them) then add them to the TouchableTargets list of the TouchEventRelay.
Examples
Related Components
- Touchable Events can be used with TouchEventRelay.
TouchEventRelay can relay events from a Touchable element to fire another ITouchable component.