TileMap¶
Inherits: Node2D < CanvasItem < Node < Object
Nodo para mapas basados en tiles 2D.
Descripción¶
Node for 2D tile-based maps. Tilemaps use a TileSet which contain a list of tiles (textures plus optional collision, navigation, and/or occluder shapes) which are used to create grid-based maps.
When doing physics queries against the tilemap, the cell coordinates are encoded as metadata for each detected collision shape returned by methods such as Physics2DDirectSpaceState.intersect_shape, Physics2DDirectBodyState.get_contact_collider_shape_metadata, etc.
Tutoriales¶
Propiedades¶
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
Métodos¶
void |
clear ( ) |
void |
|
get_cell_autotile_coord ( int x, int y ) const |
|
get_collision_layer_bit ( int bit ) const |
|
get_collision_mask_bit ( int bit ) const |
|
get_used_cells ( ) const |
|
get_used_cells_by_id ( int id ) const |
|
get_used_rect ( ) |
|
is_cell_transposed ( int x, int y ) const |
|
is_cell_x_flipped ( int x, int y ) const |
|
is_cell_y_flipped ( int x, int y ) const |
|
map_to_world ( Vector2 map_position, bool ignore_half_ofs=false ) const |
|
void |
set_cell ( int x, int y, int tile, bool flip_x=false, bool flip_y=false, bool transpose=false, Vector2 autotile_coord=Vector2( 0, 0 ) ) |
void |
set_cellv ( Vector2 position, int tile, bool flip_x=false, bool flip_y=false, bool transpose=false ) |
void |
set_collision_layer_bit ( int bit, bool value ) |
void |
set_collision_mask_bit ( int bit, bool value ) |
void |
update_bitmask_area ( Vector2 position ) |
void |
update_bitmask_region ( Vector2 start=Vector2( 0, 0 ), Vector2 end=Vector2( 0, 0 ) ) |
void |
|
world_to_map ( Vector2 world_position ) const |
Señales¶
settings_changed ( )
Emitido cuando la configuración de un mapa de tiles ha cambiado.
Enumeraciones¶
enum Mode:
MODE_SQUARE = 0 --- Modo de orientación ortogonal.
MODE_ISOMETRIC = 1 --- Modo de orientación isométrica.
MODE_CUSTOM = 2 --- Modo de orientación personalizada.
enum HalfOffset:
HALF_OFFSET_X = 0 --- Medio desplazamiento en la coordenada X.
HALF_OFFSET_Y = 1 --- Medio desplazamiento en la coordenada Y.
HALF_OFFSET_DISABLED = 2 --- Medio desplazamiento desactivado.
HALF_OFFSET_NEGATIVE_X = 3 --- Desplazamiento medio en la coordenada X (negativo).
HALF_OFFSET_NEGATIVE_Y = 4 --- Medio desplazamiento en la coordenada Y (negativo).
enum TileOrigin:
TILE_ORIGIN_TOP_LEFT = 0 --- Origen del tile en su esquina superior izquierda.
TILE_ORIGIN_CENTER = 1 --- El origen del tile en su centro.
TILE_ORIGIN_BOTTOM_LEFT = 2 --- Origen del tile en su esquina inferior izquierda.
Constantes¶
INVALID_CELL = -1 --- Devuelto cuando una celda no existe.
Descripciones de Propiedades¶
bool cell_clip_uv
Default |
|
Setter |
set_clip_uv(value) |
Getter |
get_clip_uv() |
Si true, los UV de la celda serán recortados.
Transform2D cell_custom_transform
Default |
|
Setter |
set_custom_transform(value) |
Getter |
get_custom_transform() |
La Transform2D personalizada para ser aplicada a las celdas del TileMap.
HalfOffset cell_half_offset
Default |
|
Setter |
set_half_offset(value) |
Getter |
get_half_offset() |
Cantidad para compensar las tiles alternadas. Ver HalfOffset para los posibles valores.
int cell_quadrant_size
Default |
|
Setter |
set_quadrant_size(value) |
Getter |
get_quadrant_size() |
El tamaño del cuadrante del TileMap. Optimiza el dibujo por lotes, usando trozos de este tamaño.
Vector2 cell_size
Default |
|
Setter |
set_cell_size(value) |
Getter |
get_cell_size() |
El tamaño de la celda del TileMap.
TileOrigin cell_tile_origin
Default |
|
Setter |
set_tile_origin(value) |
Getter |
get_tile_origin() |
Posición para el origen del tile. Ver TileOrigin para los posibles valores.
bool cell_y_sort
Default |
|
Setter |
set_y_sort_mode(value) |
Getter |
is_y_sort_mode_enabled() |
If true, the TileMap's direct children will be drawn in order of their Y coordinate.
bool centered_textures
Default |
|
Setter |
set_centered_textures(value) |
Getter |
is_centered_textures_enabled() |
Si true, las texturas se centrarán en el centro de cada tile. Esto es útil para ciertos modos isométricos o de arriba hacia abajo cuando las texturas se hacen más grandes o más pequeñas que las tiles (por ejemplo, para evitar el parpadeo en los bordes de las tiles). El desplazamiento se sigue aplicando, pero desde el centro de la tile. Si se utiliza, se ignora compatibility_mode.
Si false, la posición de la textura comienza en la esquina superior izquierda a menos que compatibility_mode esté activado.
float collision_bounce
Default |
|
Setter |
set_collision_bounce(value) |
Getter |
get_collision_bounce() |
Valor de rebote para las colisiones de cuerpos estáticos (ver collision_use_kinematic).
float collision_friction
Default |
|
Setter |
set_collision_friction(value) |
Getter |
get_collision_friction() |
Valor de fricción para colisiones de cuerpos estáticos (ver collision_use_kinematic).
int collision_layer
Default |
|
Setter |
set_collision_layer(value) |
Getter |
get_collision_layer() |
The collision layer(s) for all colliders in the TileMap. See Collision layers and masks in the documentation for more information.
int collision_mask
Default |
|
Setter |
set_collision_mask(value) |
Getter |
get_collision_mask() |
The collision mask(s) for all colliders in the TileMap. See Collision layers and masks in the documentation for more information.
bool collision_use_kinematic
Default |
|
Setter |
set_collision_use_kinematic(value) |
Getter |
get_collision_use_kinematic() |
Si true, las colisiones de TileMap se manejarán como un cuerpo cinematico. Si false, las colisiones se manejarán como un cuerpo estático.
bool collision_use_parent
Default |
|
Setter |
set_collision_use_parent(value) |
Getter |
get_collision_use_parent() |
Si true, la forma de colisión de este tilemap se añadirá a la forma de colisión del padre. El padre tiene que ser un CollisionObject2D.
bool compatibility_mode
Default |
|
Setter |
set_compatibility_mode(value) |
Getter |
is_compatibility_mode_enabled() |
Si true, se mantiene la compatibilidad con los tilemaps realizados en Godot 3.1 o anteriores (las texturas se mueven cuando cambia el origen del tile y giran si el tamaño de la textura no es homogéneo). Este modo presenta problemas al realizar operaciones de colocación de flip_h, flip_v y transpose sobre tiles isométricas no homogéneas (por ejemplo, 2:1), en las que la textura podría no coincidir con la colisión, por lo que no se recomienda para las tiles isométricas o no cuadradas.
Si false, las texturas no se mueven al realizar las operaciones flip_h, flip_v si no se utiliza el offset, ni al cambiar el origen de la tile.
El modo de compatibilidad no funciona con la opción centered_textures, porque desplazar las texturas con la opción cell_tile_origin o en tiles irregulares no es relevante al centrar esas texturas.
Mode mode
Default |
|
Setter |
set_mode(value) |
Getter |
get_mode() |
El modo de orientación de TileMap. Vea Mode para los posibles valores.
int occluder_light_mask
Default |
|
Setter |
set_occluder_light_mask(value) |
Getter |
get_occluder_light_mask() |
La máscara de luz asignada a todos los oclusores de luz en el TileMap. Los oclusores de luz del TileSet arrojarán sombras sólo de los Light2D que tengan la misma máscara de luz.
bool show_collision
Default |
|
Setter |
set_show_collision(value) |
Getter |
is_show_collision_enabled() |
If true, collision shapes are visible in the editor. Doesn't affect collision shapes visibility at runtime. To show collision shapes at runtime, enable Visible Collision Shapes in the Debug menu instead.
TileSet tile_set
Setter |
set_tileset(value) |
Getter |
get_tileset() |
El TileSet asignado.
Descripciones de Métodos¶
void clear ( )
Limpia todas las celdas.
void fix_invalid_tiles ( )
Despeja las celdas que no existen en el tileset.
Devuelve el índice de tile de la celda dada. Si no existe ningún tile en la celda, devuelve INVALID_CELL.
Devuelve la coordenada (columna y fila sutil) de la variación autotile en el tileset. Devuelve un vector cero si la celda no tiene autotiling.
Devuelve el índice de tile de la célula dado por un Vector2. Si no existe ningún tile en la celda, devuelve INVALID_CELL.
Devuelve true si el bit de la capa de colisión dada está fijado.
Devuelve true si el bit de la máscara de colisión dada está configurado.
Array get_used_cells ( ) const
Devuelve una array Vector2 con las posiciones de todas las celdas que contienen un tile del conjunto de tileset (es decir, un índice de tile diferente de -1).
Returns an array of all cells with the given tile index specified in id.
Rect2 get_used_rect ( )
Devuelve un rectángulo que encierra los tiles usados (no vacíos) del mapa.
Devuelve true si la celda dada se transpone, es decir, los ejes X e Y se intercambian.
Devuelve true si la celda dada se voltea en el eje X.
Devuelve true si la celda dada se voltea en el eje Y.
Returns the local position of the top left corner of the cell corresponding to the given tilemap (grid-based) coordinates.
To get the global position, use Node2D.to_global:
var local_position = my_tilemap.map_to_world(map_position)
var global_position = my_tilemap.to_global(local_position)
Optionally, the tilemap's half offset can be ignored.
void set_cell ( int x, int y, int tile, bool flip_x=false, bool flip_y=false, bool transpose=false, Vector2 autotile_coord=Vector2( 0, 0 ) )
Sets the tile index for the cell given by a Vector2.
An index of -1 clears the cell.
Optionally, the tile can also be flipped, transposed, or given autotile coordinates. The autotile coordinate refers to the column and row of the subtile.
Note: Data such as navigation polygons and collision shapes are not immediately updated for performance reasons.
If you need these to be immediately updated, you can call update_dirty_quadrants.
Overriding this method also overrides it internally, allowing custom logic to be implemented when tiles are placed/removed:
func set_cell(x, y, tile, flip_x=false, flip_y=false, transpose=false, autotile_coord=Vector2()):
# Write your custom logic here.
# To call the default method:
.set_cell(x, y, tile, flip_x, flip_y, transpose, autotile_coord)
void set_cellv ( Vector2 position, int tile, bool flip_x=false, bool flip_y=false, bool transpose=false )
Establece el índice de tiles para la celda dada.
Un índice de -1 borra la celda.
Opcionalmente, la tile también puede ser volteada o transpuesta.
Nota: Los datos como los polígonos de navegación y las formas de colisión no se actualizan inmediatamente por razones de rendimiento.
Si necesitas que se actualicen inmediatamente, puedes llamar a update_dirty_quadrants.
Establece el bit de la capa de colisión dada.
Establece el bit de la máscara de colisión dada.
void update_bitmask_area ( Vector2 position )
Aplica las reglas de autotiling a la célula (y sus células adyacentes) referidas por sus coordenadas X e Y basadas en la cuadrícula.
Aplica las reglas de autotiling a las celdas de la región dada (especificadas por las coordenadas X e Y de la cuadrícula).
Llamar con parámetros inválidos (o que faltan) aplica las reglas de autocalibración para todo el mapa de tilemap.
void update_dirty_quadrants ( )
Actualiza los cuadrantes del mapa de tiles, permitiendo que cosas como la navegación y las formas de colisión se usen inmediatamente si se modifican.
Returns the tilemap (grid-based) coordinates corresponding to the given local position.
To use this with a global position, first determine the local position with Node2D.to_local:
var local_position = my_tilemap.to_local(global_position)
var map_position = my_tilemap.world_to_map(local_position)