AnimatedSprite3D

2D sprite node in 3D world, that can use multiple 2D textures for animation.

Animations are created using a SpriteFrames resource, which can be configured in the editor via the SpriteFrames panel.

@GodotBaseClass

struct AnimatedSprite3D {

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

package @nogc nothrow __gshared

bool _classBindingInitialized;

struct GDNativeClassBinding;

bool opEquals(AnimatedSprite3D other);

typeof(null) opAssign(typeof(null) n);

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static AnimatedSprite3D _new();

bool _isPlaying();

void _resChanged();

void _setPlaying(bool playing);

String getAnimation();

long getFrame();

Ref!SpriteFrames getSpriteFrames();

bool isPlaying();

void play(String anim);

void setAnimation(String animation);

void setFrame(long frame);

void setSpriteFrames(SpriteFrames sprite_frames);

String animation [@property getter];

String animation [@property setter];

long frame [@property getter];

long frame [@property setter];

SpriteFrames frames [@property getter];

SpriteFrames frames [@property setter];

bool playing [@property getter];

bool playing [@property setter];

}

Members

Aliases

BaseClasses alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses): Undocumented in source.

Functions

_isPlaying bool _isPlaying()
_resChanged void _resChanged()
_setPlaying void _setPlaying(bool playing)
getAnimation String getAnimation()
getFrame long getFrame()
getSpriteFrames Ref!SpriteFrames getSpriteFrames()
isPlaying bool isPlaying(): Returns true if an animation is currently being played.
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(AnimatedSprite3D other)
opEquals bool opEquals(typeof(null) n)
play void play(String anim): Plays the animation named anim. If no anim is provided, the current animation is played.
setAnimation void setAnimation(String animation)
setFrame void setFrame(long frame)
setSpriteFrames void setSpriteFrames(SpriteFrames sprite_frames)
stop void stop(): Stops the current animation (does not reset the frame counter).
toHash size_t toHash()

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

animation String animation [@property getter]
String animation [@property setter]: The current animation from the frames resource. If this value changes, the frame counter is reset.
frame long frame [@property getter]
long frame [@property setter]: The displayed animation frame's index.
frames SpriteFrames frames [@property getter]
SpriteFrames frames [@property setter]: The SpriteFrames resource containing the animation(s).
playing bool playing [@property getter]
bool playing [@property setter]: If true, the animation is currently playing.

Static functions

_new AnimatedSprite3D _new(): Construct a new instance of AnimatedSprite3D. Note: use memnew!AnimatedSprite3D instead.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

GDNativeClassBinding struct GDNativeClassBinding: Undocumented in source.

Unions

__anonymous union __anonymous: Undocumented in source.

Variables

_GODOT_internal_name enum string _GODOT_internal_name;: Undocumented in source.

Mixed In Members

From `mixin baseCasts`

as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(ToRef) as(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast template opCast(To): Undocumented in source.
opCast template opCast(To): Undocumented in source.
opCast template opCast(ToRef): Undocumented in source.
opCast void* opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast godot_object opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.

Meta

Source

See Implementation

godot animatedsprite3d structs

AnimatedSprite3D