CompositeValueCurve

Inherits from: Instance → Object

An animation curve that groups child FloatCurves which each animate a different component of a non-unary value. The CurveType property specifies the type of value to be animated and, depending on this value, differently named children are used to drive the animation of the components of the value.

As follows are the names of the child curves that drive the animation for each possible CompositeValueCurveType value for CurveType:

ColorRGB: { "R", "G", "B" }
ColorHSV: { "H", "S", "V" }
NumberRange: { "Min", "Max" }
Rect: { "MinX", "MaxX", "MinY", "MaxY" }
UDim: { "Scale", "Offset" }
UDim2: { "ScaleX", "OffsetX", "ScaleY", "OffsetY" }
Vector2: { "X", "Y"}
Vector3: { "X", "Y", "Z" }

The children that drive the animation can be accessed via the GetComponentCurves() method which returns an array of curves in the order specified above. The value of the curve at a given time in the animation may be sampled by the GetValueAtTime() method.

Inherits from: Instance

Memory category: Instances

Properties

Name	Type / Returns	Description
CompositeValueCurve.CurveType	CompositeValueCurveType	The type of value animated by this `CompositeValueCurve`.

Inherited from Instance

Name	Type / Returns	Description
Instance.Archivable	boolean	Determines if an `Instance` and its descendants can be cloned using `Instance:Clone()`, and can be saved/published.
Instance.archivable	boolean
Instance.Capabilities	SecurityCapabilities	The set of capabilities allowed to be used for scripts inside this container.
Instance.IsInSandbox	boolean	Indicates whether the instance is inside a sandboxed container.
Instance.Name	string	A non-unique identifier of the `Instance`.
Instance.Parent	Instance	Determines the hierarchical parent of the `Instance`.
Instance.PredictionMode	PredictionMode	Reflects the client-side prediction mode applied to the instance under server-authoritative physics.
Instance.RobloxLocked	boolean	A deprecated property that used to protect `CoreGui` objects.
Instance.Sandboxed	boolean	When enabled, the instance can only access abilities in its `Capabilities` list.
Instance.UniqueId	UniqueId	A unique identifier for the instance.

Inherited from Object

Name	Type / Returns	Description
Object.ClassName	string	A read-only string representing the class this `Object` belongs to.
Object.className	string

CompositeValueCurve.CurveType

The type of value animated by this CompositeValueCurve. See CompositeValueCurveType for options.

Field	Value
type	CompositeValueCurveType
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":true,"can_save":true}
capabilities	["Basic"]

Methods

Name	Type / Returns	Description
CompositeValueCurve:GetComponentCurves	List	Returns the child curves with the given names for the `CurveType` of this `CompositeValueCurve`.
CompositeValueCurve:GetValueAtTime	Variant	Returns the sampled animated value at the passed `time` argument.

Inherited from Instance

