diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/BakedLightmap.xml | 2 | ||||
| -rw-r--r-- | doc/classes/Spatial.xml | 1 | ||||
| -rw-r--r-- | doc/classes/TCP_Server.xml | 7 | ||||
| -rw-r--r-- | doc/classes/TileMap.xml | 12 | ||||
| -rw-r--r-- | doc/classes/Transform.xml | 4 | ||||
| -rw-r--r-- | doc/classes/Transform2D.xml | 3 |
6 files changed, 23 insertions, 6 deletions
diff --git a/doc/classes/BakedLightmap.xml b/doc/classes/BakedLightmap.xml index 571a6fde80..4baf3a6bb2 100644 --- a/doc/classes/BakedLightmap.xml +++ b/doc/classes/BakedLightmap.xml @@ -31,6 +31,8 @@ <member name="bake_cell_size" type="float" setter="set_bake_cell_size" getter="get_bake_cell_size" default="0.25"> Grid subdivision size for lightmapper calculation. The default value will work for most cases. Increase for better lighting on small details or if your scene is very large. </member> + <member name="bake_default_texels_per_unit" type="float" setter="set_bake_default_texels_per_unit" getter="get_bake_default_texels_per_unit" default="20.0"> + </member> <member name="bake_energy" type="float" setter="set_energy" getter="get_energy" default="1.0"> </member> <member name="bake_extents" type="Vector3" setter="set_extents" getter="get_extents" default="Vector3( 10, 10, 10 )"> diff --git a/doc/classes/Spatial.xml b/doc/classes/Spatial.xml index 9f4118aa7b..09a5bf3b8f 100644 --- a/doc/classes/Spatial.xml +++ b/doc/classes/Spatial.xml @@ -274,6 +274,7 @@ </argument> <description> Changes the node's position by given offset [Vector3]. + Note that the translation [code]offset[/code] is affected by the node's scale, so if scaled by e.g. [code](10, 1, 1)[/code], a translation by an offset of [code](2, 0, 0)[/code] would actually add 20 ([code]2 * 10[/code]) to the X coordinate. </description> </method> <method name="translate_object_local"> diff --git a/doc/classes/TCP_Server.xml b/doc/classes/TCP_Server.xml index 432d83f25b..cac3a0b082 100644 --- a/doc/classes/TCP_Server.xml +++ b/doc/classes/TCP_Server.xml @@ -16,6 +16,13 @@ Returns [code]true[/code] if a connection is available for taking. </description> </method> + <method name="is_listening" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns [code]true[/code] if the server is currently listening for connections. + </description> + </method> <method name="listen"> <return type="int" enum="Error"> </return> diff --git a/doc/classes/TileMap.xml b/doc/classes/TileMap.xml index a0111d3262..3f9c2e8647 100644 --- a/doc/classes/TileMap.xml +++ b/doc/classes/TileMap.xml @@ -274,12 +274,7 @@ <member name="cell_y_sort" type="bool" setter="set_y_sort_mode" getter="is_y_sort_mode_enabled" default="false"> If [code]true[/code], the TileMap's children will be drawn in order of their Y coordinate. </member> - <member name="compatibility_mode" type="bool" setter="set_compatibility_mode" getter="is_compatibility_mode_enabled"> - If [code]true[/code], the compatibility with the tilemaps made in Godot 3.1 or earlier is maintained (textures move when the tile origin changes and rotate if the texture size is not homogeneous). This mode presents problems when doing [code]flip_h[/code], [code]flip_v[/code] and [code]transpose[/code] tile operations on non-homogeneous isometric tiles (e.g. 2:1), in which the texture could not coincide with the collision, thus it is not recommended for isometric or non-square tiles. - If [code]false[/code], the textures do not move when doing [code]flip_h[/code], [code]flip_v[/code] operations if no offset is used, nor when changing the tile origin. - The compatibility mode doesn't work with the [member centered_textures] option, because displacing textures with the [member cell_tile_origin] option or in irregular tiles is not relevant when centering those textures. - </member> - <member name="centered_textures" type="bool" setter="set_centered_textures" getter="is_centered_textures_enabled"> + <member name="centered_textures" type="bool" setter="set_centered_textures" getter="is_centered_textures_enabled" default="false"> If [code]true[/code], the textures will be centered in the middle of each tile. This is useful for certain isometric or top-down modes when textures are made larger or smaller than the tiles (e.g. to avoid flickering on tile edges). The offset is still applied, but from the center of the tile. If used, [member compatibility_mode] is ignored. If [code]false[/code], the texture position start in the top-left corner unless [member compatibility_mode] is enabled. </member> @@ -300,6 +295,11 @@ </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"> + If [code]true[/code], the compatibility with the tilemaps made in Godot 3.1 or earlier is maintained (textures move when the tile origin changes and rotate if the texture size is not homogeneous). This mode presents problems when doing [code]flip_h[/code], [code]flip_v[/code] and [code]transpose[/code] tile operations on non-homogeneous isometric tiles (e.g. 2:1), in which the texture could not coincide with the collision, thus it is not recommended for isometric or non-square tiles. + If [code]false[/code], the textures do not move when doing [code]flip_h[/code], [code]flip_v[/code] operations if no offset is used, nor when changing the tile origin. + The compatibility mode doesn't work with the [member centered_textures] option, because displacing textures with the [member cell_tile_origin] option or in irregular tiles is not relevant when centering those textures. + </member> <member name="mode" type="int" setter="set_mode" getter="get_mode" enum="TileMap.Mode" default="0"> The TileMap orientation mode. See [enum Mode] for possible values. </member> diff --git a/doc/classes/Transform.xml b/doc/classes/Transform.xml index 80a393dcee..9916d25af5 100644 --- a/doc/classes/Transform.xml +++ b/doc/classes/Transform.xml @@ -167,12 +167,16 @@ </members> <constants> <constant name="IDENTITY" value="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )"> + [Transform] with no translation, rotation or scaling applied. When applied to other data structures, [constant IDENTITY] performs no transformation. </constant> <constant name="FLIP_X" value="Transform( -1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )"> + [Transform] with mirroring applied perpendicular to the YZ plane. </constant> <constant name="FLIP_Y" value="Transform( 1, 0, 0, 0, -1, 0, 0, 0, 1, 0, 0, 0 )"> + [Transform] with mirroring applied perpendicular to the XZ plane. </constant> <constant name="FLIP_Z" value="Transform( 1, 0, 0, 0, 1, 0, 0, 0, -1, 0, 0, 0 )"> + [Transform] with mirroring applied perpendicular to the XY plane. </constant> </constants> </class> diff --git a/doc/classes/Transform2D.xml b/doc/classes/Transform2D.xml index c5ae88d050..f6fce1aaa1 100644 --- a/doc/classes/Transform2D.xml +++ b/doc/classes/Transform2D.xml @@ -172,10 +172,13 @@ </members> <constants> <constant name="IDENTITY" value="Transform2D( 1, 0, 0, 1, 0, 0 )"> + [Transform2D] with no translation, rotation or scaling applied. When applied to other data structures, [constant IDENTITY] performs no transformation. </constant> <constant name="FLIP_X" value="Transform2D( -1, 0, 0, 1, 0, 0 )"> + [Transform2D] with mirroring applied parallel to the X axis. </constant> <constant name="FLIP_Y" value="Transform2D( 1, 0, 0, -1, 0, 0 )"> + [Transform2D] with mirroring applied parallel to the Y axis. </constant> </constants> </class> |