Component:ButtonDelegateRelay: Difference between revisions

From Resonite Wiki
Automated: update Categories
This is no longer a stub. added a description, added field descriptions, added usage description.
 
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=ButtonDelegateRelay`1Component.png
|Image=ButtonDelegateRelay`1Component.png
|Name=Button Delegate Relay`1
|Name=Button Delegate Relay`1
}}
}}
The '''ButtonDelegateRelay''' 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
|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|{{RootFieldType|SyncDelegate`1|T}}|TypeAdv2=true|
|Argument|{{RootFieldType|SyncDelegate`1|T}}|TypeAdv2=true| The sync Delegate reference.
|ButtonPressed|{{RootFieldType|SyncDelegate`1|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;T&gt;}}|TypeAdv3=true|
|ButtonPressed|{{RootFieldType|SyncDelegate`1|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;T&gt;}}|TypeAdv3=true| The place to send the signal.
}}
}}


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


<!--T:4-->
<!--T:4-->
Line 26: Line 28:
== Related Components ==
== Related Components ==
</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:Generics{{#translation:}}]]
[[Category:Generics{{#translation:}}]]
[[Category:Components{{#translation:}}|Button Delegate Relay`1]]
[[Category:Components{{#translation:}}|Button Delegate Relay`1]]
[[Category:Generic Components{{#translation:}}|Button Delegate Relay`1]]
[[Category:Generic Components{{#translation:}}|Button Delegate Relay`1]]
[[Category:Components:Common UI:Events{{#translation:}}|Button Delegate Relay`1]]
[[Category:Components:Common UI:Events{{#translation:}}|Button Delegate Relay`1]]

Latest revision as of 00:37, 13 September 2024

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


The ButtonDelegateRelay 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.
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 sync Delegate reference.
ButtonPressed ButtonEventHandler`1<T> The place to send the signal.

Usage

This can send a signal internally.

Examples

Related Components