Relintai/pandemonium_engine
1
0
Fork 0
mirror of https://github.com/Relintai/pandemonium_engine.git synced 2025-01-03 17:39:36 +01:00
Code Issues Packages Projects Releases Wiki Activity

Re-extracted class docs.

Browse Source
This commit is contained in:
Relintai 2024-03-10 10:36:13 +01:00
parent 0e32e11ea1
commit fb99db4585
10 changed files with 50 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
modules/layered_tile_map/doc_classes/LayeredTileData.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="LayeredTileData" inherits="Object" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <class name="LayeredTileData" inherits="Object" version="4.3">
<brief_description> <brief_description>
Settings for a single tile in a [LayeredTileSet]. Settings for a single tile in a [LayeredTileSet].
</brief_description> </brief_description>
@ -214,7 +214,7 @@
<member name="material" type="Material" setter="set_material" getter="get_material"> <member name="material" type="Material" setter="set_material" getter="get_material">
The [Material] to use for this [LayeredTileData]. This can be a [CanvasItemMaterial] to use the default shader, or a [ShaderMaterial] to use a custom shader. The [Material] to use for this [LayeredTileData]. This can be a [CanvasItemMaterial] to use the default shader, or a [ShaderMaterial] to use a custom shader.
</member> </member>
<member name="modulate" type="Color" setter="set_modulate" getter="get_modulate" default="Color(1, 1, 1, 1)" keywords="color, colour"> <member name="modulate" type="Color" setter="set_modulate" getter="get_modulate" default="Color( 1, 1, 1, 1 )">
Color modulation of the tile. Color modulation of the tile.
</member> </member>
<member name="probability" type="float" setter="set_probability" getter="get_probability" default="1.0"> <member name="probability" type="float" setter="set_probability" getter="get_probability" default="1.0">
@ -246,4 +246,6 @@
</description> </description>
</signal> </signal>
</signals> </signals>
<constants>
</constants>
</class> </class>

8
modules/layered_tile_map/doc_classes/LayeredTileMap.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="LayeredTileMap" inherits="LayeredTileMapLayerGroup" keywords="gridmap" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <class name="LayeredTileMap" inherits="LayeredTileMapLayerGroup" version="4.3">
<brief_description> <brief_description>
Node for 2D tile-based maps. Node for 2D tile-based maps.
</brief_description> </brief_description>
@ -76,7 +76,7 @@
Clears cells that do not exist in the tileset. Clears cells that do not exist in the tileset.
</description> </description>
</method> </method>
<method name="force_update" deprecated="Use [method notify_runtime_tile_data_update] and/or [method update_internals] instead."> <method name="force_update">
<return type="void" /> <return type="void" />
<argument index="0" name="layer" type="int" default="-1" /> <argument index="0" name="layer" type="int" default="-1" />
<description> <description>
@ -196,7 +196,7 @@
Returns the number of layers in the LayeredTileMap. Returns the number of layers in the LayeredTileMap.
</description> </description>
</method> </method>
<method name="get_navigation_map" qualifiers="const" deprecated="Use [method get_layer_navigation_map] instead."> <method name="get_navigation_map" qualifiers="const">
<return type="RID" /> <return type="RID" />
<argument index="0" name="layer" type="int" /> <argument index="0" name="layer" type="int" />
<description> <description>
@ -445,7 +445,7 @@
If [param layer] is negative, the layers are accessed from the last one. If [param layer] is negative, the layers are accessed from the last one.
</description> </description>
</method> </method>
<method name="set_navigation_map" deprecated="Use [method set_layer_navigation_map] instead."> <method name="set_navigation_map">
<return type="void" /> <return type="void" />
<argument index="0" name="layer" type="int" /> <argument index="0" name="layer" type="int" />
<argument index="1" name="map" type="RID" /> <argument index="1" name="map" type="RID" />

6
modules/layered_tile_map/doc_classes/LayeredTileMapLayerGroup.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="LayeredTileMapLayerGroup" inherits="Node2D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <class name="LayeredTileMapLayerGroup" inherits="YSort" version="4.3">
<brief_description> <brief_description>
Groups a set of tile map layers together, allowing them to share a provided [LayeredTileSet]. Groups a set of tile map layers together, allowing them to share a provided [LayeredTileSet].
</brief_description> </brief_description>
@ -9,9 +9,13 @@
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods>
</methods>
<members> <members>
<member name="tile_set" type="LayeredTileSet" setter="set_tileset" getter="get_tileset"> <member name="tile_set" type="LayeredTileSet" setter="set_tileset" getter="get_tileset">
The assigned [LayeredTileSet]. This LayeredTileSet will be applied to all child layers. The assigned [LayeredTileSet]. This LayeredTileSet will be applied to all child layers.
</member> </member>
</members> </members>
<constants>
</constants>
</class> </class>

