Component:ButtonRelay: Difference between revisions

Revision as of 00:25, 13 September 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 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.
`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

Related Components

@@ Line 2: / Line 2: @@
 <translate>
 <!--T:1-->
-{{stub}}
 {{Infobox Component
 |Image=ButtonRelayComponent.png
 |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 [[ProtoFlux:Method Proxy|Method Proxy]]).
 <!--T:2-->
 == Fields ==
 {{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|{{RootFieldType|SyncDelegate`1|[[Type:ButtonEventHandler|ButtonEventHandler]]}}|TypeAdv2=true|
+|ButtonPressed|{{RootFieldType|SyncDelegate`1|[[Type:ButtonEventHandler|ButtonEventHandler]]}}|TypeAdv2=true| The place to send the signal.
 }}
 <!--T:3-->
 == Usage ==
+This can send a signal internally.
 <!--T:4-->
@@ Line 25: / Line 27: @@
 == Related Components ==
 </translate>
-[[Category:ComponentStubs]]
 [[Category:Components{{#translation:}}|Button Relay]]
 [[Category:Components:Common UI:Events{{#translation:}}|Button Relay]]