Struct gdnative::TileMap

pub struct TileMap { /* fields omitted */ }

core class TileMap inherits Node2D (unsafe).

Official documentation

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

Memory management

Non reference counted objects such as the ones of this type are usually owned by the engine.

TileMap is an unsafe pointer, and all of its methods are unsafe.

In the cases where Rust code owns an object of this type, for example if the object was just created on the Rust side and not passed to the engine yet, ownership should be either given to the engine or the object must be manually destroyed using TileMap::free.

Class hierarchy

TileMap inherits methods from:

• Node2D
• CanvasItem
• Node
• Object

Methods

impl TileMap

Constants

pub const TILE_ORIGIN_CENTER: i64

pub const TILE_ORIGIN_TOP_LEFT: i64

pub const INVALID_CELL: i64

pub const MODE_SQUARE: i64

pub const MODE_CUSTOM: i64

pub const MODE_ISOMETRIC: i64

pub const HALF_OFFSET_Y: i64

pub const HALF_OFFSET_NEGATIVE_Y: i64

pub const HALF_OFFSET_X: i64

pub const HALF_OFFSET_NEGATIVE_X: i64

pub const HALF_OFFSET_DISABLED: i64

pub const TILE_ORIGIN_BOTTOM_LEFT: i64

impl TileMap

pub fn new() -> TileMap

Constructor.

Because this type is not reference counted, the lifetime of the returned object is not automatically managed. Immediately after creation, the object is owned by the caller, and can be passed to the engine (in which case the engine will be responsible for destroying the object) or destroyed manually using TileMap::free.

pub unsafe fn free(self)

Manually deallocate the object.

pub unsafe fn _clear_quadrants(&mut self)

pub unsafe fn _get_old_cell_size(&self) -> i64

pub unsafe fn _get_tile_data(&self) -> Int32Array

pub unsafe fn _recreate_quadrants(&mut self)

pub unsafe fn _set_celld(
    &mut self,
    position: Vector2D<f32, UnknownUnit>,
    data: Dictionary
)

pub unsafe fn _set_old_cell_size(&mut self, size: i64)

pub unsafe fn _set_tile_data(&mut self, arg0: Int32Array)

pub unsafe fn clear(&mut self)

pub unsafe fn fix_invalid_tiles(&mut self)

pub unsafe fn get_cell(&self, x: i64, y: i64) -> i64

pub unsafe fn get_cell_autotile_coord(
    &self,
    x: i64,
    y: i64
) -> Vector2D<f32, UnknownUnit>

pub unsafe fn get_cell_size(&self) -> Vector2D<f32, UnknownUnit>

pub unsafe fn get_cellv(&self, position: Vector2D<f32, UnknownUnit>) -> i64

pub unsafe fn get_clip_uv(&self) -> bool

pub unsafe fn get_collision_bounce(&self) -> f64

pub unsafe fn get_collision_friction(&self) -> f64

pub unsafe fn get_collision_layer(&self) -> i64

pub unsafe fn get_collision_layer_bit(&self, bit: i64) -> bool

pub unsafe fn get_collision_mask(&self) -> i64

pub unsafe fn get_collision_mask_bit(&self, bit: i64) -> bool

pub unsafe fn get_collision_use_kinematic(&self) -> bool

pub unsafe fn get_collision_use_parent(&self) -> bool

pub unsafe fn get_custom_transform(
    &self
) -> Transform2D<f32, UnknownUnit, UnknownUnit>

pub unsafe fn get_half_offset(&self) -> TileMapHalfOffset

pub unsafe fn get_mode(&self) -> TileMapMode

pub unsafe fn get_occluder_light_mask(&self) -> i64

pub unsafe fn get_quadrant_size(&self) -> i64

pub unsafe fn get_tile_origin(&self) -> TileMapTileOrigin

pub unsafe fn get_tileset(&self) -> Option<TileSet>

pub unsafe fn get_used_cells(&self) -> VariantArray

