TileSet

public TileSet.TileLayoutEnum TileLayout { get; set; }

For all half-offset shapes (Isometric, Hexagonal and Half-Offset square), changes the way tiles are indexed in the TileMapLayer grid.

public TileSet.TileOffsetAxisEnum TileOffsetAxis { get; set; }

For all half-offset shapes (Isometric, Hexagonal and Half-Offset square), determines the offset axis.

public TileSet.TileShapeEnum TileShape { get; set; }

The tile shape.

public Vector2I TileSize { get; set; }

Grid cell size used for layout and coordinate conversion. Not automatically the same as an atlas tile image size, which the source configures with TextureRegionSize. The example explicitly sets both to 16×16.

public bool UVClipping { get; set; }

Enables/Disable uv clipping when rendering the tiles.

public void AddCustomDataLayer(int toPosition = -1);

Adds a custom data layer to the TileSet at the given position to_position in the array. If to_position is -1, adds it at the end of the array. Custom data layers allow assigning custom properties to atlas tiles.

public void AddNavigationLayer(int toPosition = -1);

Adds a navigation layer to the TileSet at the given position to_position in the array. If to_position is -1, adds it at the end of the array. Navigation layers allow assigning a navigable area to atlas tiles.

public void AddOcclusionLayer(int toPosition = -1);

Adds an occlusion layer to the TileSet at the given position to_position in the array. If to_position is -1, adds it at the end of the array. Occlusion layers allow assigning occlusion polygons to atlas tiles.

public int AddPattern(TileMapPattern pattern, int index = -1);

Adds a TileMapPattern to be stored in the TileSet resource. If provided, insert it at the given index.

public void AddPhysicsLayer(int toPosition = -1);

Adds a physics layer to the TileSet at the given position to_position in the array. If to_position is -1, adds it at the end of the array. Physics layers allow assigning collision polygons to atlas tiles.

public int AddSource(TileSetSource source, int atlasSourceIdOverride = -1);

Adds a TileSetSource to the TileSet. If atlas_source_id_override is not -1, also set its source ID. Otherwise, a unique identifier is automatically generated. The function returns the added source ID or -1 if the source could not be added. Warning: A source cannot belong to two TileSets at the same time. If the added source was attached to another TileSet, it will be removed from that one.

public void AddTerrain(int terrainSet, int toPosition = -1);

Adds a new terrain to the given terrain set terrain_set at the given position to_position in the array. If to_position is -1, adds it at the end of the array.

public void AddTerrainSet(int toPosition = -1);

Adds a new terrain set at the given position to_position in the array. If to_position is -1, adds it at the end of the array.

public void CleanupInvalidTileProxies();

Clears tile proxies pointing to invalid tiles.

public void ClearTerrains(int terrainSet);

Clears all terrain properties for the given terrain set.

public void ClearTileProxies();

Clears all tile proxies.

public Reckfell.Collections.Array GetAlternativeLevelTileProxy(int sourceFrom, Vector2I coordsFrom, int alternativeFrom);

Returns the alternative-level proxy for the given identifiers. The returned array contains the three proxies' target identifiers (source ID, atlas coordinate ID, and alternative tile ID). If the TileSet has no proxy for the given identifiers, returns an empty Array.

public Reckfell.Collections.Array GetCoordsLevelTileProxy(int sourceFrom, Vector2I coordsFrom);

Returns the coordinate-level proxy for the given identifiers. The returned array contains the two target identifiers of the proxy (source ID and atlas coordinates ID). If the TileSet has no proxy for the given identifiers, returns an empty Array.

public int GetCustomDataLayerByName(string layerName);

Returns the index of the custom data layer identified by the given name.

public string GetCustomDataLayerName(int layerIndex);

Returns the name of the custom data layer identified by the given index.

public Variant.Type GetCustomDataLayerType(int layerIndex);

Returns the type of the custom data layer identified by the given index.

public int GetCustomDataLayersCount();

Returns the custom data layers count.

public bool GetNavigationLayerLayerValue(int layerIndex, int layerNumber);

Returns whether or not the specified navigation layer of the TileSet navigation data layer identified by the given layer_index is enabled, given a navigation_layers layer_number between 1 and 32.

public uint GetNavigationLayerLayers(int layerIndex);

Returns the navigation layers (as in the Navigation server) of the given TileSet navigation layer.

public int GetNavigationLayersCount();

Returns the navigation layers count.

public int GetNextSourceId();

Returns a new unused source ID. This generated ID is the same that a call to TileSet.AddSource would return.

