mirror of
https://github.com/Relintai/pandemonium_engine.git
synced 2024-12-23 04:16:50 +01:00
LayeredTileMapLayer fix class names in docs.
This commit is contained in:
parent
82bdd1c235
commit
cc2f893bcd
@ -4,8 +4,8 @@
|
|||||||
Node for 2D tile-based maps.
|
Node for 2D tile-based maps.
|
||||||
</brief_description>
|
</brief_description>
|
||||||
<description>
|
<description>
|
||||||
Node for 2D tile-based maps. A [TileMapLayer] uses a [TileSet] which contain a list of tiles which are used to create grid-based maps. Unlike the [TileMap] node, which is deprecated, [TileMapLayer] has only one layer of tiles. You can use several [TileMapLayer] to achieve the same result as a [TileMap] node.
|
Node for 2D tile-based maps. A [LayeredTileMapLayer] uses a [LayeredTileSet] which contain a list of tiles which are used to create grid-based maps. Unlike the [LayeredTileMap] node, which is deprecated, [LayeredTileMapLayer] has only one layer of tiles. You can use several [LayeredTileMapLayer] to achieve the same result as a [LayeredTileMap] node.
|
||||||
For performance reasons, all TileMap updates are batched at the end of a frame. Notably, this means that scene tiles from a [TileSetScenesCollectionSource] may be initialized after their parent. This is only queued when inside the scene tree.
|
For performance reasons, all TileMap updates are batched at the end of a frame. Notably, this means that scene tiles from a [LayeredTileSetScenesCollectionSource] may be initialized after their parent. This is only queued when inside the scene tree.
|
||||||
To force an update earlier on, call [method update_internals].
|
To force an update earlier on, call [method update_internals].
|
||||||
</description>
|
</description>
|
||||||
<tutorials>
|
<tutorials>
|
||||||
@ -14,12 +14,12 @@
|
|||||||
<method name="_tile_data_runtime_update" qualifiers="virtual">
|
<method name="_tile_data_runtime_update" qualifiers="virtual">
|
||||||
<return type="void" />
|
<return type="void" />
|
||||||
<argument index="0" name="coords" type="Vector2i" />
|
<argument index="0" name="coords" type="Vector2i" />
|
||||||
<argument index="1" name="tile_data" type="TileData" />
|
<argument index="1" name="tile_data" type="LayeredTileData" />
|
||||||
<description>
|
<description>
|
||||||
Called with a [TileData] object about to be used internally by the [TileMapLayer], allowing its modification at runtime.
|
Called with a [LayeredTileData] object about to be used internally by the [LayeredTileMapLayer], allowing its modification at runtime.
|
||||||
This method is only called if [method _use_tile_data_runtime_update] is implemented and returns [code]true[/code] for the given tile [param coords].
|
This method is only called if [method _use_tile_data_runtime_update] is implemented and returns [code]true[/code] for the given tile [param coords].
|
||||||
[b]Warning:[/b] The [param tile_data] object's sub-resources are the same as the one in the TileSet. Modifying them might impact the whole TileSet. Instead, make sure to duplicate those resources.
|
[b]Warning:[/b] The [param tile_data] object's sub-resources are the same as the one in the LayeredTileSet. Modifying them might impact the whole LayeredTileSet. Instead, make sure to duplicate those resources.
|
||||||
[b]Note:[/b] If the properties of [param tile_data] object should change over time, use [method notify_runtime_tile_data_update] to notify the [TileMapLayer] it needs an update.
|
[b]Note:[/b] If the properties of [param tile_data] object should change over time, use [method notify_runtime_tile_data_update] to notify the [LayeredTileMapLayer] it needs an update.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="_use_tile_data_runtime_update" qualifiers="virtual">
|
<method name="_use_tile_data_runtime_update" qualifiers="virtual">
|
||||||
@ -28,7 +28,7 @@
|
|||||||
<description>
|
<description>
|
||||||
Should return [code]true[/code] if the tile at coordinates [param coords] requires a runtime update.
|
Should return [code]true[/code] if the tile at coordinates [param coords] requires a runtime update.
|
||||||
[b]Warning:[/b] Make sure this function only returns [code]true[/code] when needed. Any tile processed at runtime without a need for it will imply a significant performance penalty.
|
[b]Warning:[/b] Make sure this function only returns [code]true[/code] when needed. Any tile processed at runtime without a need for it will imply a significant performance penalty.
|
||||||
[b]Note:[/b] If the result of this function should change, use [method notify_runtime_tile_data_update] to notify the [TileMapLayer] it needs an update.
|
[b]Note:[/b] If the result of this function should change, use [method notify_runtime_tile_data_update] to notify the [LayeredTileMapLayer] it needs an update.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="clear">
|
<method name="clear">
|
||||||
@ -72,10 +72,10 @@
|
|||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="get_cell_tile_data" qualifiers="const">
|
<method name="get_cell_tile_data" qualifiers="const">
|
||||||
<return type="TileData" />
|
<return type="LayeredTileData" />
|
||||||
<argument index="0" name="coords" type="Vector2i" />
|
<argument index="0" name="coords" type="Vector2i" />
|
||||||
<description>
|
<description>
|
||||||
Returns the [TileData] object associated with the given cell, or [code]null[/code] if the cell does not exist or is not a [TileSetAtlasSource].
|
Returns the [LayeredTileData] object associated with the given cell, or [code]null[/code] if the cell does not exist or is not a [LayeredTileSetAtlasSource].
|
||||||
[codeblock]
|
[codeblock]
|
||||||
func get_clicked_tile_power():
|
func get_clicked_tile_power():
|
||||||
var clicked_cell = tile_map_layer.local_to_map(tile_map_layer.get_local_mouse_position())
|
var clicked_cell = tile_map_layer.local_to_map(tile_map_layer.get_local_mouse_position())
|
||||||
@ -97,23 +97,23 @@
|
|||||||
<method name="get_navigation_map" qualifiers="const">
|
<method name="get_navigation_map" qualifiers="const">
|
||||||
<return type="RID" />
|
<return type="RID" />
|
||||||
<description>
|
<description>
|
||||||
Returns the [RID] of the [NavigationServer2D] navigation used by this [TileMapLayer].
|
Returns the [RID] of the [NavigationServer2D] navigation used by this [LayeredTileMapLayer].
|
||||||
By default this returns the default [World2D] navigation map, unless a custom map was provided using [method set_navigation_map].
|
By default this returns the default [World2D] navigation map, unless a custom map was provided using [method set_navigation_map].
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="get_neighbor_cell" qualifiers="const">
|
<method name="get_neighbor_cell" qualifiers="const">
|
||||||
<return type="Vector2i" />
|
<return type="Vector2i" />
|
||||||
<argument index="0" name="coords" type="Vector2i" />
|
<argument index="0" name="coords" type="Vector2i" />
|
||||||
<argument index="1" name="neighbor" type="int" enum="TileSet.CellNeighbor" />
|
<argument index="1" name="neighbor" type="int" enum="LayeredTileSet.CellNeighbor" />
|
||||||
<description>
|
<description>
|
||||||
Returns the neighboring cell to the one at coordinates [param coords], identified by the [param neighbor] direction. This method takes into account the different layouts a TileMap can take.
|
Returns the neighboring cell to the one at coordinates [param coords], identified by the [param neighbor] direction. This method takes into account the different layouts a LayeredTileMap can take.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="get_pattern">
|
<method name="get_pattern">
|
||||||
<return type="TileMapPattern" />
|
<return type="LayeredTileMapPattern" />
|
||||||
<argument index="0" name="coords_array" type="PoolVector2iArray" />
|
<argument index="0" name="coords_array" type="PoolVector2iArray" />
|
||||||
<description>
|
<description>
|
||||||
Creates and returns a new [TileMapPattern] from the given array of cells. See also [method set_pattern].
|
Creates and returns a new [LayeredTileMapPattern] from the given array of cells. See also [method set_pattern].
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="get_surrounding_cells">
|
<method name="get_surrounding_cells">
|
||||||
@ -150,7 +150,7 @@
|
|||||||
<return type="bool" />
|
<return type="bool" />
|
||||||
<argument index="0" name="body" type="RID" />
|
<argument index="0" name="body" type="RID" />
|
||||||
<description>
|
<description>
|
||||||
Returns whether the provided [param body] [RID] belongs to one of this [TileMapLayer]'s cells.
|
Returns whether the provided [param body] [RID] belongs to one of this [LayeredTileMapLayer]'s cells.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="local_to_map" qualifiers="const">
|
<method name="local_to_map" qualifiers="const">
|
||||||
@ -164,25 +164,25 @@
|
|||||||
<return type="Vector2i" />
|
<return type="Vector2i" />
|
||||||
<argument index="0" name="position_in_tilemap" type="Vector2i" />
|
<argument index="0" name="position_in_tilemap" type="Vector2i" />
|
||||||
<argument index="1" name="coords_in_pattern" type="Vector2i" />
|
<argument index="1" name="coords_in_pattern" type="Vector2i" />
|
||||||
<argument index="2" name="pattern" type="TileMapPattern" />
|
<argument index="2" name="pattern" type="LayeredTileMapPattern" />
|
||||||
<description>
|
<description>
|
||||||
Returns for the given coordinates [param coords_in_pattern] in a [TileMapPattern] the corresponding cell coordinates if the pattern was pasted at the [param position_in_tilemap] coordinates (see [method set_pattern]). This mapping is required as in half-offset tile shapes, the mapping might not work by calculating [code]position_in_tile_map + coords_in_pattern[/code].
|
Returns for the given coordinates [param coords_in_pattern] in a [LayeredTileMapPattern] the corresponding cell coordinates if the pattern was pasted at the [param position_in_tilemap] coordinates (see [method set_pattern]). This mapping is required as in half-offset tile shapes, the mapping might not work by calculating [code]position_in_tile_map + coords_in_pattern[/code].
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="map_to_local" qualifiers="const">
|
<method name="map_to_local" qualifiers="const">
|
||||||
<return type="Vector2" />
|
<return type="Vector2" />
|
||||||
<argument index="0" name="map_position" type="Vector2i" />
|
<argument index="0" name="map_position" type="Vector2i" />
|
||||||
<description>
|
<description>
|
||||||
Returns the centered position of a cell in the [TileMapLayer]'s local coordinate space. To convert the returned value into global coordinates, use [method Node2D.to_global]. See also [method local_to_map].
|
Returns the centered position of a cell in the [LayeredTileMapLayer]'s local coordinate space. To convert the returned value into global coordinates, use [method Node2D.to_global]. See also [method local_to_map].
|
||||||
[b]Note:[/b] This may not correspond to the visual position of the tile, i.e. it ignores the [member TileData.texture_origin] property of individual tiles.
|
[b]Note:[/b] This may not correspond to the visual position of the tile, i.e. it ignores the [member LayeredTileData.texture_origin] property of individual tiles.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="notify_runtime_tile_data_update">
|
<method name="notify_runtime_tile_data_update">
|
||||||
<return type="void" />
|
<return type="void" />
|
||||||
<description>
|
<description>
|
||||||
Notifies the [TileMapLayer] node that calls to [method _use_tile_data_runtime_update] or [method _tile_data_runtime_update] will lead to different results. This will thus trigger a [TileMapLayer] update.
|
Notifies the [LayeredTileMapLayer] node that calls to [method _use_tile_data_runtime_update] or [method _tile_data_runtime_update] will lead to different results. This will thus trigger a [LayeredTileMapLayer] update.
|
||||||
[b]Warning:[/b] Updating the [TileMapLayer] is computationally expensive and may impact performance. Try to limit the number of calls to this function to avoid unnecessary update.
|
[b]Warning:[/b] Updating the [LayeredTileMapLayer] is computationally expensive and may impact performance. Try to limit the number of calls to this function to avoid unnecessary update.
|
||||||
[b]Note:[/b] This does not trigger a direct update of the [TileMapLayer], the update will be done at the end of the frame as usual (unless you call [method update_internals]).
|
[b]Note:[/b] This does not trigger a direct update of the [LayeredTileMapLayer], the update will be done at the end of the frame as usual (unless you call [method update_internals]).
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="set_cell">
|
<method name="set_cell">
|
||||||
@ -192,10 +192,10 @@
|
|||||||
<argument index="2" name="atlas_coords" type="Vector2i" default="Vector2i(-1, -1)" />
|
<argument index="2" name="atlas_coords" type="Vector2i" default="Vector2i(-1, -1)" />
|
||||||
<argument index="3" name="alternative_tile" type="int" default="0" />
|
<argument index="3" name="alternative_tile" type="int" default="0" />
|
||||||
<description>
|
<description>
|
||||||
Sets the tile identifiers for the cell at coordinates [param coords]. Each tile of the [TileSet] is identified using three parts:
|
Sets the tile identifiers for the cell at coordinates [param coords]. Each tile of the [LayeredTileSet] is identified using three parts:
|
||||||
- The source identifier [param source_id] identifies a [TileSetSource] identifier. See [method TileSet.set_source_id],
|
- The source identifier [param source_id] identifies a [LayeredTileSetSource] identifier. See [method LayeredTileSet.set_source_id],
|
||||||
- The atlas coordinate identifier [param atlas_coords] identifies a tile coordinates in the atlas (if the source is a [TileSetAtlasSource]). For [TileSetScenesCollectionSource] it should always be [code]Vector2i(0, 0)[/code],
|
- The atlas coordinate identifier [param atlas_coords] identifies a tile coordinates in the atlas (if the source is a [LayeredTileSetAtlasSource]). For [LayeredTileSetScenesCollectionSource] it should always be [code]Vector2i(0, 0)[/code],
|
||||||
- The alternative tile identifier [param alternative_tile] identifies a tile alternative in the atlas (if the source is a [TileSetAtlasSource]), and the scene for a [TileSetScenesCollectionSource].
|
- The alternative tile identifier [param alternative_tile] identifies a tile alternative in the atlas (if the source is a [LayeredTileSetAtlasSource]), and the scene for a [LayeredTileSetScenesCollectionSource].
|
||||||
If [param source_id] is set to [code]-1[/code], [param atlas_coords] to [code]Vector2i(-1, -1)[/code], or [param alternative_tile] to [code]-1[/code], the cell will be erased. An erased cell gets [b]all[/b] its identifiers automatically set to their respective invalid values, namely [code]-1[/code], [code]Vector2i(-1, -1)[/code] and [code]-1[/code].
|
If [param source_id] is set to [code]-1[/code], [param atlas_coords] to [code]Vector2i(-1, -1)[/code], or [param alternative_tile] to [code]-1[/code], the cell will be erased. An erased cell gets [b]all[/b] its identifiers automatically set to their respective invalid values, namely [code]-1[/code], [code]Vector2i(-1, -1)[/code] and [code]-1[/code].
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
@ -208,7 +208,7 @@
|
|||||||
<description>
|
<description>
|
||||||
Update all the cells in the [param cells] coordinates array so that they use the given [param terrain] for the given [param terrain_set]. If an updated cell has the same terrain as one of its neighboring cells, this function tries to join the two. This function might update neighboring tiles if needed to create correct terrain transitions.
|
Update all the cells in the [param cells] coordinates array so that they use the given [param terrain] for the given [param terrain_set]. If an updated cell has the same terrain as one of its neighboring cells, this function tries to join the two. This function might update neighboring tiles if needed to create correct terrain transitions.
|
||||||
If [param ignore_empty_terrains] is true, empty terrains will be ignored when trying to find the best fitting tile for the given terrain constraints.
|
If [param ignore_empty_terrains] is true, empty terrains will be ignored when trying to find the best fitting tile for the given terrain constraints.
|
||||||
[b]Note:[/b] To work correctly, this method requires the [TileMapLayer]'s TileSet to have terrains set up with all required terrain combinations. Otherwise, it may produce unexpected results.
|
[b]Note:[/b] To work correctly, this method requires the [LayeredTileMapLayer]'s LayeredTileSet to have terrains set up with all required terrain combinations. Otherwise, it may produce unexpected results.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="set_cells_terrain_path">
|
<method name="set_cells_terrain_path">
|
||||||
@ -220,7 +220,7 @@
|
|||||||
<description>
|
<description>
|
||||||
Update all the cells in the [param path] coordinates array so that they use the given [param terrain] for the given [param terrain_set]. The function will also connect two successive cell in the path with the same terrain. This function might update neighboring tiles if needed to create correct terrain transitions.
|
Update all the cells in the [param path] coordinates array so that they use the given [param terrain] for the given [param terrain_set]. The function will also connect two successive cell in the path with the same terrain. This function might update neighboring tiles if needed to create correct terrain transitions.
|
||||||
If [param ignore_empty_terrains] is true, empty terrains will be ignored when trying to find the best fitting tile for the given terrain constraints.
|
If [param ignore_empty_terrains] is true, empty terrains will be ignored when trying to find the best fitting tile for the given terrain constraints.
|
||||||
[b]Note:[/b] To work correctly, this method requires the [TileMapLayer]'s TileSet to have terrains set up with all required terrain combinations. Otherwise, it may produce unexpected results.
|
[b]Note:[/b] To work correctly, this method requires the [LayeredTileMapLayer]'s LayeredTileSet to have terrains set up with all required terrain combinations. Otherwise, it may produce unexpected results.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="set_navigation_map">
|
<method name="set_navigation_map">
|
||||||
@ -233,17 +233,17 @@
|
|||||||
<method name="set_pattern">
|
<method name="set_pattern">
|
||||||
<return type="void" />
|
<return type="void" />
|
||||||
<argument index="0" name="position" type="Vector2i" />
|
<argument index="0" name="position" type="Vector2i" />
|
||||||
<argument index="1" name="pattern" type="TileMapPattern" />
|
<argument index="1" name="pattern" type="LayeredTileMapPattern" />
|
||||||
<description>
|
<description>
|
||||||
Pastes the [TileMapPattern] at the given [param position] in the tile map. See also [method get_pattern].
|
Pastes the [LayeredTileMapPattern] at the given [param position] in the tile map. See also [method get_pattern].
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="update_internals">
|
<method name="update_internals">
|
||||||
<return type="void" />
|
<return type="void" />
|
||||||
<description>
|
<description>
|
||||||
Triggers a direct update of the [TileMapLayer]. Usually, calling this function is not needed, as [TileMapLayer] node updates automatically when one of its properties or cells is modified.
|
Triggers a direct update of the [LayeredTileMapLayer]. Usually, calling this function is not needed, as [LayeredTileMapLayer] node updates automatically when one of its properties or cells is modified.
|
||||||
However, for performance reasons, those updates are batched and delayed to the end of the frame. Calling this function will force the [TileMapLayer] to update right away instead.
|
However, for performance reasons, those updates are batched and delayed to the end of the frame. Calling this function will force the [LayeredTileMapLayer] to update right away instead.
|
||||||
[b]Warning:[/b] Updating the [TileMapLayer] is computationally expensive and may impact performance. Try to limit the number of updates and how many tiles they impact.
|
[b]Warning:[/b] Updating the [LayeredTileMapLayer] is computationally expensive and may impact performance. Try to limit the number of updates and how many tiles they impact.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
</methods>
|
</methods>
|
||||||
@ -251,31 +251,31 @@
|
|||||||
<member name="collision_enabled" type="bool" setter="set_collision_enabled" getter="is_collision_enabled" default="true">
|
<member name="collision_enabled" type="bool" setter="set_collision_enabled" getter="is_collision_enabled" default="true">
|
||||||
Enable or disable collisions.
|
Enable or disable collisions.
|
||||||
</member>
|
</member>
|
||||||
<member name="collision_visibility_mode" type="int" setter="set_collision_visibility_mode" getter="get_collision_visibility_mode" enum="TileMapLayer.DebugVisibilityMode" default="0">
|
<member name="collision_visibility_mode" type="int" setter="set_collision_visibility_mode" getter="get_collision_visibility_mode" enum="LayeredTileMapLayer.DebugVisibilityMode" default="0">
|
||||||
Show or hide the [TileMapLayer]'s collision shapes. If set to [constant DEBUG_VISIBILITY_MODE_DEFAULT], this depends on the show collision debug settings.
|
Show or hide the [LayeredTileMapLayer]'s collision shapes. If set to [constant DEBUG_VISIBILITY_MODE_DEFAULT], this depends on the show collision debug settings.
|
||||||
</member>
|
</member>
|
||||||
<member name="enabled" type="bool" setter="set_enabled" getter="is_enabled" default="true">
|
<member name="enabled" type="bool" setter="set_enabled" getter="is_enabled" default="true">
|
||||||
If [code]false[/code], disables this [TileMapLayer] completely (rendering, collision, navigation, scene tiles, etc.)
|
If [code]false[/code], disables this [LayeredTileMapLayer] completely (rendering, collision, navigation, scene tiles, etc.)
|
||||||
</member>
|
</member>
|
||||||
<member name="navigation_enabled" type="bool" setter="set_navigation_enabled" getter="is_navigation_enabled" default="true">
|
<member name="navigation_enabled" type="bool" setter="set_navigation_enabled" getter="is_navigation_enabled" default="true">
|
||||||
If [code]true[/code], navigation regions are enabled.
|
If [code]true[/code], navigation regions are enabled.
|
||||||
</member>
|
</member>
|
||||||
<member name="navigation_visibility_mode" type="int" setter="set_navigation_visibility_mode" getter="get_navigation_visibility_mode" enum="TileMapLayer.DebugVisibilityMode" default="0">
|
<member name="navigation_visibility_mode" type="int" setter="set_navigation_visibility_mode" getter="get_navigation_visibility_mode" enum="LayeredTileMapLayer.DebugVisibilityMode" default="0">
|
||||||
Show or hide the [TileMapLayer]'s navigation meshes. If set to [constant DEBUG_VISIBILITY_MODE_DEFAULT], this depends on the show navigation debug settings.
|
Show or hide the [LayeredTileMapLayer]'s navigation meshes. If set to [constant DEBUG_VISIBILITY_MODE_DEFAULT], this depends on the show navigation debug settings.
|
||||||
</member>
|
</member>
|
||||||
<member name="rendering_quadrant_size" type="int" setter="set_rendering_quadrant_size" getter="get_rendering_quadrant_size" default="16">
|
<member name="rendering_quadrant_size" type="int" setter="set_rendering_quadrant_size" getter="get_rendering_quadrant_size" default="16">
|
||||||
The [TileMapLayer]'s quadrant size. A quadrant is a group of tiles to be drawn together on a single canvas item, for optimization purposes. [member rendering_quadrant_size] defines the length of a square's side, in the map's coordinate system, that forms the quadrant. Thus, the default quandrant size groups together [code]16 * 16 = 256[/code] tiles.
|
The [LayeredTileMapLayer]'s quadrant size. A quadrant is a group of tiles to be drawn together on a single canvas item, for optimization purposes. [member rendering_quadrant_size] defines the length of a square's side, in the map's coordinate system, that forms the quadrant. Thus, the default quandrant size groups together [code]16 * 16 = 256[/code] tiles.
|
||||||
The quadrant size does not apply on a Y-sorted [TileMapLayer], as tiles are be grouped by Y position instead in that case.
|
The quadrant size does not apply on a Y-sorted [LayeredTileMapLayer], as tiles are be grouped by Y position instead in that case.
|
||||||
[b]Note:[/b] As quadrants are created according to the map's coordinate system, the quadrant's "square shape" might not look like square in the [TileMapLayer]'s local coordinate system.
|
[b]Note:[/b] As quadrants are created according to the map's coordinate system, the quadrant's "square shape" might not look like square in the [LayeredTileMapLayer]'s local coordinate system.
|
||||||
</member>
|
</member>
|
||||||
<member name="tile_map_data" type="PoolByteArray" setter="set_tile_map_data_from_array" getter="get_tile_map_data_as_array" default="PoolByteArray(0, 0)">
|
<member name="tile_map_data" type="PoolByteArray" setter="set_tile_map_data_from_array" getter="get_tile_map_data_as_array" default="PoolByteArray(0, 0)">
|
||||||
The raw tile map data as a byte array.
|
The raw tile map data as a byte array.
|
||||||
</member>
|
</member>
|
||||||
<member name="tile_set" type="TileSet" setter="set_tile_set" getter="get_tile_set">
|
<member name="tile_set" type="LayeredTileSet" setter="set_tile_set" getter="get_tile_set">
|
||||||
The [TileSet] used by this layer. The textures, collisions, and additional behavior of all available tiles are stored here.
|
The [LayeredTileSet] used by this layer. The textures, collisions, and additional behavior of all available tiles are stored here.
|
||||||
</member>
|
</member>
|
||||||
<member name="use_kinematic_bodies" type="bool" setter="set_use_kinematic_bodies" getter="is_using_kinematic_bodies" default="false">
|
<member name="use_kinematic_bodies" type="bool" setter="set_use_kinematic_bodies" getter="is_using_kinematic_bodies" default="false">
|
||||||
If [code]true[/code], this [TileMapLayer] collision shapes will be instantiated as kinematic bodies. This can be needed for moving [TileMapLayer] nodes (i.e. moving platforms).
|
If [code]true[/code], this [LayeredTileMapLayer] collision shapes will be instantiated as kinematic bodies. This can be needed for moving [LayeredTileMapLayer] nodes (i.e. moving platforms).
|
||||||
</member>
|
</member>
|
||||||
<member name="y_sort_origin" type="int" setter="set_y_sort_origin" getter="get_y_sort_origin" default="0">
|
<member name="y_sort_origin" type="int" setter="set_y_sort_origin" getter="get_y_sort_origin" default="0">
|
||||||
This Y-sort origin value is added to each tile's Y-sort origin value. This allows, for example, to fake a different height level. This can be useful for top-down view games.
|
This Y-sort origin value is added to each tile's Y-sort origin value. This allows, for example, to fake a different height level. This can be useful for top-down view games.
|
||||||
@ -284,8 +284,8 @@
|
|||||||
<signals>
|
<signals>
|
||||||
<signal name="changed">
|
<signal name="changed">
|
||||||
<description>
|
<description>
|
||||||
Emitted when this [TileMapLayer]'s properties changes. This includes modified cells, properties, or changes made to its assigned [TileSet].
|
Emitted when this [LayeredTileMapLayer]'s properties changes. This includes modified cells, properties, or changes made to its assigned [LayeredTileSet].
|
||||||
[b]Note:[/b] This signal may be emitted very often when batch-modifying a [TileMapLayer]. Avoid executing complex processing in a connected function, and consider delaying it to the end of the frame instead (i.e. calling [method Object.call_deferred]).
|
[b]Note:[/b] This signal may be emitted very often when batch-modifying a [LayeredTileMapLayer]. Avoid executing complex processing in a connected function, and consider delaying it to the end of the frame instead (i.e. calling [method Object.call_deferred]).
|
||||||
</description>
|
</description>
|
||||||
</signal>
|
</signal>
|
||||||
</signals>
|
</signals>
|
||||||
|
Loading…
Reference in New Issue
Block a user