pub unsafe fn get_used_cells_by_id(&self, id: i64) -> VariantArray

pub unsafe fn get_used_rect(&mut self) -> Rect<f32, UnknownUnit>

pub unsafe fn is_cell_transposed(&self, x: i64, y: i64) -> bool

pub unsafe fn is_cell_x_flipped(&self, x: i64, y: i64) -> bool

pub unsafe fn is_cell_y_flipped(&self, x: i64, y: i64) -> bool

pub unsafe fn is_centered_textures_enabled(&self) -> bool

pub unsafe fn is_compatibility_mode_enabled(&self) -> bool

pub unsafe fn is_y_sort_mode_enabled(&self) -> bool

pub unsafe fn map_to_world(
    &self,
    map_position: Vector2D<f32, UnknownUnit>,
    ignore_half_ofs: bool
) -> Vector2D<f32, UnknownUnit>

pub unsafe fn set_cell(
    &mut self,
    x: i64,
    y: i64,
    tile: i64,
    flip_x: bool,
    flip_y: bool,
    transpose: bool,
    autotile_coord: Vector2D<f32, UnknownUnit>
)

pub unsafe fn set_cell_size(&mut self, size: Vector2D<f32, UnknownUnit>)

pub unsafe fn set_cellv(
    &mut self,
    position: Vector2D<f32, UnknownUnit>,
    tile: i64,
    flip_x: bool,
    flip_y: bool,
    transpose: bool
)

pub unsafe fn set_centered_textures(&mut self, enable: bool)

pub unsafe fn set_clip_uv(&mut self, enable: bool)

pub unsafe fn set_collision_bounce(&mut self, value: f64)

pub unsafe fn set_collision_friction(&mut self, value: f64)

pub unsafe fn set_collision_layer(&mut self, layer: i64)

pub unsafe fn set_collision_layer_bit(&mut self, bit: i64, value: bool)

pub unsafe fn set_collision_mask(&mut self, mask: i64)

pub unsafe fn set_collision_mask_bit(&mut self, bit: i64, value: bool)

pub unsafe fn set_collision_use_kinematic(&mut self, use_kinematic: bool)

pub unsafe fn set_collision_use_parent(&mut self, use_parent: bool)

pub unsafe fn set_compatibility_mode(&mut self, enable: bool)

pub unsafe fn set_custom_transform(
    &mut self,
    custom_transform: Transform2D<f32, UnknownUnit, UnknownUnit>
)

pub unsafe fn set_half_offset(&mut self, half_offset: i64)

pub unsafe fn set_mode(&mut self, mode: i64)

pub unsafe fn set_occluder_light_mask(&mut self, mask: i64)

pub unsafe fn set_quadrant_size(&mut self, size: i64)

pub unsafe fn set_tile_origin(&mut self, origin: i64)

pub unsafe fn set_tileset(&mut self, tileset: Option<TileSet>)

pub unsafe fn set_y_sort_mode(&mut self, enable: bool)

pub unsafe fn update_bitmask_area(
    &mut self,
    position: Vector2D<f32, UnknownUnit>
)

pub unsafe fn update_bitmask_region(
    &mut self,
    start: Vector2D<f32, UnknownUnit>,
    end: Vector2D<f32, UnknownUnit>
)

pub unsafe fn update_dirty_quadrants(&mut self)

pub unsafe fn world_to_map(
    &self,
    world_position: Vector2D<f32, UnknownUnit>
) -> Vector2D<f32, UnknownUnit>

pub unsafe fn to_node_2d(&self) -> Node2D

Up-cast.

pub unsafe fn to_canvas_item(&self) -> CanvasItem

Up-cast.

pub unsafe fn to_node(&self) -> Node

Up-cast.

pub unsafe fn to_object(&self) -> Object

Up-cast.

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

Generic dynamic cast.

Methods from Deref<Target = Node2D>

pub unsafe fn apply_scale(&mut self, ratio: Vector2D<f32, UnknownUnit>)

