Value
A core state representing a single value that can be set or read at any time
Type | Since | Scoped |
---|---|---|
State | 0.0.1 | Yes |
Constructor
Value(Value : any)
Properties
Value : any
The current state of the value object. Can be either set or read.
Events
Changed
Fired when .Value
changes.
Usage
To create a value object, simply call Value()
, passing in any value type. In this case, we will be doing a number.
local MyValue = Value(0)
Value objects can lead to a reaction in another state. For example, in either springs or tweens, you can pass a value object in the first parameter. If you do, updating the value updates the animation.
local MyValue = Value(0)
local MySpring = Spring(MyValue, 20, 1) -- Updates whenever MyValue.Value changes
Values can also be used in computeds to update computations, like so:
New(MyFrame, {
Position = Computed(function(Use)
return UDim2.fromScale(Use(XPosition), 0)
end)
})