Component:ButtonDynamicImpulseTriggerWithValue

From Resonite Wiki
Revision as of 21:05, 11 September 2024 by AmasterAmaster (talk | contribs) (Added description, added usage description, added links to see also section.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Component image 
Button Dynamic Impulse Trigger With Value`1 component as seen in the Scene Inspector


The ButtonDynamicImpulseTriggerWithValue component sends Dynamic Impulses to flux node receivers with data. This acts like a combination of Button Events & Dynamic Impulse Trigger With Data ProtoFlux nodes, but as a component instead.

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.
Target Slot The slot to target with impulses specified by PressedData,PressingData,ReleasedData,HoverEnterData,HoverStayData,HoverLeaveData.
ExcludeDisabled Bool Whether disabled slots and hierarchies should be affected by the dynamic impulses sent.
PressedData direct EventData<T> What value and tag type dynamic impulse to send when an IButton is pressed on the same slot.
PressingData direct EventData<T> What value and tag type dynamic impulse to send when an IButton is being pressed on the same slot. Fires every update while the button is being pressed.
ReleasedData direct EventData<T> What value and tag type dynamic impulse to send when an IButton stops being pressed on the same slot.
HoverEnterData direct EventData<T> What value and tag type dynamic impulse to send when an IButton starts being pointed at on the same slot.
HoverStayData direct EventData<T> What value and tag type dynamic impulse to send when an IButton is currently pointed at on the same slot. Fires every update while the button is being hovered over.
HoverLeaveData direct EventData<T> What value and tag type dynamic impulse to send when an IButton stops being pointed at on the same slot.

EventData

Fields
Name Type Description
Tag String The Tag of the sent impulse
Value T The value to send with the Dynamic Impulse


Usage

Useful for sending dynamic pulses cleanly instead of using flux.

Examples

This is useful for making a keyboard by putting this component on each button and then sending the char of the button that pressed it, so all your code can be in one place.

See Also