Component:ButtonHoverRelay: Difference between revisions

From Resonite Wiki
m ProbablePrime moved page ButtonHoverRelay (Component) to Component:ButtonHoverRelay: Creating component Namespace
This is no longer a stub. added a description, added field descriptions, added a usage description.
 
(One intermediate revision by one other user not shown)
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=ButtonHoverRelayComponent.png
|Image=ButtonHoverRelayComponent.png
|Name=Button Hover Relay
|Name=Button Hover Relay
}}
}}
The '''ButtonHoverRelay''' component sends a signal to a button event handler (usually something internal like a [[ProtoFlux:Method Proxy|Method Proxy]]).


<!--T:2-->
<!--T:2-->
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|OnHoverEnter|WorldDelegate|
|OnHoverEnter|{{RootFieldType|SyncDelegate`1|[[Type:ButtonEventHandler|ButtonEventHandler]]}}|TypeAdv0=true| Sends a signal when hovering begins.
|OnHoverStay|WorldDelegate|
|OnHoverStay|{{RootFieldType|SyncDelegate`1|[[Type:ButtonEventHandler|ButtonEventHandler]]}}|TypeAdv1=true| Sends a signal when hovering.
|OnHoverLeave|WorldDelegate|
|OnHoverLeave|{{RootFieldType|SyncDelegate`1|[[Type:ButtonEventHandler|ButtonEventHandler]]}}|TypeAdv2=true| Sends a signal when hovering ends.
}}
}}


<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
This can send a signal internally.


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

Latest revision as of 00:30, 13 September 2024

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


The ButtonHoverRelay component sends a signal to a button event handler (usually something internal like a Method Proxy).

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.
OnHoverEnter ButtonEventHandler Sends a signal when hovering begins.
OnHoverStay ButtonEventHandler Sends a signal when hovering.
OnHoverLeave ButtonEventHandler Sends a signal when hovering ends.

Usage

This can send a signal internally.

Examples

Related Components