Sprite3D

Conformances

• protocol CustomStringConvertible

  A type with a customized textual representation.

• protocol Equatable

  A type that can be compared for value equality.

• protocol Hashable

  A type that can be hashed into a Hasher to produce an integer hash value.

• protocol Identifiable<ID>

  A class of types whose instances hold the value of an entity with stable identity.

• protocol VariantRepresentable

  Types that conform to VariantRepresentable can be stored directly in Variant with no conversion. These include all of the Variant types from Godot (for example GString, Rect, Plane), Godot objects (those that subclass SwiftGodot.Object) as well as the built-in Swift types UInt8, Int64 and Double.

• protocol VariantStorable

  Types that conform to VariantStorable can be stored in a Variant and can be extracted back out of a Variant.

Type members

• class var godotClassName: StringName

Instance members

• var frame: Int32

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

• var frameChanged: SimpleSignal

  Emitted when the frame changes.

• var frameCoords: Vector2i

  Coordinates of the frame to display from sprite sheet. This is as an alias for the frame property. hframes or vframes must be greater than 1.

• var hframes: Int32

  The number of columns in the sprite sheet.

• var regionEnabled: Bool

  If true, the sprite will use regionRect and display only the specified part of its texture.

• var regionRect: Rect2

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

• var texture: Texture2D?

  Texture2D object to draw. If materialOverride is used, this will be overridden. The size information is still used.

• var textureChanged: SimpleSignal

  Emitted when the texture changes.

• var vframes: Int32

  The number of rows in the sprite sheet.