mirror of
https://github.com/rojo-rbx/rojo.git
synced 2026-10-23 14:01:37 +00:00
122 lines
4.7 KiB
YAML
122 lines
4.7 KiB
YAML
# This file is automatically generated. Please don't edit it manually.
|
|
# To submit a bug report on the content, see
|
|
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
|
|
|
|
name: CompositeValueCurve
|
|
type: class
|
|
memory_category: Instances
|
|
summary: |
|
|
An animation curve that groups child `Class.FloatCurve|FloatCurves` which each
|
|
animate a different component of a non-unary value.
|
|
description: |
|
|
An animation curve that groups child `Class.FloatCurve|FloatCurves` which each
|
|
animate a different component of a non-unary value. The
|
|
`Class.CompositeValueCurve.CurveType|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 `Enum.CompositeValueCurveType` value for
|
|
`Class.CompositeValueCurve.CurveType|CurveType`:
|
|
|
|
- `Enum.CompositeValueCurveType.ColorRGB|ColorRGB`: { `"R"`, `"G"`, `"B"` }
|
|
- `Enum.CompositeValueCurveType.ColorHSV|ColorHSV`: { `"H"`, `"S"`, `"V"` }
|
|
- `Enum.CompositeValueCurveType.NumberRange|NumberRange`: { `"Min"`, `"Max"` }
|
|
- `Enum.CompositeValueCurveType.Rect|Rect`: { `"MinX"`, `"MaxX"`, `"MinY"`,
|
|
`"MaxY"` }
|
|
- `Enum.CompositeValueCurveType.UDim|UDim`: { `"Scale"`, `"Offset"` }
|
|
- `Enum.CompositeValueCurveType.UDim2|UDim2`: { `"ScaleX"`, `"OffsetX"`,
|
|
`"ScaleY"`, `"OffsetY"` }
|
|
- `Enum.CompositeValueCurveType.Vector2|Vector2`: { `"X"`, `"Y"`}
|
|
- `Enum.CompositeValueCurveType.Vector3|Vector3`: { `"X"`, `"Y"`, `"Z"` }
|
|
|
|
The children that drive the animation can be accessed via the
|
|
`Class.CompositeValueCurve:GetComponentCurves()|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
|
|
`Class.CompositeValueCurve:GetValueAtTime()|GetValueAtTime()` method.
|
|
code_samples: []
|
|
inherits:
|
|
- Instance
|
|
descendants: []
|
|
tags: []
|
|
deprecation_message: ''
|
|
properties:
|
|
- name: CompositeValueCurve.CurveType
|
|
summary: |
|
|
The type of value animated by this `Class.CompositeValueCurve`.
|
|
description: |
|
|
The type of value animated by this `Class.CompositeValueCurve`. See
|
|
`Enum.CompositeValueCurveType` for options.
|
|
code_samples: []
|
|
type: CompositeValueCurveType
|
|
tags: []
|
|
deprecation_message: ''
|
|
security:
|
|
read: None
|
|
write: None
|
|
thread_safety: ReadSafe
|
|
category: Data
|
|
serialization:
|
|
can_load: true
|
|
can_save: true
|
|
capabilities:
|
|
- Basic
|
|
methods:
|
|
- name: CompositeValueCurve:GetValueAtTime
|
|
summary: |
|
|
Returns the sampled animated value at the passed `time` argument.
|
|
description: |
|
|
This method returns the sampled animated value at the passed `time`
|
|
argument. The type of the returned value will match that specified by the
|
|
`Class.CompositeValueCurve.CurveType|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 `Class.CompositeValueCurve.CurveType|CurveType` of
|
|
`Enum.CompositeValueCurveType.ColorRGB` but only one `Class.FloatCurve`
|
|
child named `"G"`, then the returned `Class.FloatCurve` will have values
|
|
of `0` for `"R"` and `"B"`, but the `"G"` value will be sampled from the
|
|
child curve.
|
|
code_samples: []
|
|
parameters:
|
|
- name: time
|
|
type: float
|
|
default:
|
|
summary: |
|
|
Time at which to get the value.
|
|
returns:
|
|
- type: Variant
|
|
summary: |
|
|
The value of the curve at the passed time.
|
|
tags: []
|
|
deprecation_message: ''
|
|
security: None
|
|
thread_safety: Unsafe
|
|
capabilities:
|
|
- Basic
|
|
- name: CompositeValueCurve:GetComponentCurves
|
|
summary: |
|
|
Returns the child curves with the given names for the
|
|
`Class.CompositeValueCurve.CurveType|CurveType` of this
|
|
`Class.CompositeValueCurve`.
|
|
description: |
|
|
This method returns the child curves with the given names for the
|
|
`Class.CompositeValueCurve.CurveType|CurveType` of this
|
|
`Class.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 `Class.FloatCurve`.
|
|
code_samples: []
|
|
parameters: []
|
|
returns:
|
|
- type: Instances
|
|
summary: ''
|
|
tags: []
|
|
deprecation_message: ''
|
|
security: None
|
|
thread_safety: Unsafe
|
|
capabilities:
|
|
- Basic
|
|
events: []
|
|
callbacks: []
|