diff options
Diffstat (limited to 'doc/classes')
-rw-r--r-- | doc/classes/@GlobalScope.xml | 10 | ||||
-rw-r--r-- | doc/classes/AnimationPlayer.xml | 4 | ||||
-rw-r--r-- | doc/classes/BoxMesh.xml | 1 | ||||
-rw-r--r-- | doc/classes/Camera3D.xml | 2 | ||||
-rw-r--r-- | doc/classes/Image.xml | 6 | ||||
-rw-r--r-- | doc/classes/PlaneMesh.xml | 1 | ||||
-rw-r--r-- | doc/classes/Rect2.xml | 2 | ||||
-rw-r--r-- | doc/classes/Rect2i.xml | 2 | ||||
-rw-r--r-- | doc/classes/XRController3D.xml | 2 | ||||
-rw-r--r-- | doc/classes/XRPositionalTracker.xml | 14 |
10 files changed, 31 insertions, 13 deletions
diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index f94eb7adef..3f0a7b7c25 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -2423,6 +2423,16 @@ <constant name="PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS" value="21" enum="PropertyHint"> Hints that an image is compressed using lossless compression. </constant> + <constant name="PROPERTY_HINT_TYPE_STRING" value="23" enum="PropertyHint"> + Hint that a property represents a particular type. If a property is [constant TYPE_STRING], allows to set a type from the create dialog. If you need to create an [Array] to contain elements of a specific type, the [code]hint_string[/code] must encode nested types using [code]":"[/code] and [code]"/"[/code] for specifying [Resource] types. For instance: + [codeblock] + hint_string = "%s:" % [TYPE_INT] # Array of inteters. + hint_string = "%s:%s:" % [TYPE_ARRAY, TYPE_REAL] # Two-dimensional array of floats. + hint_string = "%s/%s:Resource" % [TYPE_OBJECT, TYPE_OBJECT] # Array of resources. + hint_string = "%s:%s/%s:Resource" % [TYPE_ARRAY, TYPE_OBJECT, TYPE_OBJECT] # Two-dimensional array of resources. + [/codeblock] + [b]Note:[/b] the final colon is required to specify for properly detecting built-in types. + </constant> <constant name="PROPERTY_USAGE_STORAGE" value="1" enum="PropertyUsageFlags"> The property is serialized and saved in the scene file (default). </constant> diff --git a/doc/classes/AnimationPlayer.xml b/doc/classes/AnimationPlayer.xml index de2087d930..bebff61671 100644 --- a/doc/classes/AnimationPlayer.xml +++ b/doc/classes/AnimationPlayer.xml @@ -260,6 +260,10 @@ <member name="playback_speed" type="float" setter="set_speed_scale" getter="get_speed_scale" default="1.0"> The speed scaling ratio. For instance, if this value is 1, then the animation plays at normal speed. If it's 0.5, then it plays at half speed. If it's 2, then it plays at double speed. </member> + <member name="reset_on_save" type="bool" setter="set_reset_on_save_enabled" getter="is_reset_on_save_enabled" default="true"> + This is used by the editor. If set to [code]true[/code], the scene will be saved with the effects of the reset animation applied (as if it had been seeked to time 0), then reverted after saving. + In other words, the saved scene file will contain the "default pose", as defined by the reset animation, if any, with the editor keeping the values that the nodes had before saving. + </member> <member name="root_node" type="NodePath" setter="set_root" getter="get_root" default="NodePath("..")"> The node from which node path references will travel. </member> diff --git a/doc/classes/BoxMesh.xml b/doc/classes/BoxMesh.xml index 88d22ac899..8a1b9e939e 100644 --- a/doc/classes/BoxMesh.xml +++ b/doc/classes/BoxMesh.xml @@ -6,6 +6,7 @@ <description> Generate an axis-aligned box [PrimitiveMesh]. The box's UV layout is arranged in a 3×2 layout that allows texturing each face individually. To apply the same texture on all faces, change the material's UV property to [code]Vector3(3, 2, 1)[/code]. + [b]Note:[/b] When using a large textured [BoxMesh] (e.g. as a floor), you may stumble upon UV jittering issues depending on the camera angle. To solve this, increase [member subdivide_depth], [member subdivide_height] and [member subdivide_width] until you no longer notice UV jittering. </description> <tutorials> </tutorials> diff --git a/doc/classes/Camera3D.xml b/doc/classes/Camera3D.xml index b3fe452b12..052b23a7ab 100644 --- a/doc/classes/Camera3D.xml +++ b/doc/classes/Camera3D.xml @@ -189,7 +189,7 @@ <member name="environment" type="Environment" setter="set_environment" getter="get_environment"> The [Environment] to use for this camera. </member> - <member name="far" type="float" setter="set_zfar" getter="get_zfar" default="100.0"> + <member name="far" type="float" setter="set_zfar" getter="get_zfar" default="4000.0"> The distance to the far culling boundary for this camera relative to its local Z axis. </member> <member name="fov" type="float" setter="set_fov" getter="get_fov" default="75.0"> diff --git a/doc/classes/Image.xml b/doc/classes/Image.xml index 71db1e5106..414249f110 100644 --- a/doc/classes/Image.xml +++ b/doc/classes/Image.xml @@ -422,7 +422,7 @@ <argument index="2" name="interpolation" type="int" enum="Image.Interpolation" default="1"> </argument> <description> - Resizes the image to the given [code]width[/code] and [code]height[/code]. New pixels are calculated using [code]interpolation[/code]. See [code]interpolation[/code] constants. + Resizes the image to the given [code]width[/code] and [code]height[/code]. New pixels are calculated using the [code]interpolation[/code] mode defined via [enum Interpolation] constants. </description> </method> <method name="resize_to_po2"> @@ -430,8 +430,10 @@ </return> <argument index="0" name="square" type="bool" default="false"> </argument> + <argument index="1" name="interpolation" type="int" enum="Image.Interpolation" default="1"> + </argument> <description> - Resizes the image to the nearest power of 2 for the width and height. If [code]square[/code] is [code]true[/code] then set width and height to be the same. + Resizes the image to the nearest power of 2 for the width and height. If [code]square[/code] is [code]true[/code] then set width and height to be the same. New pixels are calculated using the [code]interpolation[/code] mode defined via [enum Interpolation] constants. </description> </method> <method name="rgbe_to_srgb"> diff --git a/doc/classes/PlaneMesh.xml b/doc/classes/PlaneMesh.xml index 2081442e04..333d687e91 100644 --- a/doc/classes/PlaneMesh.xml +++ b/doc/classes/PlaneMesh.xml @@ -5,6 +5,7 @@ </brief_description> <description> Class representing a planar [PrimitiveMesh]. This flat mesh does not have a thickness. By default, this mesh is aligned on the X and Z axes; this default rotation isn't suited for use with billboarded materials. For billboarded materials, use [QuadMesh] instead. + [b]Note:[/b] When using a large textured [PlaneMesh] (e.g. as a floor), you may stumble upon UV jittering issues depending on the camera angle. To solve this, increase [member subdivide_depth] and [member subdivide_width] until you no longer notice UV jittering. </description> <tutorials> </tutorials> diff --git a/doc/classes/Rect2.xml b/doc/classes/Rect2.xml index 02a77a0e24..5682e12b63 100644 --- a/doc/classes/Rect2.xml +++ b/doc/classes/Rect2.xml @@ -72,7 +72,7 @@ Returns a [Rect2] with equivalent position and area, modified so that the top-left corner is the origin and [code]width[/code] and [code]height[/code] are positive. </description> </method> - <method name="clip"> + <method name="intersection"> <return type="Rect2"> </return> <argument index="0" name="b" type="Rect2"> diff --git a/doc/classes/Rect2i.xml b/doc/classes/Rect2i.xml index e8b75a6ac6..ef12c8de1e 100644 --- a/doc/classes/Rect2i.xml +++ b/doc/classes/Rect2i.xml @@ -70,7 +70,7 @@ Returns a [Rect2i] with equivalent position and area, modified so that the top-left corner is the origin and [code]width[/code] and [code]height[/code] are positive. </description> </method> - <method name="clip"> + <method name="intersection"> <return type="Rect2i"> </return> <argument index="0" name="b" type="Rect2i"> diff --git a/doc/classes/XRController3D.xml b/doc/classes/XRController3D.xml index 78684d10ee..345e5efdee 100644 --- a/doc/classes/XRController3D.xml +++ b/doc/classes/XRController3D.xml @@ -19,7 +19,7 @@ If active, returns the name of the associated controller if provided by the AR/VR SDK used. </description> </method> - <method name="get_hand" qualifiers="const"> + <method name="get_tracker_hand" qualifiers="const"> <return type="int" enum="XRPositionalTracker.TrackerHand"> </return> <description> diff --git a/doc/classes/XRPositionalTracker.xml b/doc/classes/XRPositionalTracker.xml index 5ed7a26b19..36ff312e4d 100644 --- a/doc/classes/XRPositionalTracker.xml +++ b/doc/classes/XRPositionalTracker.xml @@ -12,7 +12,7 @@ <link title="VR tutorial index">https://docs.godotengine.org/en/latest/tutorials/vr/index.html</link> </tutorials> <methods> - <method name="get_hand" qualifiers="const"> + <method name="get_tracker_hand" qualifiers="const"> <return type="int" enum="XRPositionalTracker.TrackerHand"> </return> <description> @@ -68,18 +68,18 @@ Returns the tracker's type, which will be one of the values from the [enum XRServer.TrackerType] enum. </description> </method> - <method name="get_tracks_orientation" qualifiers="const"> + <method name="is_tracking_orientation" qualifiers="const"> <return type="bool"> </return> <description> - Returns [code]true[/code] if this device tracks orientation. + Returns [code]true[/code] if this device is tracking orientation. </description> </method> - <method name="get_tracks_position" qualifiers="const"> + <method name="is_tracking_position" qualifiers="const"> <return type="bool"> </return> <description> - Returns [code]true[/code] if this device tracks position. + Returns [code]true[/code] if this device is tracking position. </description> </method> <method name="get_transform" qualifiers="const"> @@ -101,10 +101,10 @@ <constant name="TRACKER_HAND_UNKNOWN" value="0" enum="TrackerHand"> The hand this tracker is held in is unknown or not applicable. </constant> - <constant name="TRACKER_LEFT_HAND" value="1" enum="TrackerHand"> + <constant name="TRACKER_HAND_LEFT" value="1" enum="TrackerHand"> This tracker is the left hand controller. </constant> - <constant name="TRACKER_RIGHT_HAND" value="2" enum="TrackerHand"> + <constant name="TRACKER_HAND_RIGHT" value="2" enum="TrackerHand"> This tracker is the right hand controller. </constant> </constants> |