Click or drag to resize

AnimatedSprite3D Properties

The AnimatedSprite3D type exposes the following members.

Properties
  NameDescription
Public property_ImportPath (Inherited from Node.)
Public propertyAlphaCut (Inherited from SpriteBase3D.)
Public propertyAnimation

The current animation from the frames resource. If this value changes, the frame counter is reset.

Public propertyAxis

The direction in which the front of the texture faces.

(Inherited from SpriteBase3D.)
Public propertyBillboard (Inherited from SpriteBase3D.)
Public propertyCastShadow (Inherited from GeometryInstance.)
Public propertyCentered

If true, texture will be centered.

(Inherited from SpriteBase3D.)
Public propertyCustomMultiplayer

The override to the default MultiplayerAPI. Set to null to use the default SceneTree one.

(Inherited from Node.)
Public propertyDoubleSided

If true, texture can be seen from the back as well, if false, it is invisible when looking at it from behind.

(Inherited from SpriteBase3D.)
Public propertyDynamicObject
Gets a new DynamicGodotObject associated with this instance.
(Inherited from Object.)
Public propertyEditorDescription (Inherited from Node.)
Public propertyExtraCullMargin

The extra distance added to the GeometryInstance's bounding box (AABB) to increase its cull box.

(Inherited from GeometryInstance.)
Public propertyFilename

When a scene is instanced from a file, its topmost node contains the filename from which it was loaded.

(Inherited from Node.)
Public propertyFlipH

If true, texture is flipped horizontally.

(Inherited from SpriteBase3D.)
Public propertyFlipV

If true, texture is flipped vertically.

(Inherited from SpriteBase3D.)
Public propertyFrame

The displayed animation frame's index.

Public propertyFrames

The SpriteFrames resource containing the animation(s).

Public propertyGenerateLightmap

When disabled, the mesh will be taken into account when computing indirect lighting, but the resulting lightmap will not be saved. Useful for emissive only materials or shadow casters.

(Inherited from GeometryInstance.)
Public propertyGizmo

The SpatialGizmo for this node. Used for example in [!:Godot.EditorSpatialGizmo] as custom visualization and editing handles in Editor.

(Inherited from Spatial.)
Public propertyGlobalTransform

World space (global) Transform of this node.

(Inherited from Spatial.)
Public propertyLayers

The render layer(s) this VisualInstance is drawn on.

This object will only be visible for Cameras whose cull mask includes the render object this VisualInstance is set to.

(Inherited from VisualInstance.)
Public propertyLightmapScale

Scale factor for the generated baked lightmap. Useful for adding detail to certain mesh instances.

(Inherited from GeometryInstance.)
Public propertyLodMaxDistance

The GeometryInstance's max LOD distance.

Note: This property currently has no effect.

(Inherited from GeometryInstance.)
Public propertyLodMaxHysteresis

The GeometryInstance's max LOD margin.

Note: This property currently has no effect.

(Inherited from GeometryInstance.)
Public propertyLodMinDistance

The GeometryInstance's min LOD distance.

Note: This property currently has no effect.

(Inherited from GeometryInstance.)
Public propertyLodMinHysteresis

The GeometryInstance's min LOD margin.

Note: This property currently has no effect.

(Inherited from GeometryInstance.)
Public propertyMaterialOverride

The material override for the whole geometry.

If a material is assigned to this property, it will be used instead of any material set in any material slot of the mesh.

(Inherited from GeometryInstance.)
Public propertyModulate

A color value that gets multiplied on, could be used for mood-coloring or to simulate the color of light.

(Inherited from SpriteBase3D.)
Public propertyMultiplayer

The MultiplayerAPI instance associated with this node. Either the CustomMultiplayer, or the default SceneTree one (if inside tree).

(Inherited from Node.)
Public propertyName

The name of the node. This name is unique among the siblings (other child nodes from the same parent). When set to an existing name, the node will be automatically renamed.

Note: Auto-generated names might include the @ character, which is reserved for unique names when using AddChild(Node, Boolean). When setting the name manually, any @ will be removed.

(Inherited from Node.)
Public propertyNativeInstance (Inherited from Object.)
Public propertyOffset

The texture's drawing offset.

(Inherited from SpriteBase3D.)
Public propertyOpacity

The objects' visibility on a scale from 0 fully invisible to 1 fully visible.

(Inherited from SpriteBase3D.)
Public propertyOwner

The node owner. A node can have any other node as owner (as long as it is a valid parent, grandparent, etc. ascending in the tree). When saving a node (using PackedScene), all the nodes it owns will be saved with it. This allows for the creation of complex SceneTrees, with instancing and subinstancing.

(Inherited from Node.)
Public propertyPauseMode

Pause mode. How the node will behave if the SceneTree is paused.

(Inherited from Node.)
Public propertyPixelSize

The size of one pixel's width on the sprite to scale it in 3D.

(Inherited from SpriteBase3D.)
Public propertyPlaying

If true, the Animation is currently playing.

Public propertyProcessPriority

The node's priority in the execution order of the enabled processing callbacks (i.e. , and their internal counterparts). Nodes whose process priority value is lower will have their processing callbacks executed first.

(Inherited from Node.)
Public propertyRotation

Rotation part of the local transformation in radians, specified in terms of YXZ-Euler angles in the format (X angle, Y angle, Z angle).

Note: In the mathematical sense, rotation is a matrix and not a vector. The three Euler angles, which are the three independent parameters of the Euler-angle parametrization of the rotation matrix, are stored in a Vector3 data structure not because the rotation is a vector, but only because Vector3 exists as a convenient data-structure to store 3 floating-point numbers. Therefore, applying affine operations on the rotation "vector" is not meaningful.

(Inherited from Spatial.)
Public propertyRotationDegrees

Rotation part of the local transformation in degrees, specified in terms of YXZ-Euler angles in the format (X angle, Y angle, Z angle).

(Inherited from Spatial.)
Public propertyScale

Scale part of the local transformation.

(Inherited from Spatial.)
Public propertyShaded

If true, the Light in the Environment has effects on the sprite.

(Inherited from SpriteBase3D.)
Public propertyTransform

Local space Transform of this node, with respect to the parent node.

(Inherited from Spatial.)
Public propertyTranslation

Local translation of this node.

(Inherited from Spatial.)
Public propertyTransparent

If true, the texture's transparency and the opacity are used to make those parts of the sprite invisible.

(Inherited from SpriteBase3D.)
Public propertyUseInBakedLight

If true, this GeometryInstance will be used when baking lights using a GIProbe or BakedLightmap.

(Inherited from GeometryInstance.)
Public propertyVisible

If true, this node is drawn. The node is only visible if all of its antecedents are visible as well (in other words, IsVisibleInTree must return true).

(Inherited from Spatial.)
Top
See Also