Simplify tileset creation

[kim-fg]

Context

I'm building a dynamic dual grid tilemap system (based on this project) to be used for procedural generation. It's a bit complex, but the way tileset creation is currently implemented makes it even more complex.

Problems

When you create custom data layers for a tileset, you must:

1. Guess (or print) your way into the index of the data type of the layer as there is (afaik) no enum for it. Godot even warns that an int is used instead of an enum, but the function parameter is an int. I didnt find it obvious what enum is supposed to be used for the custom data layer type, but as stated in a comment below: the enum is Variant.Type.

var int_data_layer_type = 2 # this is not understandable
var tile_set = TileSet.new()
tile_set.set_custom_data_layer_type(0, int_data_layer_type)

2. Set the layer name and type individiually as there is no function that can do both at the same time.

# ...
tile_set.set_custom_data_layer_type(0, 2)
tile_set.set_custom_data_layer_name(0, "custom_int")

When you create atlas sources for the tile set, you cant just override a source by setting it. You must check if one exists at that index, remove it, then add the new one at that index.

if tile_set.has_source(0):
    tile_set.remove_source(0)
var atlas_source = TileSetAtlasSource.new()
tile_set.add_source(atlas_source, 0)

Discussion

I dont even know if this is the right place to report something like this, but things like this make me want to use another tool. It creates friction and seems to just be an oversight. Please add any other irks about scripting tilemaps below.

[theraot]

At least, from the documentation, the first one is a Variant.Type, so you can do this:

var int_data_layer_type = TYPE_INT
var tile_set = TileSet.new()
tile_set.set_custom_data_layer_type(0, int_data_layer_type)

[kim-fg]

Thank you, this wasnt clear to me so might have just misunderstood it. Will try it to make sure it works but looks like a simple solution to my problem.

[Mickeon]

Set the layer name and type individiually as there is no function that can do both at the same time.

When you create atlas sources for the tile set, you cant just override a source by setting it. You must check if one exists at that index, remove it, then add the new one at that index.

A general flaw across the entire TileMap API is that the exposed methods are the very same, technical methods used internally, with no regard to general convenience that would benefit the developers. It's complicated to pinpoint exactly, but what you brought up is part of it.
As a result there's way too many of them, as well, but that's another can of worms.

[kim-fg]

You bring up a good point. I found that working with tilemaps was an absolute chore in general, and assuming you're correct about the api being 1:1 with internal - that might be the whole problem. I guess the question is where one would draw the line between internal and external API. That process sounds less than fun lol.