Component:ButtonHoverRelay: Difference between revisions

Latest revision as of 00:30, 13 September 2024

Component image

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

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

This can send a signal internally.

@@ Line 2: / Line 2: @@
 <translate>
 <!--T:1-->
-{{stub}}
 {{Infobox Component
 |Image=ButtonHoverRelayComponent.png
 |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-->
 == Fields ==
 {{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-->
 == Usage ==
+This can send a signal internally.
 <!--T:4-->
@@ Line 25: / Line 27: @@
 == Related Components ==
 </translate>
-[[Category:ComponentStubs]]
 [[Category:Components{{#translation:}}|Button Hover Relay]]
 [[Category:Components:Common UI:Events{{#translation:}}|Button Hover Relay]]