Component:InteractionBlock: Difference between revisions

Revision as of 03:09, 28 July 2024

Component image

**InteractionBlock** component as seen in the Scene Inspector

The InteractionBlock component is used to block UIX interaction events. It requires an Image on the same Slot this component is on for this to work.

Order matters, using the OrderOffset 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 OrderOffset) will no longer be interactable.

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.
`TouchExitLock`	Bool	Blocks interactions when an interaction ends.
`TouchEnterLock`	Bool	Blocks interactions when an interaction starts.

Usage

Any time you want to stop buttons 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 buttons not respond to the user, making them focus on the newly spawned UIX.

Examples

Related Components

@@ Line 10: / Line 10: @@
 <!--T:2-->
-The '''InteractionBlock''' component is used to block [[UIX]] interaction events.
+The '''InteractionBlock''' component is used to block [[UIX]] interaction events. It requires an [[Component:Image|Image]] on the same [[Slot]] this component is on for this to work.
-{{Note|This component does not block interactable UIX elements such as [[Component:Button|buttons]], [[Component:Checkbox|Checkboxes]], or any other interactable element through physical touch or remote (laser) touch.|warning}}
+{{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-->
@@ Line 22: / Line 22: @@
 <!--T:4-->
 == Usage ==
+Any time you want to stop buttons 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 buttons not respond to the user, making them focus on the newly spawned UIX.
 <!--T:5-->