Train Simulator NEXT
In This Topic
    GetAnimationDesc function
    In This Topic

    This function returns a description of an animation.

    Syntax

    Copy Code
    dict GetAnimationDesc( int AnimationIndex );

    Parameters

    AnimationIndex

    Type: int

    The animation index. Use GetAnimationCount or GetAnimationIndex to query a valid index.

    Returns

    Returns a dictionary with an animation descriptions. The content of the dictionary is

    Name Type Description
    CurrentKey float The current key of the animation.
    Duration float The duration of the animation in seconds.
    IsPlaying bool true if this animation is playing, false if not.
    KeyFrameTime float The duration of one single key in seconds.
    KeysPerSecond float The number of keys per second.
    Name string The name of the animation layer.
    NumOfKeys float The number of keys at all.
    Processing int The processing mode of the animation configuration.
    ProcessingBegin int The processing action at key 0 of the animation.
    ProcessingEnd int The processing action at key NumOfKeys of the animation.
    ReversePlaying bool true if the animation is playing backwards, false if not.
    TargetKey float The target key index between 0 and NumOfKeys.

    Returns an empty dictionary, if the animation was not found or an internal error occured.

    See Also