diff options
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/Color.xml | 11 | ||||
| -rw-r--r-- | doc/classes/EditorPaths.xml | 6 | ||||
| -rw-r--r-- | doc/classes/Vector2.xml | 17 | ||||
| -rw-r--r-- | doc/classes/Vector2i.xml | 11 | ||||
| -rw-r--r-- | doc/classes/Vector3.xml | 20 | ||||
| -rw-r--r-- | doc/classes/Vector3i.xml | 11 |
6 files changed, 67 insertions, 9 deletions
diff --git a/doc/classes/Color.xml b/doc/classes/Color.xml index 6133bb8d8c..ddff92e6fc 100644 --- a/doc/classes/Color.xml +++ b/doc/classes/Color.xml @@ -136,6 +136,17 @@ [/codeblocks] </description> </method> + <method name="clamp" qualifiers="const"> + <return type="Color"> + </return> + <argument index="0" name="min" type="Color" default="Color( 0, 0, 0, 0 )"> + </argument> + <argument index="1" name="max" type="Color" default="Color( 1, 1, 1, 1 )"> + </argument> + <description> + Returns a new color with all components clamped between the components of [code]min[/code] and [code]max[/code], by running [method @GlobalScope.clamp] on each component. + </description> + </method> <method name="darkened" qualifiers="const"> <return type="Color"> </return> diff --git a/doc/classes/EditorPaths.xml b/doc/classes/EditorPaths.xml index b92927fd53..d0d785dbb8 100644 --- a/doc/classes/EditorPaths.xml +++ b/doc/classes/EditorPaths.xml @@ -31,12 +31,6 @@ <description> </description> </method> - <method name="get_settings_dir" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> <method name="is_self_contained" qualifiers="const"> <return type="bool"> </return> diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml index 94d4b1a903..1390a5e45b 100644 --- a/doc/classes/Vector2.xml +++ b/doc/classes/Vector2.xml @@ -110,13 +110,15 @@ Returns the vector with all components rounded up (towards positive infinity). </description> </method> - <method name="clamped" qualifiers="const"> + <method name="clamp" qualifiers="const"> <return type="Vector2"> </return> - <argument index="0" name="length" type="float"> + <argument index="0" name="min" type="Vector2"> + </argument> + <argument index="1" name="max" type="Vector2"> </argument> <description> - Returns the vector with a maximum length by limiting its length to [code]length[/code]. + Returns a new vector with all components clamped between the components of [code]min[/code] and [code]max[/code], by running [method @GlobalScope.clamp] on each component. </description> </method> <method name="cross" qualifiers="const"> @@ -232,6 +234,15 @@ Returns the result of the linear interpolation between this vector and [code]to[/code] by amount [code]weight[/code]. [code]weight[/code] is on the range of 0.0 to 1.0, representing the amount of interpolation. </description> </method> + <method name="limit_length" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="length" type="float" default="1.0"> + </argument> + <description> + Returns the vector with a maximum length by limiting its length to [code]length[/code]. + </description> + </method> <method name="move_toward" qualifiers="const"> <return type="Vector2"> </return> diff --git a/doc/classes/Vector2i.xml b/doc/classes/Vector2i.xml index b38b968ba3..6efb52b712 100644 --- a/doc/classes/Vector2i.xml +++ b/doc/classes/Vector2i.xml @@ -64,6 +64,17 @@ Returns the ratio of [member x] to [member y]. </description> </method> + <method name="clamp" qualifiers="const"> + <return type="Vector2i"> + </return> + <argument index="0" name="min" type="Vector2i"> + </argument> + <argument index="1" name="max" type="Vector2i"> + </argument> + <description> + Returns a new vector with all components clamped between the components of [code]min[/code] and [code]max[/code], by running [method @GlobalScope.clamp] on each component. + </description> + </method> <method name="operator !=" qualifiers="operator"> <return type="bool"> </return> diff --git a/doc/classes/Vector3.xml b/doc/classes/Vector3.xml index 0a86369506..170bd78067 100644 --- a/doc/classes/Vector3.xml +++ b/doc/classes/Vector3.xml @@ -87,6 +87,17 @@ Returns a new vector with all components rounded up (towards positive infinity). </description> </method> + <method name="clamp" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="min" type="Vector3"> + </argument> + <argument index="1" name="max" type="Vector3"> + </argument> + <description> + Returns a new vector with all components clamped between the components of [code]min[/code] and [code]max[/code], by running [method @GlobalScope.clamp] on each component. + </description> + </method> <method name="cross" qualifiers="const"> <return type="Vector3"> </return> @@ -207,6 +218,15 @@ Returns the result of the linear interpolation between this vector and [code]to[/code] by amount [code]weight[/code]. [code]weight[/code] is on the range of 0.0 to 1.0, representing the amount of interpolation. </description> </method> + <method name="limit_length" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="length" type="float" default="1.0"> + </argument> + <description> + Returns the vector with a maximum length by limiting its length to [code]length[/code]. + </description> + </method> <method name="max_axis" qualifiers="const"> <return type="int"> </return> diff --git a/doc/classes/Vector3i.xml b/doc/classes/Vector3i.xml index ea5945f5b7..6e8a34b692 100644 --- a/doc/classes/Vector3i.xml +++ b/doc/classes/Vector3i.xml @@ -58,6 +58,17 @@ <description> </description> </method> + <method name="clamp" qualifiers="const"> + <return type="Vector3i"> + </return> + <argument index="0" name="min" type="Vector3i"> + </argument> + <argument index="1" name="max" type="Vector3i"> + </argument> + <description> + Returns a new vector with all components clamped between the components of [code]min[/code] and [code]max[/code], by running [method @GlobalScope.clamp] on each component. + </description> + </method> <method name="max_axis" qualifiers="const"> <return type="int"> </return> |