Struct SpriteBase3D

2D sprite node in 3D environment.

struct SpriteBase3D ;

A node that displays 2D texture information in a 3D environment.

Properties

NameTypeDescription
alphaCut[get, set] SpriteBase3D.AlphaCutMode
axis[get, set] godot.core.vector3.Vector3.AxisThe direction in which the front of the texture faces.
billboard[get, set] SpatialMaterial.BillboardMode
centered[get, set] boolIf true, texture will be centered.
doubleSided[get, set] boolIf true, texture can be seen from the back as well, if false, it is invisible when looking at it from behind.
flipH[get, set] boolIf true, texture is flipped horizontally.
flipV[get, set] boolIf true, texture is flipped vertically.
modulate[get, set] ColorA color value that gets multiplied on, could be used for mood-coloring or to simulate the color of light.
offset[get, set] Vector2The texture's drawing offset.
opacity[get, set] doubleThe objects visibility on a scale from 0 fully invisible to 1 fully visible.
pixelSize[get, set] doubleThe size of one pixel's width on the sprite to scale it in 3D.
shaded[get, set] boolIf true, the Light in the Environment has effects on the sprite.
transparent[get, set] boolIf true, the texture's transparency and the opacity are used to make those parts of the sprite invisible.

Methods

NameDescription
_imUpdate
_queueUpdate
generateTriangleMesh
getAlphaCutMode
getAxis
getBillboardMode
getDrawFlag
getItemRect
getModulate
getOffset
getOpacity
getPixelSize
isCentered
isFlippedH
isFlippedV
setAlphaCutMode
setAxis
setBillboardMode
setCentered
setDrawFlag
setFlipH
setFlipV
setModulate
setOffset
setOpacity
setPixelSize

Enums

NameDescription
AlphaCutMode
Constants
DrawFlags