Sprite3D

2D Sprite node in 3D world.

A node that displays a 2D texture in a 3D environment. The texture displayed can be a region from a larger atlas texture, or a frame from a sprite sheet animation.

Members

Aliases

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

Functions

getFrame
long getFrame()
getHframes
long getHframes()
getRegionRect
Rect2 getRegionRect()
getTexture
Ref!Texture getTexture()
getVframes
long getVframes()
isRegion
bool isRegion()
opAssign
Sprite3D opAssign(T n)
Undocumented in source. Be warned that the author may not have intended to support it.
opEquals
bool opEquals(Sprite3D other)
Undocumented in source. Be warned that the author may not have intended to support it.
opEquals
bool opEquals(typeof(null) n)
Undocumented in source. Be warned that the author may not have intended to support it.
setFrame
void setFrame(long frame)
setHframes
void setHframes(long hframes)
setRegion
void setRegion(bool enabled)
setRegionRect
void setRegionRect(Rect2 rect)
setTexture
void setTexture(Texture texture)
setVframes
void setVframes(long vframes)

Mixins

__anonymous
mixin baseCasts
Undocumented in source.

Properties

frame
long frame [@property getter]
long frame [@property setter]

Current frame to display from sprite sheet. vframes or hframes must be greater than 1.

hframes
long hframes [@property getter]
long hframes [@property setter]

The number of columns in the sprite sheet.

regionEnabled
bool regionEnabled [@property getter]
bool regionEnabled [@property setter]

If true texture will be cut from a larger atlas texture. See regionRect. Default value: false.

regionRect
Rect2 regionRect [@property getter]
Rect2 regionRect [@property setter]

The region of the atlas texture to display. regionEnabled must be true.

texture
Texture texture [@property getter]
Texture texture [@property setter]

Texture object to draw.

vframes
long vframes [@property getter]
long vframes [@property setter]

The number of rows in the sprite sheet.

Static functions

_new
Sprite3D _new()
Undocumented in source. Be warned that the author may not have intended to support it.

Static variables

_classBindingInitialized
bool _classBindingInitialized;
Undocumented in source.

Structs

_classBinding
struct _classBinding
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
To as()
Undocumented in source. Be warned that the author may not have intended to support it.
as
To as()
Undocumented in source. Be warned that the author may not have intended to support it.
as
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