Class StoryboardPlayableAsset
The StoryboardPlayableAsset represents a Storyboard frame to use in the StoryboardTrack.
Inherited Members
Namespace: UnityEngine.Sequences.Timeline
Assembly: Unity.Sequences.dll
Syntax
public class StoryboardPlayableAsset : PlayableAsset, IPlayableAsset, ITimelineClipAssetFields
alpha
The opacity of the board image. By default it is 50% transparent.
Declaration
[Tooltip("The opacity of the board. 0 is transparent, 1 is opaque")]
[Range(0, 1)]
[SerializeField]
public float alphaField Value
| Type | Description |
|---|---|
| float |
board
The board image to display.
Declaration
[Tooltip("The board to be displayed")]
[SerializeField]
public Texture boardField Value
| Type | Description |
|---|---|
| Texture |
horizontalFlip
Whether to horizontally flip the board image or not.
Declaration
[Tooltip("If checked, the board will be flipped horizontally")]
public bool horizontalFlipField Value
| Type | Description |
|---|---|
| bool |
position
The board image position. By default it is centered.
Declaration
[Tooltip("The screen-space position at which to display the board. Zero is center")]
[SerializeField]
public Vector2 positionField Value
| Type | Description |
|---|---|
| Vector2 |
scale
The board image scale.
Declaration
[Tooltip("The screen-space scaling to apply to the board")]
[Min(0)]
public Vector2 scaleField Value
| Type | Description |
|---|---|
| Vector2 |
showBoard
Whether to display this specific board image or not.
Declaration
[Tooltip("If checked, the specified board will be displayed as an overlay over the virtual camera's output")]
[SerializeField]
public bool showBoardField Value
| Type | Description |
|---|---|
| bool |
syncScale
Whether to lock the aspect ratio of the board image or not. By default, the aspect ratio is locked to preserve the original image proportions.
Declaration
[Tooltip("If checked, X and Y scale are synchronized")]
public bool syncScaleField Value
| Type | Description |
|---|---|
| bool |
verticalFlip
Whether to vertically flip the board image or not.
Declaration
[Tooltip("If checked, the board will be flipped vertically")]
public bool verticalFlipField Value
| Type | Description |
|---|---|
| bool |
zRotation
The board image Z rotation (tilt).
Declaration
[Tooltip("The z-axis rotation to apply to the board")]
[SerializeField]
[Range(-180, 180)]
public float zRotationField Value
| Type | Description |
|---|---|
| float |
Properties
clipCaps
Get the clip capabilities. For StoryboardPlayableAsset, no extra Clip caps are available.
Declaration
public ClipCaps clipCaps { get; }Property Value
| Type | Description |
|---|---|
| ClipCaps |
Methods
CreatePlayable(PlayableGraph, GameObject)
Implement this method to have your asset inject playables into the given graph.
Declaration
public override Playable CreatePlayable(PlayableGraph graph, GameObject owner)Parameters
| Type | Name | Description |
|---|---|---|
| PlayableGraph | graph | The graph to inject playables into. |
| GameObject | owner | The game object which initiated the build. |
Returns
| Type | Description |
|---|---|
| Playable | The playable injected into the graph, or the root playable if multiple playables are injected. |