Struct gdnative::SpriteFrames

pub struct SpriteFrames { /* fields omitted */ }

core class SpriteFrames inherits Resource (reference counted).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Memory management

The lifetime of this object is automatically managed through reference counting.

Class hierarchy

SpriteFrames inherits methods from:

• Resource
• Reference
• Object

Methods

impl SpriteFrames

pub fn new() -> SpriteFrames

pub fn new_ref(&self) -> SpriteFrames

Creates a new reference to the same reference-counted object.

pub fn _get_animations(&self) -> VariantArray

pub fn _get_frames(&self) -> VariantArray

pub fn _set_animations(&mut self, arg0: VariantArray)

pub fn _set_frames(&mut self, arg0: VariantArray)

pub fn add_animation(&mut self, anim: GodotString)

pub fn add_frame(
    &mut self,
    anim: GodotString,
    frame: Option<Texture>,
    at_position: i64
)

pub fn clear(&mut self, anim: GodotString)

pub fn clear_all(&mut self)

pub fn get_animation_loop(&self, anim: GodotString) -> bool

pub fn get_animation_names(&self) -> StringArray

pub fn get_animation_speed(&self, anim: GodotString) -> f64

pub fn get_frame(&self, anim: GodotString, idx: i64) -> Option<Texture>

pub fn get_frame_count(&self, anim: GodotString) -> i64

pub fn has_animation(&self, anim: GodotString) -> bool

pub fn remove_animation(&mut self, anim: GodotString)

pub fn remove_frame(&mut self, anim: GodotString, idx: i64)

pub fn rename_animation(&mut self, anim: GodotString, newname: GodotString)

pub fn set_animation_loop(&mut self, anim: GodotString, _loop: bool)

pub fn set_animation_speed(&mut self, anim: GodotString, speed: f64)

pub fn set_frame(&mut self, anim: GodotString, idx: i64, txt: Option<Texture>)

pub fn to_resource(&self) -> Resource

Up-cast.

pub fn to_reference(&self) -> Reference

Up-cast.

pub fn to_object(&self) -> Object

Up-cast.

pub fn cast<T>(&self) -> Option<T> where
    T: GodotObject, 

Generic dynamic cast.

Methods from Deref<Target = Resource>

pub fn new_ref(&self) -> Resource

Creates a new reference to the same reference-counted object.

pub fn _setup_local_to_scene(&mut self)

pub fn duplicate(&self, subresources: bool) -> Option<Resource>

pub fn get_local_scene(&self) -> Option<Node>

pub fn get_name(&self) -> GodotString

pub fn get_path(&self) -> GodotString

pub fn get_rid(&self) -> Rid

pub fn is_local_to_scene(&self) -> bool

pub fn set_local_to_scene(&mut self, enable: bool)

pub fn set_name(&mut self, name: GodotString)

pub fn set_path(&mut self, path: GodotString)

pub fn setup_local_to_scene(&mut self)

pub fn take_over_path(&mut self, path: GodotString)

pub fn init_ref(&mut self) -> bool

Inherited from Reference.

pub fn to_reference(&self) -> Reference

Up-cast.

pub fn to_object(&self) -> Object

Up-cast.

pub fn cast<T>(&self) -> Option<T> where
    T: GodotObject, 

Generic dynamic cast.

Trait Implementations

impl Clone for SpriteFrames

fn clone(&self) -> SpriteFrames

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SpriteFrames

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl Deref for SpriteFrames

type Target = Resource

The resulting type after dereferencing.

fn deref(&self) -> &Resource

Dereferences the value.

impl DerefMut for SpriteFrames

fn deref_mut(&mut self) -> &mut Resource

Mutably dereferences the value.

impl Drop for SpriteFrames

fn drop(&mut self)

Executes the destructor for this type.

impl FromVariant for SpriteFrames

fn from_variant(variant: &Variant) -> Result<SpriteFrames, FromVariantError>

impl GodotObject for SpriteFrames

fn class_name() -> &'static str

unsafe fn from_sys(obj: *mut c_void) -> SpriteFrames

unsafe fn from_return_position_sys(obj: *mut c_void) -> SpriteFrames

unsafe fn to_sys(&self) -> *mut c_void

impl Instanciable for SpriteFrames

fn construct() -> SpriteFrames

impl ToVariant for SpriteFrames

fn to_variant(&self) -> Variant