Struct TileSetAtlasSource

#[repr(C)]
pub struct TileSetAtlasSource { /* private fields */ }

Godot class TileSetAtlasSource.

Inherits TileSetSource.

Related symbols:

• tile_set_atlas_source: sidecar module with related enum/flag types
• ITileSetAtlasSource: virtual methods

See also Godot docs for TileSetAtlasSource.

Construction

This class is reference-counted. You can create a new instance using TileSetAtlasSource::new_gd().

Implementations

impl TileSetAtlasSource

pub const TRANSFORM_FLIP_H: i32 = 4_096i32

pub const TRANSFORM_FLIP_V: i32 = 8_192i32

pub const TRANSFORM_TRANSPOSE: i32 = 16_384i32

pub fn set_texture(&mut self, texture: impl AsObjectArg<Texture2D>)

pub fn get_texture(&self) -> Option<Gd<Texture2D>>

pub fn set_margins(&mut self, margins: Vector2i)

pub fn get_margins(&self) -> Vector2i

pub fn set_separation(&mut self, separation: Vector2i)

pub fn get_separation(&self) -> Vector2i

pub fn set_texture_region_size(&mut self, texture_region_size: Vector2i)

pub fn get_texture_region_size(&self) -> Vector2i

pub fn set_use_texture_padding(&mut self, use_texture_padding: bool)

pub fn get_use_texture_padding(&self) -> bool

pub fn create_tile(&mut self, atlas_coords: Vector2i)

To set the default parameters, use Self::create_tile_ex and its builder methods. See the book for detailed usage instructions.

pub fn create_tile_ex<'a>( &'a mut self, atlas_coords: Vector2i, ) -> ExCreateTile<'a>

pub fn remove_tile(&mut self, atlas_coords: Vector2i)

pub fn move_tile_in_atlas(&mut self, atlas_coords: Vector2i)

To set the default parameters, use Self::move_tile_in_atlas_ex and its builder methods. See the book for detailed usage instructions.

pub fn move_tile_in_atlas_ex<'a>( &'a mut self, atlas_coords: Vector2i, ) -> ExMoveTileInAtlas<'a>

pub fn get_tile_size_in_atlas(&self, atlas_coords: Vector2i) -> Vector2i

pub fn has_room_for_tile( &self, atlas_coords: Vector2i, size: Vector2i, animation_columns: i32, animation_separation: Vector2i, frames_count: i32, ) -> bool

To set the default parameters, use Self::has_room_for_tile_ex and its builder methods. See the book for detailed usage instructions.

pub fn has_room_for_tile_ex<'a>( &'a self, atlas_coords: Vector2i, size: Vector2i, animation_columns: i32, animation_separation: Vector2i, frames_count: i32, ) -> ExHasRoomForTile<'a>

pub fn get_tiles_to_be_removed_on_change( &mut self, texture: impl AsObjectArg<Texture2D>, margins: Vector2i, separation: Vector2i, texture_region_size: Vector2i, ) -> PackedVector2Array

pub fn get_tile_at_coords(&self, atlas_coords: Vector2i) -> Vector2i

pub fn has_tiles_outside_texture(&self) -> bool

pub fn clear_tiles_outside_texture(&mut self)

pub fn set_tile_animation_columns( &mut self, atlas_coords: Vector2i, frame_columns: i32, )

pub fn get_tile_animation_columns(&self, atlas_coords: Vector2i) -> i32

pub fn set_tile_animation_separation( &mut self, atlas_coords: Vector2i, separation: Vector2i, )

pub fn get_tile_animation_separation(&self, atlas_coords: Vector2i) -> Vector2i

pub fn set_tile_animation_speed(&mut self, atlas_coords: Vector2i, speed: f32)

pub fn get_tile_animation_speed(&self, atlas_coords: Vector2i) -> f32

pub fn set_tile_animation_mode( &mut self, atlas_coords: Vector2i, mode: TileAnimationMode, )

pub fn get_tile_animation_mode( &self, atlas_coords: Vector2i, ) -> TileAnimationMode

pub fn set_tile_animation_frames_count( &mut self, atlas_coords: Vector2i, frames_count: i32, )

pub fn get_tile_animation_frames_count(&self, atlas_coords: Vector2i) -> i32

pub fn set_tile_animation_frame_duration( &mut self, atlas_coords: Vector2i, frame_index: i32, duration: f32, )

pub fn get_tile_animation_frame_duration( &self, atlas_coords: Vector2i, frame_index: i32, ) -> f32

pub fn get_tile_animation_total_duration(&self, atlas_coords: Vector2i) -> f32

pub fn create_alternative_tile(&mut self, atlas_coords: Vector2i) -> i32

To set the default parameters, use Self::create_alternative_tile_ex and its builder methods. See the book for detailed usage instructions.

