Component:ButtonRefRelay: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
This is no longer a stub. added a description, added field descriptions, added usage description.
 
Line 3: Line 3:
|Name=Button Ref Relay`1
|Name=Button Ref Relay`1
}}
}}
{{stub}}


== Usage ==
The '''ButtonRefRelay''' component sends a signal to a button event handler (usually something internal like a [[ProtoFlux:Method Proxy|Method Proxy]]).
 
{{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.
|Argument|'''T'''|TypeAdv2=true|
|Argument|'''T'''|TypeAdv2=true| The reference argument.
|ButtonPressed|{{RootFieldType|SyncDelegate`1|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]<T>}}|TypeAdv3=true|
|ButtonPressed|{{RootFieldType|SyncDelegate`1|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]<T>}}|TypeAdv3=true| The place to send the signal.
}}
}}


== Behavior ==
== Usage ==
This can send a signal internally.


== Examples ==
== Examples ==

Latest revision as of 00:34, 13 September 2024

Component image 
Button Ref Relay`1 component as seen in the Scene Inspector


The ButtonRefRelay 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.
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.
Argument T The reference argument.
ButtonPressed ButtonEventHandler`1<T> The place to send the signal.

Usage

This can send a signal internally.

Examples

See Also