Automated: create new component page |
This is no longer a stub. style. Added description, added field descriptions, added usage description. Added links to see also section. |
||
Line 3: | Line 3: | ||
|Name=Button Dynamic Impulse Trigger | |Name=Button Dynamic Impulse Trigger | ||
}} | }} | ||
The '''ButtonDynamicImpulseTrigger''' component sends dynamic impulses to [[ProtoFlux:Dynamic Impulse Receiver|flux node receivers]]. This acts like a combination of [[ProtoFlux:Button Events|Button Events]] & [[ProtoFlux:Dynamic Impulse Trigger|Dynamic Impulse Trigger]] [[ProtoFlux]] nodes, but as a component instead. | |||
Here is more information about [[Dynamic Impulses]]. | |||
{{Table ComponentFields | {{Table ComponentFields | ||
|Target|Slot| | |Target|Slot| The slot hierarchy to send this impulse through. If this is null, it will pulse through root instead. | ||
|ExcludeDisabled|Bool| | |ExcludeDisabled|Bool|If true, this pulse will ignore disabled [[Slot|slots]]. | ||
|PressedTag|String| | |PressedTag|String|When the button is pressed, send a pulse for receivers looking for this tag. | ||
|PressingTag|String| | |PressingTag|String|When the button is pressing, send a pulse for receivers looking for this tag. | ||
|ReleasedTag|String| | |ReleasedTag|String|When the button is released, send a pulse for receivers looking for this tag. | ||
|HoverEnterTag|String| | |HoverEnterTag|String|When the button just began to hover, send a pulse for receivers looking for this tag. | ||
|HoverStayTag|String| | |HoverStayTag|String|When the button is hovering, send a pulse for receivers looking for this tag. | ||
|HoverLeaveTag|String| | |HoverLeaveTag|String|When the button has stopped hovering, send a pulse for receivers looking for this tag. | ||
}} | }} | ||
== | == Usage == | ||
Useful for sending dynamic pulses cleanly instead of using flux. | |||
== Examples == | == Examples == | ||
== See Also == | == See Also == | ||
* [[ProtoFlux:Dynamic Impulse Trigger]] | |||
* [[ProtoFlux:Dynamic Impulse Receiver]] | |||
[[Category:Components:Common UI:Button Interactions{{#translation:}}|Button Dynamic Impulse Trigger]] | [[Category:Components:Common UI:Button Interactions{{#translation:}}|Button Dynamic Impulse Trigger]] | ||
[[Category:Components{{#translation:}}|Button Dynamic Impulse Trigger]] | [[Category:Components{{#translation:}}|Button Dynamic Impulse Trigger]] | ||
Revision as of 20:48, 11 September 2024
Component image
The ButtonDynamicImpulseTrigger component sends dynamic impulses to flux node receivers. This acts like a combination of Button Events & Dynamic Impulse Trigger ProtoFlux nodes, but as a component instead.
Here is more information about Dynamic Impulses.
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 hierarchy to send this impulse through. If this is null, it will pulse through root instead. |
ExcludeDisabled
|
Bool | If true, this pulse will ignore disabled slots. |
PressedTag
|
String | When the button is pressed, send a pulse for receivers looking for this tag. |
PressingTag
|
String | When the button is pressing, send a pulse for receivers looking for this tag. |
ReleasedTag
|
String | When the button is released, send a pulse for receivers looking for this tag. |
HoverEnterTag
|
String | When the button just began to hover, send a pulse for receivers looking for this tag. |
HoverStayTag
|
String | When the button is hovering, send a pulse for receivers looking for this tag. |
HoverLeaveTag
|
String | When the button has stopped hovering, send a pulse for receivers looking for this tag. |
Usage
Useful for sending dynamic pulses cleanly instead of using flux.