Name	Type / Returns	Description
Instance:AddTag	()	Applies a tag to the instance.
Instance:children	Instances	Returns an array of the object's children.
Instance:ClearAllChildren	()	This method destroys all of an instance's children.
Instance:Clone	Instance	Create a copy of an instance and all its descendants, ignoring instances that are not `Archivable`.
Instance:clone	Instance
Instance:Destroy	()	Sets the `Instance.Parent` property to `nil`, locks the `Instance.Parent` property, disconnects all connections, and calls `Destroy()` on all children.
Instance:destroy	()
Instance:FindFirstAncestor	Instance?	Returns the first ancestor of the `Instance` whose `Instance.Name` is equal to the given name.
Instance:FindFirstAncestorOfClass	Instance?	Returns the first ancestor of the `Instance` whose `Object.ClassName` is equal to the given className.
Instance:FindFirstAncestorWhichIsA	Instance?	Returns the first ancestor of the `Instance` for whom `Object:IsA()` returns true for the given className.
Instance:FindFirstChild	Instance?	Returns the first child of the `Instance` found with the given name.
Instance:findFirstChild	Instance
Instance:FindFirstChildOfClass	Instance?	Returns the first child of the `Instance` whose `ClassName` is equal to the given class name.
Instance:FindFirstChildWhichIsA	Instance?	Returns the first child of the `Instance` for whom `Object:IsA()` returns true for the given className.
Instance:FindFirstDescendant	Instance?	Returns the first descendant found with the given `Instance.Name`.
Instance:GetActor	Actor?	Returns the `Actor` associated with the Instance, if any.
Instance:GetAttribute	Variant	Returns the value which has been assigned to the given attribute name.
Instance:GetAttributeChangedSignal	RBXScriptSignal	Returns an event that fires when the given attribute changes.
Instance:GetAttributes	Dictionary	Returns a dictionary of the instance's attributes.
Instance:GetChildren	Instances	Returns an array containing all of the instance's children.
Instance:getChildren	Instances
Instance:GetDebugId	string	Returns a coded string of the debug ID used internally by Roblox.
Instance:GetDescendants	Instances	Returns an array containing all of the descendants of the instance.
Instance:GetFullName	string	Returns a string describing the instance's ancestry.
Instance:GetStyled	Variant	Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Instance:GetStyledPropertyChangedSignal	RBXScriptSignal	Returns an event that fires when the given style property changes on the instance.
Instance:GetTags	Array	Gets an array of all tags applied to the instance.
Instance:HasTag	boolean	Check whether the instance has a given tag.
Instance:IsAncestorOf	boolean	Returns true if an `Instance` is an ancestor of the given descendant.
Instance:IsDescendantOf	boolean	Returns `true` if an `Instance` is a descendant of the given ancestor.
Instance:isDescendantOf	boolean
Instance:IsPropertyModified	boolean	Returns `true` if the value stored in the specified property is not equal to the code-instantiated default.
Instance:QueryDescendants	Instances	Returns an array containing all descendants of the instance that match the `selector` string.
Instance:Remove	()	Sets the object's `Parent` to `nil`, and does the same for all its descendants.
Instance:remove	()
Instance:RemoveTag	()	Removes a tag from the instance.
Instance:ResetPropertyToDefault	()	Resets a property to its default value.
Instance:SetAttribute	()	Sets the attribute with the given name to the given value.
Instance:WaitForChild	Instance	Returns the child of the `Instance` with the given name. If the child does not exist, it will yield the current thread until it does.

Inherited from Object

Name	Type / Returns	Description
Object:GetPropertyChangedSignal	RBXScriptSignal	Get an event that fires when a given property of the object changes.
Object:IsA	boolean	Returns true if an object's class matches or inherits from a given class.
Object:isA	boolean

CompositeValueCurve:GetComponentCurves

This method returns the child curves with the given names for the CurveType of this CompositeValueCurve, in the order given by the list of child curves outlined at the top of this page. Any curve that does not exist prior to calling this method will be created and added as a child with the appropriate name. That new curve will be an empty FloatCurve.

Returns

Type	Description
List	An array of the child `FloatCurve` instances that drive the components of the animated value, in the order listed at the top of this page. Any expected child curve that does not yet exist is created as an empty `FloatCurve` and included in the result.

Field	Value
security	None
thread safety	Unsafe
capabilities	["Basic"]

CompositeValueCurve:GetValueAtTime

This method returns the sampled animated value at the passed time argument. The type of the returned value will match that specified by the CurveType property.

If any child curve is missing from the children of the curve, the corresponding value in the returned property will be 0. For example, if a curve has a CurveType of CompositeValueCurveType.ColorRGB but only one FloatCurve child named "G", then the returned FloatCurve will have values of 0 for "R" and "B", but the "G" value will be sampled from the child curve.

Parameters

Name	Type	Default	Description
time	float		Time at which to get the value.

Returns

Type	Description
Variant	The value of the curve at the passed time.

Field	Value
security	None
thread safety	Unsafe
capabilities	["Basic"]

Events

Inherited from Instance

Name	Type / Returns	Description
Instance.AncestryChanged		Fires when the `Instance.Parent` property of this object or one of its ancestors is changed.
Instance.AttributeChanged		Fires whenever an attribute is changed on the `Instance`.
Instance.ChildAdded		Fires after an object is parented to this `Instance`.
Instance.childAdded
Instance.ChildRemoved		Fires after a child is removed from this `Instance`.
Instance.DescendantAdded		Fires after a descendant is added to the `Instance`.
Instance.DescendantRemoving		Fires immediately before a descendant of the `Instance` is removed.
Instance.Destroying		Fires immediately before (or is deferred until after) the instance is destroyed via `Instance:Destroy()`.
Instance.StyledPropertiesChanged		Fires whenever any style property is changed on the instance, including when a property is set to `nil`.

Inherited from Object

Name	Type / Returns	Description
Object.Changed		Fires immediately after a property of the object changes, with some limitations.