16
modules/layered_tile_map/doc_classes/LayeredTileMapPattern.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="LayeredTileMapPattern" inherits="Resource" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <class name="LayeredTileMapPattern" inherits="Resource" version="4.3">
<brief_description> <brief_description>
Holds a pattern to be copied from or pasted into [LayeredTileMap]s. Holds a pattern to be copied from or pasted into [LayeredTileMap]s.
</brief_description> </brief_description>
@ -10,6 +10,12 @@
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods> <methods>
<method name="empty" qualifiers="const">
<return type="bool" />
<description>
Returns whether the pattern is empty or not.
</description>
</method>
<method name="get_cell_alternative_tile" qualifiers="const"> <method name="get_cell_alternative_tile" qualifiers="const">
<return type="int" /> <return type="int" />
<argument index="0" name="coords" type="Vector2i" /> <argument index="0" name="coords" type="Vector2i" />
@ -50,12 +56,6 @@
Returns whether the pattern has a tile at the given coordinates. Returns whether the pattern has a tile at the given coordinates.
</description> </description>
</method> </method>
<method name="empty" qualifiers="const">
<return type="bool" />
<description>
Returns whether the pattern is empty or not.
</description>
</method>
<method name="remove_cell"> <method name="remove_cell">
<return type="void" /> <return type="void" />
<argument index="0" name="coords" type="Vector2i" /> <argument index="0" name="coords" type="Vector2i" />
@ -82,4 +82,6 @@
</description> </description>
</method> </method>
</methods> </methods>
<constants>
</constants>
</class> </class>

6
modules/layered_tile_map/doc_classes/LayeredTileSet.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="LayeredTileSet" inherits="Resource" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <class name="LayeredTileSet" inherits="Resource" version="4.3">
<brief_description> <brief_description>
Tile library for tilemaps. Tile library for tilemaps.
</brief_description> </brief_description>
@ -612,10 +612,10 @@
</method> </method>
</methods> </methods>
<members> <members>
<member name="tile_layout" type="int" setter="set_tile_layout" getter="get_tile_layout" enum="LayeredTileSet.TileLayout" default="0"> <member name="tile_layout" type="int" setter="set_tile_layout" getter="get_tile_layout" enum="LayeredTileSet.TileLayout">
For all half-offset shapes (Isometric, Hexagonal and Half-Offset square), changes the way tiles are indexed in the LayeredTileMap grid. For all half-offset shapes (Isometric, Hexagonal and Half-Offset square), changes the way tiles are indexed in the LayeredTileMap grid.
</member> </member>
<member name="tile_offset_axis" type="int" setter="set_tile_offset_axis" getter="get_tile_offset_axis" enum="LayeredTileSet.TileOffsetAxis" default="0"> <member name="tile_offset_axis" type="int" setter="set_tile_offset_axis" getter="get_tile_offset_axis" enum="LayeredTileSet.TileOffsetAxis">
For all half-offset shapes (Isometric, Hexagonal and Half-Offset square), determines the offset axis. For all half-offset shapes (Isometric, Hexagonal and Half-Offset square), determines the offset axis.
</member> </member>
<member name="tile_shape" type="int" setter="set_tile_shape" getter="get_tile_shape" enum="LayeredTileSet.TileShape" default="0"> <member name="tile_shape" type="int" setter="set_tile_shape" getter="get_tile_shape" enum="LayeredTileSet.TileShape" default="0">

4
modules/layered_tile_map/doc_classes/LayeredTileSetAtlasSource.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="LayeredTileSetAtlasSource" inherits="LayeredTileSetSource" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <class name="LayeredTileSetAtlasSource" inherits="LayeredTileSetSource" version="4.3">
<brief_description> <brief_description>
Exposes a 2D atlas texture as a set of tiles for a [LayeredTileSet] resource. Exposes a 2D atlas texture as a set of tiles for a [LayeredTileSet] resource.
</brief_description> </brief_description>
@ -263,6 +263,8 @@
<member name="margins" type="Vector2i" setter="set_margins" getter="get_margins" default="Vector2i( 0, 0 )"> <member name="margins" type="Vector2i" setter="set_margins" getter="get_margins" default="Vector2i( 0, 0 )">
Margins, in pixels, to offset the origin of the grid in the texture. Margins, in pixels, to offset the origin of the grid in the texture.
</member> </member>
<member name="normal_texture" type="Texture" setter="set_normal_texture" getter="get_normal_texture">
</member>
<member name="separation" type="Vector2i" setter="set_separation" getter="get_separation" default="Vector2i( 0, 0 )"> <member name="separation" type="Vector2i" setter="set_separation" getter="get_separation" default="Vector2i( 0, 0 )">
Separation, in pixels, between each tile texture region of the grid. Separation, in pixels, between each tile texture region of the grid.
</member> </member>

