diff options
author | Rémi Verschelde <remi@verschelde.fr> | 2021-09-29 23:01:16 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-09-29 23:01:16 +0200 |
commit | 1ab8f3f55900a1f97a266aaac25cc95b46763e66 (patch) | |
tree | 02ecc32a1e8b378e609bfe4f3950e5eec033bc25 /doc/classes | |
parent | 0013d6f02264bb18b19a67836596ddc6af388cf6 (diff) | |
parent | f2caab469198fe33649b487546fb5d8e12007296 (diff) |
Merge pull request #52724 from groud/improve_tilemap_physics
Diffstat (limited to 'doc/classes')
-rw-r--r-- | doc/classes/TileData.xml | 30 | ||||
-rw-r--r-- | doc/classes/TileMap.xml | 18 |
2 files changed, 48 insertions, 0 deletions
diff --git a/doc/classes/TileData.xml b/doc/classes/TileData.xml index 0d3282c6d3..81c5743ccc 100644 --- a/doc/classes/TileData.xml +++ b/doc/classes/TileData.xml @@ -37,6 +37,20 @@ Returns how many polygons the tile has for TileSet physics layer with index [code]layer_id[/code]. </description> </method> + <method name="get_constant_angular_velocity" qualifiers="const"> + <return type="float" /> + <argument index="0" name="layer_id" type="int" /> + <description> + Returns the constant angular velocity applied to objects colliding with this tile. + </description> + </method> + <method name="get_constant_linear_velocity" qualifiers="const"> + <return type="Vector2" /> + <argument index="0" name="layer_id" type="int" /> + <description> + Returns the constant linear velocity applied to objects colliding with this tile. + </description> + </method> <method name="get_custom_data" qualifiers="const"> <return type="Variant" /> <argument index="0" name="layer_name" type="String" /> @@ -123,6 +137,22 @@ Sets the polygons count for TileSet physics layer with index [code]layer_id[/code]. </description> </method> + <method name="set_constant_angular_velocity"> + <return type="void" /> + <argument index="0" name="layer_id" type="int" /> + <argument index="1" name="velocity" type="float" /> + <description> + Sets the constant angular velocity. This does not rotate the tile. This angular velocity is applied to objects colliding with this tile. + </description> + </method> + <method name="set_constant_linear_velocity"> + <return type="void" /> + <argument index="0" name="layer_id" type="int" /> + <argument index="1" name="velocity" type="Vector2" /> + <description> + Sets the constant linear velocity. This does not move the tile. This linear velocity is applied to objects colliding with this tile. This is useful to create conveyor belts. + </description> + </method> <method name="set_custom_data"> <return type="void" /> <argument index="0" name="layer_name" type="String" /> diff --git a/doc/classes/TileMap.xml b/doc/classes/TileMap.xml index 4621d138ac..e5fe823be6 100644 --- a/doc/classes/TileMap.xml +++ b/doc/classes/TileMap.xml @@ -29,6 +29,13 @@ Clears all cells. </description> </method> + <method name="clear_layer"> + <return type="void" /> + <argument index="0" name="layer" type="int" /> + <description> + Clears all cells on the given layer. + </description> + </method> <method name="fix_invalid_tiles"> <return type="void" /> <description> @@ -62,6 +69,13 @@ Returns the tile source ID of the cell on layer [code]layer[/code] at coordinates [code]coords[/code]. If [code]use_proxies[/code] is [code]false[/code], ignores the [TileSet]'s tile proxies, returning the raw alternative identifier. See [method TileSet.map_tile_proxy]. </description> </method> + <method name="get_coords_for_body_rid"> + <return type="Vector2i" /> + <argument index="0" name="body" type="RID" /> + <description> + Returns the coodinates of the tile for given physics body RID. Such RID can be retrieved from [member KinematicCollision2D.collider_rid], when colliding with a tile. + </description> + </method> <method name="get_layer_name" qualifiers="const"> <return type="String" /> <argument index="0" name="layer" type="int" /> @@ -220,6 +234,10 @@ <member name="cell_quadrant_size" type="int" setter="set_quadrant_size" getter="get_quadrant_size" default="16"> The TileMap's quadrant size. Optimizes drawing by batching, using chunks of this size. </member> + <member name="collision_animatable" type="bool" setter="set_collision_animatable" getter="is_collision_animatable" default="false"> + If enabled, the TileMap will see its collisions synced to the physics tick and change its collision type from static to kinematic. This is required to create TileMap-based moving platform. + [b]Note:[/b] Enabling [code]collision_animatable[/code] may have a small performance impact, only do it if the TileMap is moving and has colliding tiles. + </member> <member name="collision_visibility_mode" type="int" setter="set_collision_visibility_mode" getter="get_collision_visibility_mode" enum="TileMap.VisibilityMode" default="0"> Show or hide the TileMap's collision shapes. If set to [code]VISIBILITY_MODE_DEFAULT[/code], this depends on the show collision debug settings. </member> |