Component:ButtonHoverEventRelay: Difference between revisions

From Resonite Wiki
m ProbablePrime moved page ButtonHoverEventRelay (Component) to Component:ButtonHoverEventRelay: Creating component Namespace
Added a description, added a usage description, added field description. This is no longer a stub.
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=ButtonHoverEventRelayComponent.png
|Image=ButtonHoverEventRelayComponent.png
|Name=Button Hover Event Relay
|Name=Button Hover Event Relay
}}
}}
The '''ButtonHoverEventRelay''' component takes in a [[Slot|slot]] target, and if any [[Type:IButton|IButton]] hover event happens with this component on a slot, will also send a signal to that target slot, and the components on that target slot will trigger with hover events (if applicable).


<!--T:2-->
<!--T:2-->
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Target|Slot|
|Target|Slot| The [[Slot|slot]] to send the signal to.
}}
}}


<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
Useful for sending multiple signals from one hover event.


<!--T:4-->
<!--T:4-->
Line 23: Line 25:
== Related Components ==
== Related Components ==
</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:Components{{#translation:}}|Button Hover Event Relay]]
[[Category:Components{{#translation:}}|Button Hover Event Relay]]
[[Category:Components:Common UI:Button Interactions{{#translation:}}|Button Hover Event Relay]]
[[Category:Components:Common UI:Button Interactions{{#translation:}}|Button Hover Event Relay]]

Revision as of 22:28, 11 September 2024

Component image 
Button Hover Event Relay component as seen in the Scene Inspector


The ButtonHoverEventRelay component takes in a slot target, and if any IButton hover event happens with this component on a slot, will also send a signal to that target slot, and the components on that target slot will trigger with hover events (if applicable).

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.
Target Slot The slot to send the signal to.

Usage

Useful for sending multiple signals from one hover event.

Examples

Related Components