Skip to Content
Kinemium
Datatypes

Sequences

NumberRange, NumberSequence, and NumberSequenceKeypoint for interpolated values.

NumberRange

NumberRange.new(min, max?) stores a range of numbers. If max is omitted, it equals min. A minimum greater than the maximum raises an error.

local damage = NumberRange.new(10, 20)
print(damage.Min, damage.Max)
MemberTypeDescription
MinnumberLower bound.
MaxnumberUpper bound.

Equality compares both bounds.

NumberSequence

A number sequence describes values over normalized time. Use it for particle sizes, transparency, and similar animated values.

local fade = NumberSequence.new({
    NumberSequenceKeypoint.new(0, 1),
    NumberSequenceKeypoint.new(1, 0)
})
ConstructorDescription
NumberSequence.new(value)Constant value.
NumberSequence.new(start, finish)Two-stop sequence.
NumberSequence.new(keypoints)Sequence from an array of NumberSequenceKeypoint.
MemberTypeDescription
Keypoints{NumberSequenceKeypoint}Read-only array of stops.

NumberSequenceKeypoint

NumberSequenceKeypoint.new(time, value, envelope?) creates one stop.

ArgumentDefaultDescription
timeRequiredPosition from 0 to 1. Values outside the range raise an error.
valueRequiredValue at the stop. Must not be NaN.
envelope0Random spread around the value. Must be >= 0.
MemberTypeDescription
TimenumberPosition in the sequence.
ValuenumberValue at the stop.
EnvelopenumberRandom spread.

See also

On this page