Skip to content

Commit

Permalink
Rename various TileMap methods/properties for clarity and consistency
Browse files Browse the repository at this point in the history 
The YSort renames were tracked in godotengine#16863.

This closes godotengine/godot-proposals#814.
  • Loading branch information
@Calinou @kappa54m
Calinou authored and kappa54m committed May 16, 2020
1 parent 93583b0 commit 747fdcb
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 20 deletions.
8 changes: 4 additions & 4 deletions doc/classes/TileMap.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -80,13 +80,13 @@
Returns a [Vector2] array with the positions of all cells containing a tile from the tileset (i.e. a tile index different from [code]-1[/code]).
</description>
</method>
<method name="get_used_cells_by_id" qualifiers="const">
<method name="get_used_cells_by_index" qualifiers="const">
<return type="Vector2i[]">
</return>
<argument index="0" name="id" type="int">
<argument index="0" name="index" type="int">
</argument>
<description>
Returns an array of all cells with the given tile [code]id[/code].
Returns an array of all cells with the given tile [code]index[/code].
</description>
</method>
<method name="get_used_rect">
Expand Down Expand Up @@ -273,7 +273,7 @@
<member name="cell_tile_origin" type="int" setter="set_tile_origin" getter="get_tile_origin" enum="TileMap.TileOrigin" default="0">
Position for tile origin. See [enum TileOrigin] for possible values.
</member>
<member name="cell_y_sort" type="bool" setter="set_y_sort_mode" getter="is_y_sort_mode_enabled" default="false">
<member name="cell_y_sort" type="bool" setter="set_y_sort_enabled" getter="is_y_sort_enabled" default="false">
If [code]true[/code], the TileMap's children will be drawn in order of their Y coordinate.
</member>
<member name="centered_textures" type="bool" setter="set_centered_textures" getter="is_centered_textures_enabled" default="false">
Expand Down
24 changes: 12 additions & 12 deletions scene/2d/tile_map.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@

