s&box docs
API ReferenceSandbox

AnimationBuilderclass

Builds an animation for a `Sandbox.Model`.

object→AnimationBuilder
Namespace
Sandbox
Assembly
Sandbox.Engine
Declaration
public sealed class Sandbox.AnimationBuilder

Methods7

Showing 7 methods

public Sandbox.AnimationBuilder WithDelta(bool delta = True)PUBLIC

Sets whether the animation is applied additively on top of the base pose.

ParameterTypeDescription
delta = TrueboolWhether the animation should be additive.
Returns:AnimationBuilder—

public Sandbox.AnimationBuilder WithFrameRate(float frameRate)PUBLIC

Sets the frames per second of the animation.

ParameterTypeDescription
frameRatefloatThe playback frame rate.
Returns:AnimationBuilder—

public Sandbox.AnimationBuilder WithInterpolationDisabled(bool disableInterpolation = True)PUBLIC

Sets whether interpolation between frames is disabled.

ParameterTypeDescription
disableInterpolation = TrueboolWhether frame interpolation should be disabled.
Returns:AnimationBuilder—

public Sandbox.AnimationBuilder WithLooping(bool looping = True)PUBLIC

Sets whether the animation loops.

ParameterTypeDescription
looping = TrueboolWhether the animation should loop.
Returns:AnimationBuilder—

public Sandbox.AnimationBuilder WithName(string name)PUBLIC

Sets the name of the animation.

ParameterTypeDescription
namestringThe animation name.
Returns:AnimationBuilder—

Properties6

Showing 6 properties

public bool Sandbox.AnimationBuilder.Delta { get; set; }PUBLICGETSET

Whether the animation is applied additively on top of the base pose.

Returns:bool—

public bool Sandbox.AnimationBuilder.DisableInterpolation { get; set; }PUBLICGETSET

Whether interpolation between frames is disabled.

Returns:bool—

public int Sandbox.AnimationBuilder.FrameCount { get; set; }PUBLICGETSET

The number of frames in the animation.

Returns:int—

public float Sandbox.AnimationBuilder.FrameRate { get; set; }PUBLICGETSET

The frames per second of the animation.

Returns:float—

public bool Sandbox.AnimationBuilder.Looping { get; set; }PUBLICGETSET

Whether the animation loops.

Returns:bool—

public string Sandbox.AnimationBuilder.Name { get; set; }PUBLICGETSET

The name of the animation.

Returns:string—

Render()

Previous Page

Delta

Next Page

On this page

Methodspublic Sandbox.AnimationBuilder AddFrame(System.Collections.Generic.List`1<Transform> boneTransforms)public Sandbox.AnimationBuilder AddFrame(System.Span`1<Transform> boneTransforms)public Sandbox.AnimationBuilder WithDelta(System.Boolean delta = True)public Sandbox.AnimationBuilder WithFrameRate(System.Single frameRate)public Sandbox.AnimationBuilder WithInterpolationDisabled(System.Boolean disableInterpolation = True)public Sandbox.AnimationBuilder WithLooping(System.Boolean looping = True)public Sandbox.AnimationBuilder WithName(System.String name)Propertiespublic System.Boolean Sandbox.AnimationBuilder.Delta { get; set; }public System.Boolean Sandbox.AnimationBuilder.DisableInterpolation { get; set; }public System.Int32 Sandbox.AnimationBuilder.FrameCount { get; set; }public System.Single Sandbox.AnimationBuilder.FrameRate { get; set; }public System.Boolean Sandbox.AnimationBuilder.Looping { get; set; }public System.String Sandbox.AnimationBuilder.Name { get; set; }Metadata