pub fn create_alternative_tile_ex<'a>( &'a mut self, atlas_coords: Vector2i, ) -> ExCreateAlternativeTile<'a>

pub fn remove_alternative_tile( &mut self, atlas_coords: Vector2i, alternative_tile: i32, )

pub fn set_alternative_tile_id( &mut self, atlas_coords: Vector2i, alternative_tile: i32, new_id: i32, )

pub fn get_next_alternative_tile_id(&self, atlas_coords: Vector2i) -> i32

pub fn get_tile_data( &self, atlas_coords: Vector2i, alternative_tile: i32, ) -> Option<Gd<TileData>>

pub fn get_atlas_grid_size(&self) -> Vector2i

pub fn get_tile_texture_region(&self, atlas_coords: Vector2i) -> Rect2i

To set the default parameters, use Self::get_tile_texture_region_ex and its builder methods. See the book for detailed usage instructions.

pub fn get_tile_texture_region_ex<'a>( &'a self, atlas_coords: Vector2i, ) -> ExGetTileTextureRegion<'a>

pub fn get_runtime_texture(&self) -> Option<Gd<Texture2D>>

pub fn get_runtime_tile_texture_region( &self, atlas_coords: Vector2i, frame: i32, ) -> Rect2i

Methods from Deref<Target = TileSetSource>

pub fn get_tiles_count(&self) -> i32

pub fn get_tile_id(&self, index: i32) -> Vector2i

pub fn has_tile(&self, atlas_coords: Vector2i) -> bool

pub fn get_alternative_tiles_count(&self, atlas_coords: Vector2i) -> i32

pub fn get_alternative_tile_id(&self, atlas_coords: Vector2i, index: i32) -> i32

pub fn has_alternative_tile( &self, atlas_coords: Vector2i, alternative_tile: i32, ) -> bool

Methods from Deref<Target = Resource>

pub fn set_path(&mut self, path: impl AsArg<GString>)

pub fn take_over_path(&mut self, path: impl AsArg<GString>)

pub fn get_path(&self) -> GString

pub fn set_name(&mut self, name: impl AsArg<GString>)

pub fn get_name(&self) -> GString

pub fn get_rid(&self) -> Rid

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

pub fn is_local_to_scene(&self) -> bool

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

pub fn setup_local_to_scene(&mut self)

pub fn set_scene_unique_id(&mut self, id: impl AsArg<GString>)

pub fn get_scene_unique_id(&self) -> GString

pub fn emit_changed(&mut self)

pub fn duplicate(&self) -> Option<Gd<Resource>>

To set the default parameters, use Self::duplicate_ex and its builder methods. See the book for detailed usage instructions.

pub fn duplicate_ex<'a>(&'a self) -> ExDuplicate<'a>

Methods from Deref<Target = RefCounted>

pub fn get_reference_count(&self) -> i32

Methods from Deref<Target = Object>

pub fn get_class(&self) -> GString

pub fn is_class(&self, class: impl AsArg<GString>) -> bool

pub fn set(&mut self, property: impl AsArg<StringName>, value: &Variant)

pub fn get(&self, property: impl AsArg<StringName>) -> Variant

pub fn set_indexed( &mut self, property_path: impl AsArg<NodePath>, value: &Variant, )

pub fn get_indexed(&self, property_path: impl AsArg<NodePath>) -> Variant

pub fn get_property_list(&self) -> Array<Dictionary>

pub fn get_method_list(&self) -> Array<Dictionary>

pub fn property_can_revert(&self, property: impl AsArg<StringName>) -> bool

pub fn property_get_revert(&self, property: impl AsArg<StringName>) -> Variant

pub fn set_script(&mut self, script: &Variant)

pub fn get_script(&self) -> Variant

pub fn set_meta(&mut self, name: impl AsArg<StringName>, value: &Variant)

pub fn remove_meta(&mut self, name: impl AsArg<StringName>)

pub fn get_meta(&self, name: impl AsArg<StringName>) -> Variant

To set the default parameters, use Self::get_meta_ex and its builder methods. See the book for detailed usage instructions.

pub fn get_meta_ex<'a>( &'a self, name: impl AsArg<StringName> + 'a, ) -> ExGetMeta<'a>

pub fn has_meta(&self, name: impl AsArg<StringName>) -> bool

pub fn get_meta_list(&self) -> Array<StringName>

pub fn add_user_signal(&mut self, signal: impl AsArg<GString>)

To set the default parameters, use Self::add_user_signal_ex and its builder methods. See the book for detailed usage instructions.

pub fn add_user_signal_ex<'a>( &'a mut self, signal: impl AsArg<GString> + 'a, ) -> ExAddUserSignal<'a>