int TileMap::_get_quadrant_size() const {

if (y_sort_mode)
if (use_y_sort)
return 1;
else
return quadrant_size;
Expand Down Expand Up @@ -1649,18 +1649,18 @@ Vector2 TileMap::world_to_map(const Vector2 &p_pos) const {
return ret.floor();
}

void TileMap::set_y_sort_mode(bool p_enable) {
void TileMap::set_y_sort_enabled(bool p_enable) {

_clear_quadrants();
y_sort_mode = p_enable;
RS::get_singleton()->canvas_item_set_sort_children_by_y(get_canvas_item(), y_sort_mode);
use_y_sort = p_enable;
RS::get_singleton()->canvas_item_set_sort_children_by_y(get_canvas_item(), use_y_sort);
_recreate_quadrants();
emit_signal("settings_changed");
}

bool TileMap::is_y_sort_mode_enabled() const {
bool TileMap::is_y_sort_enabled() const {

return y_sort_mode;
return use_y_sort;
}

void TileMap::set_compatibility_mode(bool p_enable) {
Expand Down Expand Up @@ -1703,7 +1703,7 @@ TypedArray<Vector2i> TileMap::get_used_cells() const {
return a;
}

TypedArray<Vector2i> TileMap::get_used_cells_by_id(int p_id) const {
TypedArray<Vector2i> TileMap::get_used_cells_by_index(int p_id) const {

TypedArray<Vector2i> a;
for (Map<PosKey, Cell>::Element *E = tile_map.front(); E; E = E->next()) {
Expand Down Expand Up @@ -1823,8 +1823,8 @@ void TileMap::_bind_methods() {
ClassDB::bind_method(D_METHOD("set_clip_uv", "enable"), &TileMap::set_clip_uv);
ClassDB::bind_method(D_METHOD("get_clip_uv"), &TileMap::get_clip_uv);

ClassDB::bind_method(D_METHOD("set_y_sort_mode", "enable"), &TileMap::set_y_sort_mode);
ClassDB::bind_method(D_METHOD("is_y_sort_mode_enabled"), &TileMap::is_y_sort_mode_enabled);
ClassDB::bind_method(D_METHOD("set_y_sort_enabled", "enable"), &TileMap::set_y_sort_enabled);
ClassDB::bind_method(D_METHOD("is_y_sort_enabled"), &TileMap::is_y_sort_enabled);

ClassDB::bind_method(D_METHOD("set_compatibility_mode", "enable"), &TileMap::set_compatibility_mode);
ClassDB::bind_method(D_METHOD("is_compatibility_mode_enabled"), &TileMap::is_compatibility_mode_enabled);
Expand Down Expand Up @@ -1874,7 +1874,7 @@ void TileMap::_bind_methods() {
ClassDB::bind_method(D_METHOD("clear"), &TileMap::clear);

ClassDB::bind_method(D_METHOD("get_used_cells"), &TileMap::get_used_cells);
ClassDB::bind_method(D_METHOD("get_used_cells_by_id", "id"), &TileMap::get_used_cells_by_id);
ClassDB::bind_method(D_METHOD("get_used_cells_by_index", "index"), &TileMap::get_used_cells_by_index);
ClassDB::bind_method(D_METHOD("get_used_rect"), &TileMap::get_used_rect);

ClassDB::bind_method(D_METHOD("map_to_world", "map_position", "ignore_half_ofs"), &TileMap::map_to_world, DEFVAL(false));
Expand All @@ -1898,7 +1898,7 @@ void TileMap::_bind_methods() {
ADD_PROPERTY(PropertyInfo(Variant::TRANSFORM2D, "cell_custom_transform"), "set_custom_transform", "get_custom_transform");
ADD_PROPERTY(PropertyInfo(Variant::INT, "cell_half_offset", PROPERTY_HINT_ENUM, "Offset X,Offset Y,Disabled,Offset Negative X,Offset Negative Y"), "set_half_offset", "get_half_offset");
ADD_PROPERTY(PropertyInfo(Variant::INT, "cell_tile_origin", PROPERTY_HINT_ENUM, "Top Left,Center,Bottom Left"), "set_tile_origin", "get_tile_origin");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "cell_y_sort"), "set_y_sort_mode", "is_y_sort_mode_enabled");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "cell_y_sort"), "set_y_sort_enabled", "is_y_sort_enabled");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "compatibility_mode"), "set_compatibility_mode", "is_compatibility_mode_enabled");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "centered_textures"), "set_centered_textures", "is_centered_textures_enabled");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "cell_clip_uv"), "set_clip_uv", "get_clip_uv");
Expand Down Expand Up @@ -1960,7 +1960,7 @@ TileMap::TileMap() {
collision_parent = nullptr;
use_kinematic = false;
navigation = nullptr;
y_sort_mode = false;
use_y_sort = false;
compatibility_mode = false;
centered_textures = false;
occluder_light_mask = 1;
Expand Down
8 changes: 4 additions & 4 deletions scene/2d/tile_map.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ class TileMap : public Node2D {
Rect2 used_size_cache;
bool used_size_cache_dirty;
bool quadrant_order_dirty;
bool y_sort_mode;
bool use_y_sort;
bool compatibility_mode;
bool centered_textures;
bool clip_uv;
Expand Down Expand Up @@ -319,8 +319,8 @@ class TileMap : public Node2D {
Vector2 map_to_world(const Vector2 &p_pos, bool p_ignore_ofs = false) const;
Vector2 world_to_map(const Vector2 &p_pos) const;

void set_y_sort_mode(bool p_enable);
bool is_y_sort_mode_enabled() const;
void set_y_sort_enabled(bool p_enable);
bool is_y_sort_enabled() const;

void set_compatibility_mode(bool p_enable);
bool is_compatibility_mode_enabled() const;
Expand All @@ -329,7 +329,7 @@ class TileMap : public Node2D {
bool is_centered_textures_enabled() const;

TypedArray<Vector2i> get_used_cells() const;
TypedArray<Vector2i> get_used_cells_by_id(int p_id) const;
TypedArray<Vector2i> get_used_cells_by_index(int p_index) const;
Rect2 get_used_rect(); // Not const because of cache

void set_occluder_light_mask(int p_mask);
Expand Down

0 comments on commit 747fdcb

Please sign in to comment.