public int GetOcclusionLayerLightMask(int layerIndex);

Returns the light mask of the occlusion layer.

public bool GetOcclusionLayerSdfCollision(int layerIndex);

Returns if the occluders from this layer use sdf_collision.

public int GetOcclusionLayersCount();

Returns the occlusion layers count.

public TileMapPattern GetPattern(int index = -1);

Returns the TileMapPattern at the given index.

public int GetPatternsCount();

Returns the number of TileMapPattern this tile set handles.

public uint GetPhysicsLayerCollisionLayer(int layerIndex);

Returns the collision layer (as in the physics server) bodies on the given TileSet's physics layer are in.

public uint GetPhysicsLayerCollisionMask(int layerIndex);

Returns the collision mask of bodies on the given TileSet's physics layer.

public float GetPhysicsLayerCollisionPriority(int layerIndex);

Returns the collision priority of bodies on the given TileSet's physics layer.

public PhysicsMaterial GetPhysicsLayerPhysicsMaterial(int layerIndex);

Returns the physics material of bodies on the given TileSet's physics layer.

public int GetPhysicsLayersCount();

Returns the physics layers count.

public TileSetSource GetSource(int sourceId);

Returns the TileSetSource with ID source_id.

public int GetSourceCount();

Returns the number of TileSetSource in this TileSet.

public int GetSourceId(int index);

Returns the source ID for source with index index.

public int GetSourceLevelTileProxy(int sourceFrom);

Returns the source-level proxy for the given source identifier. If the TileSet has no proxy for the given identifier, returns -1.

public Color GetTerrainColor(int terrainSet, int terrainIndex);

Returns a terrain's color.

public string GetTerrainName(int terrainSet, int terrainIndex);

Returns a terrain's name.

public TileSet.TerrainMode GetTerrainSetMode(int terrainSet);

Returns a terrain set mode.

public int GetTerrainSetsCount();

Returns the terrain sets count.

public int GetTerrainsCount(int terrainSet);

Returns the number of terrains in the given terrain set.

public bool HasAlternativeLevelTileProxy(int sourceFrom, Vector2I coordsFrom, int alternativeFrom);

Returns if there is an alternative-level proxy for the given identifiers.

public bool HasCoordsLevelTileProxy(int sourceFrom, Vector2I coordsFrom);

Returns if there is a coodinates-level proxy for the given identifiers.

public bool HasCustomDataLayerByName(string layerName);

Returns if there is a custom data layer named layer_name.

public bool HasSource(int sourceId);

Returns if this TileSet has a source for the given source ID.

public bool HasSourceLevelTileProxy(int sourceFrom);

Returns if there is a source-level proxy for the given source ID.

public Reckfell.Collections.Array MapTileProxy(int sourceFrom, Vector2I coordsFrom, int alternativeFrom);

According to the configured proxies, maps the provided identifiers to a new set of identifiers. The source ID, atlas coordinates ID and alternative tile ID are returned as a 3 elements Array. This function first look for matching alternative-level proxies, then coordinates-level proxies, then source-level proxies. If no proxy corresponding to provided identifiers are found, returns the same values the ones used as arguments.

public void MoveCustomDataLayer(int layerIndex, int toPosition);

Moves the custom data layer at index layer_index to the given position to_position in the array. Also updates the atlas tiles accordingly.

public void MoveNavigationLayer(int layerIndex, int toPosition);

Moves the navigation layer at index layer_index to the given position to_position in the array. Also updates the atlas tiles accordingly.

public void MoveOcclusionLayer(int layerIndex, int toPosition);

Moves the occlusion layer at index layer_index to the given position to_position in the array. Also updates the atlas tiles accordingly.

public void MovePhysicsLayer(int layerIndex, int toPosition);

Moves the physics layer at index layer_index to the given position to_position in the array. Also updates the atlas tiles accordingly.

public void MoveTerrain(int terrainSet, int terrainIndex, int toPosition);

Moves the terrain at index terrain_index for terrain set terrain_set to the given position to_position in the array. Also updates the atlas tiles accordingly.

public void MoveTerrainSet(int terrainSet, int toPosition);

Moves the terrain set at index terrain_set to the given position to_position in the array. Also updates the atlas tiles accordingly.

public void RemoveAlternativeLevelTileProxy(int sourceFrom, Vector2I coordsFrom, int alternativeFrom);

Removes an alternative-level proxy for the given identifiers.

public void RemoveCoordsLevelTileProxy(int sourceFrom, Vector2I coordsFrom);