4
modules/layered_tile_map/doc_classes/LayeredTileSetScenesCollectionSource.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="LayeredTileSetScenesCollectionSource" inherits="LayeredTileSetSource" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <class name="LayeredTileSetScenesCollectionSource" inherits="LayeredTileSetSource" version="4.3">
<brief_description> <brief_description>
Exposes a set of scenes as tiles for a [LayeredTileSet] resource. Exposes a set of scenes as tiles for a [LayeredTileSet] resource.
</brief_description> </brief_description>
@ -91,4 +91,6 @@
</description> </description>
</method> </method>
</methods> </methods>
<constants>
</constants>
</class> </class>

4
modules/layered_tile_map/doc_classes/LayeredTileSetSource.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="LayeredTileSetSource" inherits="Resource" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <class name="LayeredTileSetSource" inherits="Resource" version="4.3">
<brief_description> <brief_description>
Exposes a set of tiles for a [LayeredTileSet] resource. Exposes a set of tiles for a [LayeredTileSet] resource.
</brief_description> </brief_description>
@ -59,4 +59,6 @@
</description> </description>
</method> </method>
</methods> </methods>
<constants>
</constants>
</class> </class>

6
modules/web/doc_classes/FileCache.xml
View File

@ -52,7 +52,7 @@
<description> <description>
Returns the absolute path to a file if it exists in the given [member wwwroot]. If it doesn't exists returns an empty [String]. Returns the absolute path to a file if it exists in the given [member wwwroot]. If it doesn't exists returns an empty [String].
Guards against directory traversal. Guards against directory traversal.
Note: file path should be the url you want to access the file with, including lead slash. e.g. http://127.0.0.1/a/b/d.jpg -> /a/b/d.jpg Note: file path should be the url you want to access the file with, including lead slash. e.g. http://127.0.0.1/a/b/d.jpg -&gt; /a/b/d.jpg
</description> </description>
</method> </method>
<method name="wwwroot_get_simplified_abs_path"> <method name="wwwroot_get_simplified_abs_path">
@ -61,7 +61,7 @@
<description> <description>
Returns the absolute path to a file in the given [member wwwroot]. Does not checks if the file exists or not. Returns an empty [String] on error. Returns the absolute path to a file in the given [member wwwroot]. Does not checks if the file exists or not. Returns an empty [String] on error.
Guards against directory traversal. Guards against directory traversal.
Note: file path should be the url you want to access the file with, including lead slash. e.g. http://127.0.0.1/a/b/d.jpg -> /a/b/d.jpg Note: file path should be the url you want to access the file with, including lead slash. e.g. http://127.0.0.1/a/b/d.jpg -&gt; /a/b/d.jpg
</description> </description>
</method> </method>
<method name="wwwroot_has_file"> <method name="wwwroot_has_file">
@ -70,7 +70,7 @@
<description> <description>
Check whether a file exists in the given [member wwwroot]. Check whether a file exists in the given [member wwwroot].
Guards against directory traversal. Guards against directory traversal.
Note: file path should be the url you want to access the file with, including lead slash. e.g. http://127.0.0.1/a/b/d.jpg -> /a/b/d.jpg Note: file path should be the url you want to access the file with, including lead slash. e.g. http://127.0.0.1/a/b/d.jpg -&gt; /a/b/d.jpg
</description> </description>
</method> </method>
</methods> </methods>

2
modules/web/doc_classes/ListWebPage.xml
View File

@ -49,7 +49,7 @@
<member name="max_visible_navigation_links" type="int" setter="set_max_visible_navigation_links" getter="get_max_visible_navigation_links" default="6"> <member name="max_visible_navigation_links" type="int" setter="set_max_visible_navigation_links" getter="get_max_visible_navigation_links" default="6">
This many pagination links will be visible max. This many pagination links will be visible max.
</member> </member>
<member name="paginate" type="bool" setter="set_paginate" getter="get_paginate" default="false"> <member name="paginate" type="bool" setter="set_paginate" getter="get_paginate" default="true">
Whether to allow pagination or not. Whether to allow pagination or not.
</member> </member>
<member name="placeholder_text" type="String" setter="set_placeholder_text" getter="get_placeholder_text" default="&quot;No content yet!&quot;"> <member name="placeholder_text" type="String" setter="set_placeholder_text" getter="get_placeholder_text" default="&quot;No content yet!&quot;">