diff options
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/Area2D.xml | 6 | ||||
| -rw-r--r-- | doc/classes/Area3D.xml | 6 | ||||
| -rw-r--r-- | doc/classes/DirectionalLight2D.xml | 2 | ||||
| -rw-r--r-- | doc/classes/PointLight2D.xml | 2 | ||||
| -rw-r--r-- | doc/classes/TileMap.xml | 11 | ||||
| -rw-r--r-- | doc/classes/Time.xml | 10 |
6 files changed, 28 insertions, 9 deletions
diff --git a/doc/classes/Area2D.xml b/doc/classes/Area2D.xml index ddfc3b1869..c6a3f87042 100644 --- a/doc/classes/Area2D.xml +++ b/doc/classes/Area2D.xml @@ -16,13 +16,15 @@ <method name="get_overlapping_areas" qualifiers="const"> <return type="Area2D[]" /> <description> - Returns a list of intersecting [Area2D]s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. + Returns a list of intersecting [Area2D]s. The overlapping area's [member CollisionObject2D.collision_layer] must be part of this area's [member CollisionObject2D.collision_mask] in order to be detected. + For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. </description> </method> <method name="get_overlapping_bodies" qualifiers="const"> <return type="Node2D[]" /> <description> - Returns a list of intersecting [PhysicsBody2D]s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. + Returns a list of intersecting [PhysicsBody2D]s. The overlapping body's [member CollisionObject2D.collision_layer] must be part of this area's [member CollisionObject2D.collision_mask] in order to be detected. + For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. </description> </method> <method name="overlaps_area" qualifiers="const"> diff --git a/doc/classes/Area3D.xml b/doc/classes/Area3D.xml index 896bfcd14e..14225c52a4 100644 --- a/doc/classes/Area3D.xml +++ b/doc/classes/Area3D.xml @@ -14,13 +14,15 @@ <method name="get_overlapping_areas" qualifiers="const"> <return type="Area3D[]" /> <description> - Returns a list of intersecting [Area3D]s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. + Returns a list of intersecting [Area3D]s. The overlapping area's [member CollisionObject3D.collision_layer] must be part of this area's [member CollisionObject3D.collision_mask] in order to be detected. + For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. </description> </method> <method name="get_overlapping_bodies" qualifiers="const"> <return type="Node3D[]" /> <description> - Returns a list of intersecting [PhysicsBody3D]s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. + Returns a list of intersecting [PhysicsBody3D]s. The overlapping body's [member CollisionObject3D.collision_layer] must be part of this area's [member CollisionObject3D.collision_mask] in order to be detected. + For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. </description> </method> <method name="overlaps_area" qualifiers="const"> diff --git a/doc/classes/DirectionalLight2D.xml b/doc/classes/DirectionalLight2D.xml index 317cf6e66c..1e5c9bc09a 100644 --- a/doc/classes/DirectionalLight2D.xml +++ b/doc/classes/DirectionalLight2D.xml @@ -8,7 +8,7 @@ </tutorials> <members> <member name="height" type="float" setter="set_height" getter="get_height" default="0.0"> - The height of the light. Used with 2D normal mapping. + The height of the light. Used with 2D normal mapping. Ranges from 0 (parallel to the plane) to 1 (perpendicular to the plane). </member> <member name="max_distance" type="float" setter="set_max_distance" getter="get_max_distance" default="10000.0"> </member> diff --git a/doc/classes/PointLight2D.xml b/doc/classes/PointLight2D.xml index 9c13179056..ec809ed0a8 100644 --- a/doc/classes/PointLight2D.xml +++ b/doc/classes/PointLight2D.xml @@ -8,7 +8,7 @@ </tutorials> <members> <member name="height" type="float" setter="set_height" getter="get_height" default="0.0"> - The height of the light. Used with 2D normal mapping. + The height of the light. Used with 2D normal mapping. The units are in pixels, e.g. if the height is 100, then it will illuminate an object 100 pixels away at a 45° angle to the plane. </member> <member name="offset" type="Vector2" setter="set_texture_offset" getter="get_texture_offset" default="Vector2(0, 0)"> The offset of the light's [member texture]. diff --git a/doc/classes/TileMap.xml b/doc/classes/TileMap.xml index e65d5b4533..4ac5718e04 100644 --- a/doc/classes/TileMap.xml +++ b/doc/classes/TileMap.xml @@ -204,6 +204,17 @@ - The alternative tile identifier [code]alternative_tile[/code] identifies a tile alternative the source is a [TileSetAtlasSource], and the scene for a [TileSetScenesCollectionSource]. </description> </method> + <method name="set_cells_from_surrounding_terrains"> + <return type="void" /> + <argument index="0" name="layer" type="int" /> + <argument index="1" name="cells" type="Vector2i[]" /> + <argument index="2" name="terrain_set" type="int" /> + <argument index="3" name="ignore_empty_terrains" type="bool" default="true" /> + <description> + Updates all the cells in the [code]cells[/code] coordinates array and replace them by tiles that matches the surrounding cells terrains. Only cells form the given [code]terrain_set[/code] are considered. + If [code]ignore_empty_terrains[/code] is true, zones with no terrain defined are ignored to select the tiles. + </description> + </method> <method name="set_layer_enabled"> <return type="void" /> <argument index="0" name="layer" type="int" /> diff --git a/doc/classes/Time.xml b/doc/classes/Time.xml index 24ce30154d..d8e1d874f7 100644 --- a/doc/classes/Time.xml +++ b/doc/classes/Time.xml @@ -6,7 +6,7 @@ <description> The Time singleton allows converting time between various formats and also getting time information from the system. This class conforms with as many of the ISO 8601 standards as possible. All dates follow the Proleptic Gregorian calendar. As such, the day before [code]1582-10-15[/code] is [code]1582-10-14[/code], not [code]1582-10-04[/code]. The year before 1 AD (aka 1 BC) is number [code]0[/code], with the year before that (2 BC) being [code]-1[/code], etc. - Conversion methods assume "the same timezone", and do not handle timezone conversions or DST automatically. Leap seconds are also not handled, they must be done manually if desired. Suffixes such as "Z" are not handled, you need to strip them away manually. + Conversion methods assume "the same timezone", and do not handle timezone conversions or DST automatically. Unix epoch assumes UTC. Leap seconds are also not handled, they must be done manually if desired. Suffixes such as "Z" are not handled, you need to strip them away manually. [b]Important:[/b] The [code]_from_system[/code] methods use the system clock that the user can manually set. [b]Never use[/b] this method for precise time calculation since its results are subject to automatic adjustments by the user or the operating system. [b]Always use[/b] [method get_ticks_usec] or [method get_ticks_msec] for precise time calculation instead, since they are guaranteed to be monotonic (i.e. never decrease). </description> <tutorials> @@ -100,12 +100,14 @@ <return type="int" /> <description> Returns the amount of time passed in milliseconds since the engine started. + Will always be positive or 0 and uses a 64-bit value (it will wrap after roughly 500 million years). </description> </method> <method name="get_ticks_usec" qualifiers="const"> <return type="int" /> <description> Returns the amount of time passed in microseconds since the engine started. + Will always be positive or 0 and uses a 64-bit value (it will wrap after roughly half a million years). </description> </method> <method name="get_time_dict_from_system" qualifiers="const"> @@ -150,8 +152,9 @@ <description> Converts a dictionary of time values to a Unix timestamp. The given dictionary can be populated with the following keys: [code]year[/code], [code]month[/code], [code]day[/code], [code]hour[/code], [code]minute[/code], and [code]second[/code]. Any other entries (including [code]dst[/code]) are ignored. - If the dictionary is empty, [code]0[/code] is returned. If some keys are omitted, they default to the equivalent values for the Unix epoch timestamp 0 (1970-01-01 at 00:00:00). + If the dictionary is empty, [code]0[/code] is returned. If some keys are omitted, they default to the equivalent values for the Unix epoch timestamp 0 (1970-01-01 at 00:00:00 UTC). You can pass the output from [method get_datetime_dict_from_unix_time] directly into this function and get the same as what was put in. + [b]Note:[/b] Unix timestamps are usually in UTC, the given datetime dict may not be. </description> </method> <method name="get_unix_time_from_datetime_string" qualifiers="const"> @@ -159,12 +162,13 @@ <argument index="0" name="datetime" type="String" /> <description> Converts the given ISO 8601 date and/or time string to a Unix timestamp. The string can contain a date only, a time only, or both. + [b]Note:[/b] Unix timestamps are usually in UTC, the given datetime string may not be. </description> </method> <method name="get_unix_time_from_system" qualifiers="const"> <return type="float" /> <description> - Returns the current Unix timestamp in seconds based on the system time. + Returns the current Unix timestamp in seconds based on the system time in UTC. </description> </method> </methods> |