Removes a coordinates-level proxy for the given identifiers.

public void RemoveCustomDataLayer(int layerIndex);

Removes the custom data layer at index layer_index. Also updates the atlas tiles accordingly.

public void RemoveNavigationLayer(int layerIndex);

Removes the navigation layer at index layer_index. Also updates the atlas tiles accordingly.

public void RemoveOcclusionLayer(int layerIndex);

Removes the occlusion layer at index layer_index. Also updates the atlas tiles accordingly.

public void RemovePattern(int index);

Remove the TileMapPattern at the given index.

public void RemovePhysicsLayer(int layerIndex);

Removes the physics layer at index layer_index. Also updates the atlas tiles accordingly.

public void RemoveSource(int sourceId);

Removes the source with the given source ID.

public void RemoveSourceLevelTileProxy(int sourceFrom);

Removes a source-level tile proxy.

public void RemoveTerrain(int terrainSet, int terrainIndex);

Removes the terrain at index terrain_index in the given terrain set terrain_set. Also updates the atlas tiles accordingly.

public void RemoveTerrainSet(int terrainSet);

Removes the terrain set at index terrain_set. Also updates the atlas tiles accordingly.

public void SetAlternativeLevelTileProxy(int sourceFrom, Vector2I coordsFrom, int alternativeFrom, int sourceTo, Vector2I coordsTo, int alternativeTo);

Create an alternative-level proxy for the given identifiers. A proxy will map set of tile identifiers to another set of identifiers. Proxied tiles can be automatically replaced in TileMapLayer nodes using the editor.

public void SetCoordsLevelTileProxy(int sourceFrom, Vector2I coordsFrom, int sourceTo, Vector2I coordsTo);

Creates a coordinates-level proxy for the given identifiers. A proxy will map set of tile identifiers to another set of identifiers. The alternative tile ID is kept the same when using coordinates-level proxies. Proxied tiles can be automatically replaced in TileMapLayer nodes using the editor.

public void SetCustomDataLayerName(int layerIndex, string layerName);

Sets the name of the custom data layer identified by the given index. Names are identifiers of the layer therefore if the name is already taken it will fail and raise an error.

public void SetCustomDataLayerType(int layerIndex, Variant.Type layerType);

Sets the type of the custom data layer identified by the given index.

public void SetNavigationLayerLayerValue(int layerIndex, int layerNumber, bool value);

Based on value, enables or disables the specified navigation layer of the TileSet navigation data layer identified by the given layer_index, given a navigation_layers layer_number between 1 and 32.

public void SetNavigationLayerLayers(int layerIndex, uint layers);

Sets the navigation layers (as in the navigation server) for navigation regions in the given TileSet navigation layer.

public void SetOcclusionLayerLightMask(int layerIndex, int lightMask);

Sets the occlusion layer (as in the rendering server) for occluders in the given TileSet occlusion layer.

public void SetOcclusionLayerSdfCollision(int layerIndex, bool sdfCollision);

Enables or disables SDF collision for occluders in the given TileSet occlusion layer.

public void SetPhysicsLayerCollisionLayer(int layerIndex, uint layer);

Sets the collision layer (as in the physics server) for bodies in the given TileSet physics layer.

public void SetPhysicsLayerCollisionMask(int layerIndex, uint mask);

Sets the collision mask for bodies in the given TileSet physics layer.

public void SetPhysicsLayerCollisionPriority(int layerIndex, float priority);

Sets the collision priority for bodies in the given TileSet physics layer.

public void SetPhysicsLayerPhysicsMaterial(int layerIndex, PhysicsMaterial physicsMaterial);

Sets the physics material for bodies in the given TileSet physics layer.

public void SetSourceId(int sourceId, int newSourceId);

Changes a source's ID.

public void SetSourceLevelTileProxy(int sourceFrom, int sourceTo);

Creates a source-level proxy for the given source ID. A proxy will map set of tile identifiers to another set of identifiers. Both the atlas coordinates ID and the alternative tile ID are kept the same when using source-level proxies. Proxied tiles can be automatically replaced in TileMapLayer nodes using the editor.

public void SetTerrainColor(int terrainSet, int terrainIndex, Color color);

Sets a terrain's color. This color is used for identifying the different terrains in the TileSet editor.

public void SetTerrainName(int terrainSet, int terrainIndex, string name);

Sets a terrain's name.

public void SetTerrainSetMode(int terrainSet, TileSet.TerrainMode mode);

Sets a terrain mode. Each mode determines which bits of a tile shape is used to match the neighboring tiles' terrains.