Reference API Roblox

Engine API

Website

Related

Reference API Roblox

RotationCurve

Represents a sequence of rotations and the interpolation curve between them.

Member index 9

HistoryMember
553Length: int
497GetKeyAtIndex(index: int): RotationCurveKey
497GetKeyIndicesAtTime(time: float): Array
497GetKeys(): Array
497GetValueAtTime(time: float): CoordinateFrame?
497InsertKey(key: RotationCurveKey): Array
497RemoveKeyAtIndex(startingIndex: int, count: int = 1): int
497SetKeys(keys: Array): int
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553ClassName: string
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
553className: string
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
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
462GetPropertyChangedSignal(property: string): RBXScriptSignal
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsA(className: 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
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
462isA(className: string): bool
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462Changed(property: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)

Description

This class holds a sorted list of RotationCurveKeys that represent a sequence of rotations. The shape of the interpolation curve between two keys is determined by the RotationCurveKey.Interpolation type.

History 12

Members 9

GetKeyAtIndex

Parameters (1)
indexint
Returns (1)
RotationCurveKey

Returns a copy of a key at a given index.

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).

History 1

GetKeys

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

Returns a copy of all the keys in the rotation curve as a Lua array of RotationCurveKeys.

History 1

GetValueAtTime

Parameters (1)
timefloat
Returns (1)
CoordinateFrame?

Samples the rotation curve at a given time and returns the corresponding rotation as a CFrame. Empty rotation curves are evaluated as CFrame.identity.

History 1

InsertKey

Parameters (1)
keyRotationCurveKey
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.

History 1

Length

TypeDefault
int0

Number of rotation keys in this 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.

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.

History 1

SetKeys

Parameters (1)
keysArray
Returns (1)
int

Resets this curve's keys using the RotationCurveKey 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.

History 1

Settings