docs.unity3d.com
    Show / Hide Table of Contents

    Class StoryboardPlayableAsset

    The StoryboardPlayableAsset represents a Storyboard frame to use in the StoryboardTrack.

    Inheritance
    Object
    StoryboardPlayableAsset
    Namespace: UnityEngine.Sequences.Timeline
    Syntax
    public class StoryboardPlayableAsset : PlayableAsset, ITimelineClipAsset

    Fields

    alpha

    The opacity of the board image. By default it is 50% transparent.

    Declaration
    public float alpha
    Field Value
    Type Description
    Single

    board

    The board image to display.

    Declaration
    public Texture board
    Field Value
    Type Description
    Texture

    horizontalFlip

    Whether to horizontally flip the board image or not.

    Declaration
    public bool horizontalFlip
    Field Value
    Type Description
    Boolean

    position

    The board image position. By default it is centered.

    Declaration
    public Vector2 position
    Field Value
    Type Description
    Vector2

    scale

    The board image scale.

    Declaration
    public Vector2 scale
    Field Value
    Type Description
    Vector2

    showBoard

    Whether to display this specific board image or not.

    Declaration
    public bool showBoard
    Field Value
    Type Description
    Boolean

    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
    public bool syncScale
    Field Value
    Type Description
    Boolean

    verticalFlip

    Whether to vertically flip the board image or not.

    Declaration
    public bool verticalFlip
    Field Value
    Type Description
    Boolean

    zRotation

    The board image Z rotation (tilt).

    Declaration
    public float zRotation
    Field Value
    Type Description
    Single

    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.

    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023