Reference API Roblox

Engine API

Website

Related

Reference API Roblox

FloatCurve

A sorted list of time-value pairs that define a curve. Used to animate a single numerical value.

Memory categoryInstances

Member index 9

HistoryMember
553Length: int
496GetKeyAtIndex(index: int): FloatCurveKey
496GetKeyIndicesAtTime(time: float): Array
496GetKeys(): Array
496GetValueAtTime(time: float): float?
496InsertKey(key: FloatCurveKey): Array
496RemoveKeyAtIndex(startingIndex: int, count: int = 1): int
496SetKeys(keys: Array): int
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Description

An instance representing a 1D float curve encoded via a sorted list of FloatCurveKeys. The shape of the interpolation curve between two keys is determined by the FloatCurveKey.Interpolation type.

History 11

Members 9

GetKeyAtIndex

Parameters (1)
indexint
Returns (1)
FloatCurveKey

Returns a copy of a key at a given index.

Thread safetyUnsafe

History 1

GetKeyIndicesAtTime

Parameters (1)
timefloat
Returns (1)
Array

The first item in the returned array is the index of the last key with time less than or equal to time (or the lesser of either 1 or the curve length if no key was found). The second item in the returned array is the index of the first key with time greater than or equal to time (or the curve length if no key was found satisfying the inequality).

Thread safetyUnsafe

History 1

GetKeys

Parameters (0)
No parameters.
Returns (1)
Array

Returns a copy of all the keys in the FloatCurve as a Lua array of FloatCurveKeys.

Thread safetyUnsafe

History 1

GetValueAtTime

Parameters (1)
timefloat
Returns (1)
float?

Samples the float curve at a given time passed as argument.

Thread safetyUnsafe

History 1

InsertKey

Parameters (1)
keyFloatCurveKey
Returns (1)
Array

Adds the key passed as an argument to this curve. If a key at the same time is found, it will be replaced. In the returned array, the first value is true if a key was added or false if a previous key was replaced; the second value is the index at which the marker was added.

Thread safetyUnsafe

History 1

Length

TypeDefault
int0

Number of keys in the float curve.

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryData
Loaded/Savedfalse/true

History 2

Tags: [ReadOnly, NotReplicated]

RemoveKeyAtIndex

Parameters (2)Default
startingIndexint
countint1
Returns (1)
int

Removes a given number (count) of keys starting from the startingIndex index and returns the number of keys that were removed.

Thread safetyUnsafe

History 1

SetKeys

Parameters (1)
keysArray
Returns (1)
int

Resets this curve's keys using the FloatCurveKey array passed as an argument. Keys in the keys array are sorted in ascending time order before insertion, and keys at duplicated times are removed in a stable manner.

Returns the number of keys actually inserted. Keys previously stored in this curve are removed before the keys passed as arguments are added.

Thread safetyUnsafe

History 1

Settings