diff options
Diffstat (limited to 'doc/classes/TileMap.xml')
-rw-r--r-- | doc/classes/TileMap.xml | 302 |
1 files changed, 14 insertions, 288 deletions
diff --git a/doc/classes/TileMap.xml b/doc/classes/TileMap.xml index c48f58f123..72cd56dc55 100644 --- a/doc/classes/TileMap.xml +++ b/doc/classes/TileMap.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="TileMap" inherits="Node2D" category="Core" version="3.0-alpha"> +<class name="TileMap" inherits="Node2D" category="Core" version="3.0-beta"> <brief_description> Node for 2D tile-based maps. </brief_description> @@ -29,13 +29,6 @@ Return the tile index of the referenced cell. </description> </method> - <method name="get_cell_size" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Return the cell size. - </description> - </method> <method name="get_cellv" qualifiers="const"> <return type="int"> </return> @@ -45,47 +38,6 @@ Return the tile index of the cell referenced by a Vector2. </description> </method> - <method name="get_center_x" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return true if tiles are to be centered in x coordinate (by default this is false and they are drawn from upper left cell corner). - </description> - </method> - <method name="get_center_y" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return true if tiles are to be centered in y coordinate (by default this is false and they are drawn from upper left cell corner). - </description> - </method> - <method name="get_clip_uv" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_collision_bounce" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the collision bounce parameter. - </description> - </method> - <method name="get_collision_friction" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the collision friction parameter. - </description> - </method> - <method name="get_collision_layer" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the collision layer. - </description> - </method> <method name="get_collision_layer_bit" qualifiers="const"> <return type="bool"> </return> @@ -94,13 +46,6 @@ <description> </description> </method> - <method name="get_collision_mask" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the collision mask. - </description> - </method> <method name="get_collision_mask_bit" qualifiers="const"> <return type="bool"> </return> @@ -109,61 +54,6 @@ <description> </description> </method> - <method name="get_collision_use_kinematic" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return whether the tilemap handles collisions as a kinematic body. - </description> - </method> - <method name="get_custom_transform" qualifiers="const"> - <return type="Transform2D"> - </return> - <description> - Return the custom transform matrix. - </description> - </method> - <method name="get_half_offset" qualifiers="const"> - <return type="int" enum="TileMap.HalfOffset"> - </return> - <description> - Return the current half offset configuration. - </description> - </method> - <method name="get_mode" qualifiers="const"> - <return type="int" enum="TileMap.Mode"> - </return> - <description> - Return the orientation mode. - </description> - </method> - <method name="get_occluder_light_mask" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_quadrant_size" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the quadrant size. - </description> - </method> - <method name="get_tile_origin" qualifiers="const"> - <return type="int" enum="TileMap.TileOrigin"> - </return> - <description> - Return the tile origin configuration. - </description> - </method> - <method name="get_tileset" qualifiers="const"> - <return type="TileSet"> - </return> - <description> - Return the current tileset. - </description> - </method> <method name="get_used_cells" qualifiers="const"> <return type="Array"> </return> @@ -218,13 +108,6 @@ Return whether the referenced cell is flipped over the Y axis. </description> </method> - <method name="is_y_sort_mode_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return the Y sort mode. - </description> - </method> <method name="map_to_world" qualifiers="const"> <return type="Vector2"> </return> @@ -252,19 +135,12 @@ </argument> <argument index="5" name="transpose" type="bool" default="false"> </argument> + <argument index="6" name="autotile_coord" type="Vector2" default="Vector2( 0, 0 )"> + </argument> <description> Set the tile index for the cell referenced by its grid-based X and Y coordinates. A tile index of -1 clears the cell. - Optionally, the tile can also be flipped over the X and Y coordinates or transposed. - </description> - </method> - <method name="set_cell_size"> - <return type="void"> - </return> - <argument index="0" name="size" type="Vector2"> - </argument> - <description> - Set the cell size. + Optionally, the tile can also be flipped over the X and Y coordinates, transposed, or be given autotile coordinates. </description> </method> <method name="set_cellv"> @@ -286,60 +162,6 @@ Optionally, the tile can also be flipped over the X and Y axes or transposed. </description> </method> - <method name="set_center_x"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Set tiles to be centered in x coordinate. (by default this is false and they are drawn from upper left cell corner). - </description> - </method> - <method name="set_center_y"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Set tiles to be centered in y coordinate. (by default this is false and they are drawn from upper left cell corner). - </description> - </method> - <method name="set_clip_uv"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_collision_bounce"> - <return type="void"> - </return> - <argument index="0" name="value" type="float"> - </argument> - <description> - Set the collision bounce parameter. Allowable values range from 0 to 1. - </description> - </method> - <method name="set_collision_friction"> - <return type="void"> - </return> - <argument index="0" name="value" type="float"> - </argument> - <description> - Set the collision friction parameter. Allowable values range from 0 to 1. - </description> - </method> - <method name="set_collision_layer"> - <return type="void"> - </return> - <argument index="0" name="layer" type="int"> - </argument> - <description> - Set the collision layer. - Layers are referenced by binary indexes, so allowable values to describe the 20 available layers range from 0 to 2^20-1. - </description> - </method> <method name="set_collision_layer_bit"> <return type="void"> </return> @@ -350,16 +172,6 @@ <description> </description> </method> - <method name="set_collision_mask"> - <return type="void"> - </return> - <argument index="0" name="mask" type="int"> - </argument> - <description> - Set the collision masks. - Masks are referenced by binary indexes, so allowable values to describe the 20 available masks range from 0 to 2^20-1. - </description> - </method> <method name="set_collision_mask_bit"> <return type="void"> </return> @@ -370,89 +182,6 @@ <description> </description> </method> - <method name="set_collision_use_kinematic"> - <return type="void"> - </return> - <argument index="0" name="use_kinematic" type="bool"> - </argument> - <description> - Set the tilemap to handle collisions as a kinematic body (enabled) or a static body (disabled). - </description> - </method> - <method name="set_custom_transform"> - <return type="void"> - </return> - <argument index="0" name="custom_transform" type="Transform2D"> - </argument> - <description> - Set custom transform matrix, to use in combination with the custom orientation mode. - </description> - </method> - <method name="set_half_offset"> - <return type="void"> - </return> - <argument index="0" name="half_offset" type="int" enum="TileMap.HalfOffset"> - </argument> - <description> - Set a half offset on the X coordinate, Y coordinate, or none (use HALF_OFFSET_* constants as argument). - Half offset sets every other tile off by a half tile size in the specified direction. - </description> - </method> - <method name="set_mode"> - <return type="void"> - </return> - <argument index="0" name="mode" type="int" enum="TileMap.Mode"> - </argument> - <description> - Set the orientation mode as square, isometric or custom (use MODE_* constants as argument). - </description> - </method> - <method name="set_occluder_light_mask"> - <return type="void"> - </return> - <argument index="0" name="mask" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_quadrant_size"> - <return type="void"> - </return> - <argument index="0" name="size" type="int"> - </argument> - <description> - Set the quadrant size, this optimizes drawing by batching chunks of map at draw/cull time. - Allowed values are integers ranging from 1 to 128. - </description> - </method> - <method name="set_tile_origin"> - <return type="void"> - </return> - <argument index="0" name="origin" type="int" enum="TileMap.TileOrigin"> - </argument> - <description> - Set the tile origin to the tile center or its top-left corner (use TILE_ORIGIN_* constants as argument). - </description> - </method> - <method name="set_tileset"> - <return type="void"> - </return> - <argument index="0" name="tileset" type="TileSet"> - </argument> - <description> - Set the current tileset. - </description> - </method> - <method name="set_y_sort_mode"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Set the Y sort mode. Enabled Y sort mode means that children of the tilemap will be drawn in the order defined by their Y coordinate. - A tile with a higher Y coordinate will therefore be drawn later, potentially covering up the tile(s) above it if its sprite is higher than its cell size. - </description> - </method> <method name="world_to_map" qualifiers="const"> <return type="Vector2"> </return> @@ -505,9 +234,6 @@ <member name="occluder_light_mask" type="int" setter="set_occluder_light_mask" getter="get_occluder_light_mask"> The light mask assigned to all light occluders in the TileMap. The TileSet's light occluders will cast shadows only from Light2D(s) that have the same light mask(s). </member> - <member name="tile_data" type="PoolIntArray" setter="_set_tile_data" getter="_get_tile_data"> - A [PoolIntArray] containing - </member> <member name="tile_set" type="TileSet" setter="set_tileset" getter="get_tileset"> The assigned [TileSet]. </member> @@ -520,34 +246,34 @@ </signal> </signals> <constants> - <constant name="INVALID_CELL" value="-1" enum=""> + <constant name="INVALID_CELL" value="-1"> Returned when a cell doesn't exist. </constant> - <constant name="MODE_SQUARE" value="0"> + <constant name="MODE_SQUARE" value="0" enum="Mode"> Orthogonal orientation mode. </constant> - <constant name="MODE_ISOMETRIC" value="1"> + <constant name="MODE_ISOMETRIC" value="1" enum="Mode"> Isometric orientation mode. </constant> - <constant name="MODE_CUSTOM" value="2"> + <constant name="MODE_CUSTOM" value="2" enum="Mode"> Custom orientation mode. </constant> - <constant name="HALF_OFFSET_X" value="0"> + <constant name="HALF_OFFSET_X" value="0" enum="HalfOffset"> Half offset on the X coordinate. </constant> - <constant name="HALF_OFFSET_Y" value="1"> + <constant name="HALF_OFFSET_Y" value="1" enum="HalfOffset"> Half offset on the Y coordinate. </constant> - <constant name="HALF_OFFSET_DISABLED" value="2"> + <constant name="HALF_OFFSET_DISABLED" value="2" enum="HalfOffset"> Half offset disabled. </constant> - <constant name="TILE_ORIGIN_TOP_LEFT" value="0"> + <constant name="TILE_ORIGIN_TOP_LEFT" value="0" enum="TileOrigin"> Tile origin at its top-left corner. </constant> - <constant name="TILE_ORIGIN_CENTER" value="1"> + <constant name="TILE_ORIGIN_CENTER" value="1" enum="TileOrigin"> Tile origin at its center. </constant> - <constant name="TILE_ORIGIN_BOTTOM_LEFT" value="2"> + <constant name="TILE_ORIGIN_BOTTOM_LEFT" value="2" enum="TileOrigin"> </constant> </constants> </class> |