Component:ButtonValueShift: Difference between revisions

From Resonite Wiki
No edit summary
Automated: update component fields
Line 13: Line 13:
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|TargetValue|IField`1|TypeString0=IField<float>| The value to shift.
|TargetValue|'''[[Type:IField`1|IField`1]]&lt;T&gt;'''|TypeAdv0=true| The value to shift.
|Delta|Float| By how much <code>TargetValue</code> should be shifted on each press.
|Delta|'''T'''|TypeAdv1=true| By how much <code>TargetValue</code> should be shifted on each press.
|Min|Float| The minimum value that can be shifted to.
|Min|'''T'''|TypeAdv2=true| The minimum value that can be shifted to.
|Max|Float| The maximum value that can be shifted to.
|Max|'''T'''|TypeAdv3=true| The maximum value that can be shifted to.
|WrapAround|Bool| Whether or not the value should wrap around to the other extreme when reaching either <code>Min</code> or <code>Max</code>.
|WrapAround|Bool| Whether or not the value should wrap around to the other extreme when reaching either <code>Min</code> or <code>Max</code>.
|MaxIsExclusive|Bool|
}}
}}



Revision as of 10:39, 1 March 2024


This article or section is a Stub. You can help the Resonite Wiki by expanding it.


Component image 
Button Value Shift`1 component as seen in the Scene Inspector


The ButtonValueShift component can be used to make a button add X to a value whenever it is pressed.

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.
TargetValue IField`1<T> The value to shift.
Delta T By how much TargetValue should be shifted on each press.
Min T The minimum value that can be shifted to.
Max T The maximum value that can be shifted to.
WrapAround Bool Whether or not the value should wrap around to the other extreme when reaching either Min or Max.
MaxIsExclusive Bool

Usage

To function, the component simply needs to be attached to a slot that also has a button component attached to it. From then on, pressing that button will activate the ButtonValueShift, making it shift its TargetValue by its Delta.

Examples

Related Issues

Related Components