# NumberSequenceKeypoint

## Overview

An element that constitutes a single keypoint in a NumberSequence, defining the time value corresponding to a specific point, the numeric value to be applied at that point, and the envelope size representing the range of variation. These keypoints are sequentially connected to form the overall numeric change flow and variation range of the NumberSequence.

## Constructors

### new

Creates a new NumberSequenceKeypoint by combining the provided time value, numeric value, and envelope size. The created keypoint defines both the value at a specific point and its variation range within the NumberSequence.

#### Parameters

| `number` InTime     | Specifies the time value where the keypoint will be positioned within the NumberSequence. Values typically use a range from 0 to 1, representing the relative position within the sequence. |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `number` InValue    | The numeric value to be applied at the specified time value.                                                                                                                                |
| `number` InEnvelope | The envelope size to be applied at this keypoint, representing the variation range of the value and used to express effects such as rapid expansion or gradual change.                      |

#### Return

| `NumberSequenceKeypoint` | A newly created NumberSequenceKeypoint based on the provided time value, numeric value, and envelope size. |
| ------------------------ | ---------------------------------------------------------------------------------------------------------- |

#### Code Samples

```lua
local Time = 0.5
local Value = 10
local Envelope = 1
local KeyPoint = NumberSequenceKeyPoint.new(Time, Value, Envelope)
```

### new

Creates a new NumberSequenceKeypoint by combining the provided time value and numeric value. The created keypoint defines the value at a specific point within the NumberSequence.

#### Parameters

| `number` InTime  | Specifies the time value where the keypoint will be positioned within the NumberSequence. Values typically use a range from 0 to 1, representing the relative position within the sequence. |
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `number` InValue | The numeric value to be applied at the specified time value.                                                                                                                                |

#### Return

| `NumberSequenceKeypoint` | A newly created NumberSequenceKeypoint based on the provided time value and numeric value. |
| ------------------------ | ------------------------------------------------------------------------------------------ |

#### Code Samples

```lua
local Time = 0.5
local Value = 10
local KeyPoint = NumberSequenceKeyPoint.new(Time, Value)
```

## Properties

### Envelope

`number` 

This value represents the range indicating how much variation is allowed from the base numeric value. It is determined by envelope calculation, and when applied, the actual value may vary within this range.

#### Code Samples

```lua
local Time = 0.5
local Value = 10
local Envelope = 1
local KeyPoint = NumberSequenceKeyPoint.new(Time, Value, Envelope)
print(KeyPoint.Envelope)
```

### Time

`number` 

A value representing where the keypoint is placed within the NumberSequence, using a range from 0 to 1 to define the position between start and end.

#### Code Samples

```lua
local Time = 0.5
local Value = 10
local Envelope = 1
local KeyPoint = NumberSequenceKeyPoint.new(Time, Value, Envelope)
print(KeyPoint.Time)
```

### Value

`number` 

The value representing the number to be applied at the keypoint.

#### Code Samples

```lua
local Time = 0.5
local Value = 10
local Envelope = 1
local KeyPoint = NumberSequenceKeyPoint.new(Time, Value, Envelope)
print(KeyPoint.Value)
```

## Methods