Component:ButtonRelay: Difference between revisions

From Resonite Wiki
m ProbablePrime moved page ButtonRelay (Component) to Component:ButtonRelay: Creating component Namespace
Add related
 
(3 intermediate revisions by 3 users not shown)
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=ButtonRelayComponent.png
|Image=ButtonRelayComponent.png
|Name=Button Relay
|Name=Button Relay
}}
}}
The '''ButtonRelay''' component sends a signal (and optionally with a [[Value Type]]) to a button event handler (usually something internal like a [[Sync Delegate]]).


<!--T:2-->
<!--T:2-->
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|DoublePressDelay|Float|
|DoublePressDelay|Float| how long it takes before it is to late to count as a double press.
|ReleasePressInterval|Float|
|ReleasePressInterval|Float| The amount of time it takes to release the button.
|ButtonPressed|WorldDelegate|
|ButtonPressed|{{RootFieldType|SyncDelegate`1|[[Type:ButtonEventHandler|ButtonEventHandler]]}}|TypeAdv2=true| The place to send the signal.
}}
}}


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


<!--T:4-->
<!--T:4-->
Line 23: Line 25:


<!--T:5-->
<!--T:5-->
== Related Components ==
== See Also ==
* [[Component:ButtonPressEventRelay]]
* [[Component:ButtonHoverEventRelay]]
* [[Component:ButtonRelay]]
</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:Components{{#translation:}}|Button Relay]]
[[Category:Components{{#translation:}}|Button Relay]]
[[Category:Components:Common UI:Events{{#translation:}}|Button Relay]]
[[Category:Components:Common UI:Events{{#translation:}}|Button Relay]]

Latest revision as of 15:15, 11 November 2024

Component image 
Button Relay component as seen in the Scene Inspector


The ButtonRelay component sends a signal (and optionally with a Value Type) to a button event handler (usually something internal like a Sync Delegate).

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.
DoublePressDelay Float how long it takes before it is to late to count as a double press.
ReleasePressInterval Float The amount of time it takes to release the button.
ButtonPressed ButtonEventHandler The place to send the signal.

Usage

This can send a signal internally.

Examples

See Also