reckfellENGINE

AnimationLibrary

Container for Animation resources.

On this page
class AnimationLibraryReckfellSharpInherits Resource

Container for Animation resources.

An animation library stores a set of animations accessible through StringName keys, for use with AnimationPlayer nodes.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

AnimationLibraryConstructor
# AnimationLibrary
C#
public AnimationLibrary();

Properties1

_DataProperty
# _Data
C#
public Reckfell.Collections.Dictionary _Data { get; set; }

Methods7

AddAnimationError
# AddAnimation
C#
public Error AddAnimation(StringName name, Animation animation);

Adds the animation to the library, accessible by the key name.

Parameters
NameTypeDefault
nameStringName—
animationAnimation—
Returns Error
GetAnimationAnimation
# GetAnimation
C#
public Animation GetAnimation(StringName name);

Returns the Animation with the key name. If the animation does not exist, null is returned and an error is logged.

Parameters
NameTypeDefault
nameStringName—
Returns Animation
GetAnimationListReckfell.Collections.Array<StringName>
# GetAnimationList
C#
public Reckfell.Collections.Array<StringName> GetAnimationList();

Returns the keys for the Animations stored in the library.

Returns Reckfell.Collections.Array<StringName>
GetAnimationListSizeint
# GetAnimationListSize
C#
public int GetAnimationListSize();

Returns the key count for the Animations stored in the library.

Returns int
HasAnimationbool
# HasAnimation
C#
public bool HasAnimation(StringName name);

Returns true if the library stores an Animation with name as the key.

Parameters
NameTypeDefault
nameStringName—
Returns bool
RemoveAnimationvoid
# RemoveAnimation
C#
public void RemoveAnimation(StringName name);

Removes the Animation with the key name.

Parameters
NameTypeDefault
nameStringName—
RenameAnimationvoid
# RenameAnimation
C#
public void RenameAnimation(StringName name, StringName newname);

Changes the key of the Animation associated with the key name to newname.

Parameters
NameTypeDefault
nameStringName—
newnameStringName—

Signals and events4

AnimationAddedEvent
# AnimationAdded
C#
public event AnimationLibrary.AnimationAddedEventHandler AnimationAdded;

Emitted when an Animation is added, under the key anim_name.

Handler parameters
NameTypeDefault
animNameStringName—
AnimationChangedEvent
# AnimationChanged
C#
public event AnimationLibrary.AnimationChangedEventHandler AnimationChanged;

Emitted when there's a change in one of the animations, e.g. tracks are added, moved or have changed paths. anim_name is the key of the animation that was changed. See also Resource.Changed, which this acts as a relay for.

Handler parameters
NameTypeDefault
animNameStringName—
AnimationRemovedEvent
# AnimationRemoved
C#
public event AnimationLibrary.AnimationRemovedEventHandler AnimationRemoved;

Emitted when an Animation stored with the key anim_name is removed.

Handler parameters
NameTypeDefault
animNameStringName—
AnimationRenamedEvent
# AnimationRenamed
C#
public event AnimationLibrary.AnimationRenamedEventHandler AnimationRenamed;

Emitted when the key for an Animation is changed, from old_name to new_name.

Handler parameters
NameTypeDefault
oldNameStringName—
newNameStringName—
Reckfell Engine documentationBack to top ↑
QUICK LINKSGetting startedEntity hierarchyC# & .NET 10Scenes and prefabs
Reckfell guides and full API K
reckfellENGINE
RECKFELL ACCOUNT

Sign in

Sign in to your Reckfell account.

One account for the entire Reckfell platform.