NumberSequenceKeypoint

Overview

Description

The NumberSequenceKeypoint represents a single key point in a NumberSequence. It is used to define sequences associated with numeric values over time, commonly utilized in animation sequences or transformation operations in programs.

Properties

Envelope

number Represents the envelope value of the key point, typically used for varying effects like oscillations. Adjusting this controls the magnitude of such variations.

Code Samples

local keypoint = NumberSequenceKeypoint.new(0.5, 10, 1)
print(keypoint.Envelope) -- Output: 1

Time

number The normalized time value of the key point, ranging from 0 (start) to 1 (end). It determines the position of the key point along the sequence.

Code Samples

local keypoint = NumberSequenceKeypoint.new(0.5, 10, 1)
print(keypoint.Time) -- Output: 0.5

Value

number Represents the numeric value of the key point at the specified time. Used to define specific values in number sequences.

Code Samples

local keypoint = NumberSequenceKeypoint.new(0.5, 10, 1)
print(keypoint.Value) -- Output: 10

Constructors

new

Creates a new NumberSequenceKeypoint object by specifying the time, value, and envelope attributes.

Parameters

number InTime	The time at which this key point occurs in the sequence (normalized value between 0 and 1).
number InValue	The specific value assigned to this key point.
number InEnvelope	The oscillation envelope for effects such as rapid expansions or dampened movements.

Return

NumberSequenceKeypoint	A newly created `NumberSequenceKeypoint` object.

Code Samples

local keypoint = NumberSequenceKeypoint.new(0.5, 10, 1)
print(keypoint) -- Output: NumberSequenceKeypoint

new

An overloaded constructor that creates a NumberSequenceKeypoint with only time and value

Parameters

number InTime	The time at which this key point occurs in the sequence (normalized value between 0 and 1).
number InValue	The specific value assigned to this key point.

Return

NumberSequenceKeypoint	A newly created `NumberSequenceKeypoint` object.

Code Samples

local keypoint = NumberSequenceKeypoint.new(0.5, 10)
print(keypoint) -- Output: NumberSequenceKeypoint

Methods