Add info |
Small correction, it is for all UIX elements. added a bit more to the description. |
||
(3 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
<languages></languages> | <languages></languages> | ||
<translate> | <translate> | ||
<!--T:1--> | <!--T:1--> | ||
{{Infobox Component | {{Infobox Component | ||
|Image=InteractionBlockComponent.png | |Image=InteractionBlockComponent.png | ||
Line 11: | Line 10: | ||
<!--T:2--> | <!--T:2--> | ||
The '''InteractionBlock''' component is used to block [[UIX]] interaction events from the [[User|user]]. It requires an [[Component:Image|Image]] on the same [[Slot]] this component is on for this to work. | |||
{{Note|Order matters, using the <code>OrderOffset</code> will determine what gets blocked based on the slot hierarchy. Keep in mind the layers of the slots, usually anything behind this component's slot (a lower <code>OrderOffset</code>) will no longer be interactable.|warning}} | |||
<!--T:3--> | <!--T:3--> | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|TouchExitLock|Bool| | |TouchExitLock|Bool|Blocks interactions when an interaction ends. | ||
|TouchEnterLock|Bool| | |TouchEnterLock|Bool|Blocks interactions when an interaction starts. | ||
}} | }} | ||
<!--T:4--> | <!--T:4--> | ||
== | == Usage == | ||
Any time you want to stop any UIX element from interacting (like having a popup menu to be on top of your main UIX), you can use this component to make the main UIX elements not respond to the user, making them focus on the newly spawned UIX. | |||
<!--T:5--> | <!--T:5--> | ||
Line 29: | Line 30: | ||
== Related Components == | == Related Components == | ||
</translate> | </translate> | ||
[[Category:Components{{#translation:}}| | [[Category:Components{{#translation:}}|Interaction Block]] | ||
[[Category:Components:UIX:Interaction{{#translation:}}|Interaction Block]] | |||
[[Category:Components:UIX:Interaction{{#translation:}}| |
Latest revision as of 03:15, 28 July 2024
Component image
The InteractionBlock component is used to block UIX interaction events from the user. It requires an Image on the same Slot this component is on for this to work.
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. |
TouchExitLock
|
Bool | Blocks interactions when an interaction ends. |
TouchEnterLock
|
Bool | Blocks interactions when an interaction starts. |
Usage
Any time you want to stop any UIX element from interacting (like having a popup menu to be on top of your main UIX), you can use this component to make the main UIX elements not respond to the user, making them focus on the newly spawned UIX.