Relintai/pandemonium_engine
1
0
Fork 0
mirror of https://github.com/Relintai/pandemonium_engine.git synced 2024-12-26 05:37:13 +01:00
Code Issues Packages Projects Releases Wiki Activity
a993a5460c
pandemonium_engine/modules/tile_map/doc_classes/TileMap.xml

250 lines
9.4 KiB
XML
Raw Normal View History

Re-extracted the class docs.
2022-03-16 02:51:50 +01:00
<?xml version="1.0" encoding="UTF-8" ?>
Re-extracted class docs.
2024-02-25 10:26:26 +01:00
<class name="TileMap" inherits="Node2D" version="4.3">
Re-extracted the class docs.
2022-03-16 02:51:50 +01:00
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="clear">
<return type="void" />
<description>
</description>
</method>
<method name="fix_invalid_tiles">
<return type="void" />
<description>
</description>
</method>
<method name="get_cell" qualifiers="const">
<return type="int" />
<argument index="0" name="x" type="int" />
<argument index="1" name="y" type="int" />
<description>
</description>
</method>
<method name="get_cell_autotile_coord" qualifiers="const">
<return type="Vector2" />
<argument index="0" name="x" type="int" />
<argument index="1" name="y" type="int" />
<description>
</description>
</method>
<method name="get_cellv" qualifiers="const">
<return type="int" />
<argument index="0" name="position" type="Vector2" />
<description>
</description>
</method>
<method name="get_collision_layer_bit" qualifiers="const">
<return type="bool" />
<argument index="0" name="bit" type="int" />
<description>
</description>
</method>
<method name="get_collision_mask_bit" qualifiers="const">
<return type="bool" />
<argument index="0" name="bit" type="int" />
<description>
</description>
</method>
Re-extracted class docs. Also fixed smaller issues.
2023-09-10 08:42:24 +02:00
<method name="get_navigation_map" qualifiers="const">
<return type="RID" />
<description>
Returns the current navigation map [RID] use by this region.
</description>
</method>
Re-extracted the class docs.
2022-03-16 02:51:50 +01:00
<method name="get_used_cells" qualifiers="const">
<return type="Array" />
<description>
</description>
</method>
<method name="get_used_cells_by_id" qualifiers="const">
<return type="Array" />
<argument index="0" name="id" type="int" />
<description>
</description>
</method>
<method name="get_used_rect">
<return type="Rect2" />
<description>
</description>
</method>
<method name="is_cell_transposed" qualifiers="const">
<return type="bool" />
<argument index="0" name="x" type="int" />
<argument index="1" name="y" type="int" />
<description>
</description>
</method>
<method name="is_cell_x_flipped" qualifiers="const">
<return type="bool" />
<argument index="0" name="x" type="int" />
<argument index="1" name="y" type="int" />
<description>
</description>
</method>
<method name="is_cell_y_flipped" qualifiers="const">
<return type="bool" />
<argument index="0" name="x" type="int" />
<argument index="1" name="y" type="int" />
<description>
</description>
</method>
<method name="map_to_world" qualifiers="const">
<return type="Vector2" />
<argument index="0" name="map_position" type="Vector2" />
<argument index="1" name="ignore_half_ofs" type="bool" default="false" />
<description>
</description>
</method>
<method name="set_cell">
<return type="void" />
<argument index="0" name="x" type="int" />
<argument index="1" name="y" type="int" />
<argument index="2" name="tile" type="int" />
<argument index="3" name="flip_x" type="bool" default="false" />
<argument index="4" name="flip_y" type="bool" default="false" />
<argument index="5" name="transpose" type="bool" default="false" />
<argument index="6" name="autotile_coord" type="Vector2" default="Vector2( 0, 0 )" />
<description>
</description>
</method>
<method name="set_cellv">
<return type="void" />
<argument index="0" name="position" type="Vector2" />
<argument index="1" name="tile" type="int" />
<argument index="2" name="flip_x" type="bool" default="false" />
<argument index="3" name="flip_y" type="bool" default="false" />
<argument index="4" name="transpose" type="bool" default="false" />
<description>
</description>
</method>
<method name="set_collision_layer_bit">
<return type="void" />
<argument index="0" name="bit" type="int" />
<argument index="1" name="value" type="bool" />
<description>
</description>
</method>
<method name="set_collision_mask_bit">
<return type="void" />
<argument index="0" name="bit" type="int" />
<argument index="1" name="value" type="bool" />
<description>
</description>
</method>
Re-extracted class docs. Also fixed smaller issues.
2023-09-10 08:42:24 +02:00
<method name="set_navigation_map">
<return type="void" />
<argument index="0" name="navigation_map" type="RID" />
<description>
Sets the [RID] of the navigation map this region should use. By default the region will automatically join the [World2D] default navigation map so this function is only required to override the default map.
</description>
</method>
Re-extracted the class docs.
2022-03-16 02:51:50 +01:00
<method name="update_bitmask_area">
<return type="void" />
<argument index="0" name="position" type="Vector2" />
<description>
</description>
</method>
<method name="update_bitmask_region">
<return type="void" />
<argument index="0" name="start" type="Vector2" default="Vector2( 0, 0 )" />
<argument index="1" name="end" type="Vector2" default="Vector2( 0, 0 )" />
<description>
</description>
</method>
<method name="update_dirty_quadrants">
<return type="void" />
<description>
</description>
</method>
<method name="world_to_map" qualifiers="const">
<return type="Vector2" />
<argument index="0" name="world_position" type="Vector2" />
<description>
</description>
</method>
</methods>
<members>
Re-extracted class docs pt3.
2023-06-13 17:34:41 +02:00
<member name="bake_navigation" type="bool" setter="set_bake_navigation" getter="is_baking_navigation" default="false">
Ported the docs from the navigation mesh generator rework pr.
2023-06-06 16:52:04 +02:00
If [code]true[/code], this TileMap creates a navigation region for each cell that uses a layer with a navigation polygon.
Re-extracted class docs.
2022-08-21 00:40:49 +02:00
</member>
Re-extracted the class docs.
2022-03-16 02:51:50 +01:00
<member name="cell_clip_uv" type="bool" setter="set_clip_uv" getter="get_clip_uv" default="false">
</member>
<member name="cell_custom_transform" type="Transform2D" setter="set_custom_transform" getter="get_custom_transform" default="Transform2D( 64, 0, 0, 64, 0, 0 )">
</member>
Renamed RTileMap ro TileMap and RTileSet to TileSet, as it does not need to be able to live alongside Godot's TileMap anymore.
2022-10-09 11:45:57 +02:00
<member name="cell_half_offset" type="int" setter="set_half_offset" getter="get_half_offset" enum="TileMap.HalfOffset" default="2">
Re-extracted the class docs.
2022-03-16 02:51:50 +01:00
</member>
<member name="cell_quadrant_size" type="int" setter="set_quadrant_size" getter="get_quadrant_size" default="16">
</member>
<member name="cell_size" type="Vector2" setter="set_cell_size" getter="get_cell_size" default="Vector2( 64, 64 )">
</member>
Renamed RTileMap ro TileMap and RTileSet to TileSet, as it does not need to be able to live alongside Godot's TileMap anymore.
2022-10-09 11:45:57 +02:00
<member name="cell_tile_origin" type="int" setter="set_tile_origin" getter="get_tile_origin" enum="TileMap.TileOrigin" default="0">
Re-extracted the class docs.
2022-03-16 02:51:50 +01:00
</member>
<member name="cell_y_sort" type="bool" setter="set_y_sort_mode" getter="is_y_sort_mode_enabled" default="false">
</member>
<member name="centered_textures" type="bool" setter="set_centered_textures" getter="is_centered_textures_enabled" default="false">
</member>
<member name="collision_bounce" type="float" setter="set_collision_bounce" getter="get_collision_bounce" default="0.0">
</member>
<member name="collision_friction" type="float" setter="set_collision_friction" getter="get_collision_friction" default="1.0">
</member>
<member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer" default="1">
</member>
<member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="1">
</member>
<member name="collision_use_kinematic" type="bool" setter="set_collision_use_kinematic" getter="get_collision_use_kinematic" default="false">
</member>
<member name="collision_use_parent" type="bool" setter="set_collision_use_parent" getter="get_collision_use_parent" default="false">
</member>
<member name="compatibility_mode" type="bool" setter="set_compatibility_mode" getter="is_compatibility_mode_enabled" default="false">
</member>
Renamed RTileMap ro TileMap and RTileSet to TileSet, as it does not need to be able to live alongside Godot's TileMap anymore.
2022-10-09 11:45:57 +02:00
<member name="mode" type="int" setter="set_mode" getter="get_mode" enum="TileMap.Mode" default="0">
Re-extracted the class docs.
2022-03-16 02:51:50 +01:00
</member>
Re-extracted class docs.
2022-08-21 00:40:49 +02:00
<member name="navigation_layers" type="int" setter="set_navigation_layers" getter="get_navigation_layers" default="1">
</member>
Re-extracted the class docs.
2022-03-16 02:51:50 +01:00
<member name="occluder_light_mask" type="int" setter="set_occluder_light_mask" getter="get_occluder_light_mask" default="1">
</member>
<member name="show_collision" type="bool" setter="set_show_collision" getter="is_show_collision_enabled" default="false">
</member>
Renamed RTileMap ro TileMap and RTileSet to TileSet, as it does not need to be able to live alongside Godot's TileMap anymore.
2022-10-09 11:45:57 +02:00
<member name="tile_set" type="TileSet" setter="set_tileset" getter="get_tileset">
Re-extracted the class docs.
2022-03-16 02:51:50 +01:00
</member>
<member name="use_rao" type="bool" setter="set_use_rao" getter="get_use_rao" default="true">
</member>
</members>
<signals>
<signal name="settings_changed">
<description>
</description>
</signal>
</signals>
<constants>
<constant name="INVALID_CELL" value="-1">
</constant>
<constant name="MODE_SQUARE" value="0" enum="Mode">
</constant>
<constant name="MODE_ISOMETRIC" value="1" enum="Mode">
</constant>
<constant name="MODE_CUSTOM" value="2" enum="Mode">
</constant>
<constant name="HALF_OFFSET_X" value="0" enum="HalfOffset">
</constant>
<constant name="HALF_OFFSET_Y" value="1" enum="HalfOffset">
</constant>
<constant name="HALF_OFFSET_DISABLED" value="2" enum="HalfOffset">
</constant>
<constant name="HALF_OFFSET_NEGATIVE_X" value="3" enum="HalfOffset">
</constant>
<constant name="HALF_OFFSET_NEGATIVE_Y" value="4" enum="HalfOffset">
</constant>
<constant name="TILE_ORIGIN_TOP_LEFT" value="0" enum="TileOrigin">
</constant>
<constant name="TILE_ORIGIN_CENTER" value="1" enum="TileOrigin">
</constant>
<constant name="TILE_ORIGIN_BOTTOM_LEFT" value="2" enum="TileOrigin">
</constant>
</constants>
</class>
Reference in New Issue Copy Permalink