pub fn has_user_signal(&self, signal: impl AsArg<StringName>) -> bool

pub fn remove_user_signal(&mut self, signal: impl AsArg<StringName>)

pub fn emit_signal( &mut self, signal: impl AsArg<StringName>, varargs: &[Variant], ) -> Error

Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_emit_signal( &mut self, signal: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Error, CallError>

Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn call( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Variant

Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_call( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Variant, CallError>

Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn call_deferred( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Variant

Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_call_deferred( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Variant, CallError>

Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn set_deferred( &mut self, property: impl AsArg<StringName>, value: &Variant, )

pub fn callv( &mut self, method: impl AsArg<StringName>, arg_array: &Array<Variant>, ) -> Variant

pub fn has_method(&self, method: impl AsArg<StringName>) -> bool

pub fn get_method_argument_count(&self, method: impl AsArg<StringName>) -> i32

pub fn has_signal(&self, signal: impl AsArg<StringName>) -> bool

pub fn get_signal_list(&self) -> Array<Dictionary>

pub fn get_signal_connection_list( &self, signal: impl AsArg<StringName>, ) -> Array<Dictionary>

pub fn get_incoming_connections(&self) -> Array<Dictionary>

pub fn connect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, ) -> Error

To set the default parameters, use Self::connect_ex and its builder methods. See the book for detailed usage instructions.

pub fn connect_ex<'a>( &'a mut self, signal: impl AsArg<StringName> + 'a, callable: &'a Callable, ) -> ExConnect<'a>

pub fn disconnect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, )

pub fn is_connected( &self, signal: impl AsArg<StringName>, callable: &Callable, ) -> bool

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

pub fn is_blocking_signals(&self) -> bool

pub fn notify_property_list_changed(&mut self)

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

pub fn can_translate_messages(&self) -> bool

pub fn tr(&self, message: impl AsArg<StringName>) -> GString

To set the default parameters, use Self::tr_ex and its builder methods. See the book for detailed usage instructions.

pub fn tr_ex<'a>(&'a self, message: impl AsArg<StringName> + 'a) -> ExTr<'a>

pub fn tr_n( &self, message: impl AsArg<StringName>, plural_message: impl AsArg<StringName>, n: i32, ) -> GString

To set the default parameters, use Self::tr_n_ex and its builder methods. See the book for detailed usage instructions.

pub fn tr_n_ex<'a>( &'a self, message: impl AsArg<StringName> + 'a, plural_message: impl AsArg<StringName> + 'a, n: i32, ) -> ExTrN<'a>

pub fn is_queued_for_deletion(&self) -> bool

pub fn cancel_free(&mut self)

pub fn notify(&mut self, what: ObjectNotification)

⚠️ Sends a Godot notification to all classes inherited by the object.

Triggers calls to on_notification(), and depending on the notification, also to Godot’s lifecycle callbacks such as ready().

Starts from the highest ancestor (the Object class) and goes down the hierarchy. See also Godot docs for Object::notification().

Panics

If you call this method on a user-defined object while holding a GdRef or GdMut guard on the instance, you will encounter a panic. The reason is that the receiving virtual method on_notification() acquires a GdMut lock dynamically, which must be exclusive.

pub fn notify_reversed(&mut self, what: ObjectNotification)

⚠️ Like Self::notify(), but starts at the most-derived class and goes up the hierarchy.

See docs of that method, including the panics.

Trait Implementations

impl Bounds for TileSetAtlasSource

type Memory = MemRefCounted

Defines the memory strategy of the static type.

type Declarer = DeclEngine

Whether this class is a core Godot class provided by the engine, or declared by the user as a Rust struct.

impl Debug for TileSetAtlasSource

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

Formats the value using the given formatter.

impl Deref for TileSetAtlasSource

type Target = TileSetSource

The resulting type after dereferencing.

fn deref(&self) -> &<TileSetAtlasSource as Deref>::Target

Dereferences the value.

impl DerefMut for TileSetAtlasSource

fn deref_mut(&mut self) -> &mut <TileSetAtlasSource as Deref>::Target

Mutably dereferences the value.

impl GodotClass for TileSetAtlasSource

const INIT_LEVEL: InitLevel = crate::init::InitLevel::Scene

Initialization level, during which this class should be initialized with Godot.

type Base = TileSetSource

The immediate superclass of T. This is always a Godot engine class.

fn class_name() -> ClassName

The name of the class, under which it is registered in Godot.

fn inherits<U>() -> bool

where U: GodotClass,

Returns whether Self inherits from U.

impl GodotDefault for TileSetAtlasSource

impl Inherits<Object> for TileSetAtlasSource

impl Inherits<RefCounted> for TileSetAtlasSource

impl Inherits<Resource> for TileSetAtlasSource

impl Inherits<TileSetSource> for TileSetAtlasSource