pub unsafe fn get_angle_to(&self, point: Vector2D<f32, UnknownUnit>) -> f64

pub unsafe fn get_global_position(&self) -> Vector2D<f32, UnknownUnit>

pub unsafe fn get_global_rotation(&self) -> f64

pub unsafe fn get_global_rotation_degrees(&self) -> f64

pub unsafe fn get_global_scale(&self) -> Vector2D<f32, UnknownUnit>

pub unsafe fn get_position(&self) -> Vector2D<f32, UnknownUnit>

pub unsafe fn get_relative_transform_to_parent(
    &self,
    parent: Option<Node>
) -> Transform2D<f32, UnknownUnit, UnknownUnit>

pub unsafe fn get_rotation(&self) -> f64

pub unsafe fn get_rotation_degrees(&self) -> f64

pub unsafe fn get_scale(&self) -> Vector2D<f32, UnknownUnit>

pub unsafe fn get_z_index(&self) -> i64

pub unsafe fn global_translate(&mut self, offset: Vector2D<f32, UnknownUnit>)

pub unsafe fn is_z_relative(&self) -> bool

pub unsafe fn look_at(&mut self, point: Vector2D<f32, UnknownUnit>)

pub unsafe fn move_local_x(&mut self, delta: f64, scaled: bool)

pub unsafe fn move_local_y(&mut self, delta: f64, scaled: bool)

pub unsafe fn rotate(&mut self, radians: f64)

pub unsafe fn set_global_position(
    &mut self,
    position: Vector2D<f32, UnknownUnit>
)

pub unsafe fn set_global_rotation(&mut self, radians: f64)

pub unsafe fn set_global_rotation_degrees(&mut self, degrees: f64)

pub unsafe fn set_global_scale(&mut self, scale: Vector2D<f32, UnknownUnit>)

pub unsafe fn set_global_transform(
    &mut self,
    xform: Transform2D<f32, UnknownUnit, UnknownUnit>
)

pub unsafe fn set_position(&mut self, position: Vector2D<f32, UnknownUnit>)

pub unsafe fn set_rotation(&mut self, radians: f64)

pub unsafe fn set_rotation_degrees(&mut self, degrees: f64)

pub unsafe fn set_scale(&mut self, scale: Vector2D<f32, UnknownUnit>)

pub unsafe fn set_transform(
    &mut self,
    xform: Transform2D<f32, UnknownUnit, UnknownUnit>
)

pub unsafe fn set_z_as_relative(&mut self, enable: bool)

pub unsafe fn set_z_index(&mut self, z_index: i64)

pub unsafe fn to_global(
    &self,
    local_point: Vector2D<f32, UnknownUnit>
) -> Vector2D<f32, UnknownUnit>

pub unsafe fn to_local(
    &self,
    global_point: Vector2D<f32, UnknownUnit>
) -> Vector2D<f32, UnknownUnit>

pub unsafe fn translate(&mut self, offset: Vector2D<f32, UnknownUnit>)

pub unsafe fn to_canvas_item(&self) -> CanvasItem

Up-cast.

pub unsafe fn to_node(&self) -> Node

Up-cast.

pub unsafe fn to_object(&self) -> Object

Up-cast.

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

Generic dynamic cast.

Trait Implementations

impl Clone for TileMap

fn clone(&self) -> TileMap

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for TileMap

impl Debug for TileMap

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

Formats the value using the given formatter.

impl Deref for TileMap

type Target = Node2D

The resulting type after dereferencing.

fn deref(&self) -> &Node2D

Dereferences the value.

impl DerefMut for TileMap

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

Mutably dereferences the value.

impl Free for TileMap

unsafe fn godot_free(self)

impl FromVariant for TileMap

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

impl GodotObject for TileMap

fn class_name() -> &'static str

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

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

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

impl Instanciable for TileMap

fn construct() -> TileMap

impl QueueFree for TileMap

unsafe fn godot_queue_free(&mut self)

impl ToVariant for TileMap

fn to_variant(&self) -> Variant