mirror of
https://github.com/godotengine/godot.git
synced 2026-01-06 10:11:57 +03:00
doc: Sync classref with current source
And move GLTF docs to its module folder.
This commit is contained in:
Rémi Verschelde
@@ -53,14 +53,14 @@
|
||||
Constructs a new [Vector2] from the given [code]x[/code] and [code]y[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="abs">
|
||||
<method name="abs" qualifiers="const">
|
||||
<return type="Vector2">
|
||||
</return>
|
||||
<description>
|
||||
Returns a new vector with all components in absolute values (i.e. positive).
|
||||
</description>
|
||||
</method>
|
||||
<method name="angle">
|
||||
<method name="angle" qualifiers="const">
|
||||
<return type="float">
|
||||
</return>
|
||||
<description>
|
||||
@@ -69,7 +69,7 @@
|
||||
Equivalent to the result of [method @GlobalScope.atan2] when called with the vector's [member y] and [member x] as parameters: [code]atan2(y, x)[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="angle_to">
|
||||
<method name="angle_to" qualifiers="const">
|
||||
<return type="float">
|
||||
</return>
|
||||
<argument index="0" name="to" type="Vector2">
|
||||
@@ -78,7 +78,7 @@
|
||||
Returns the angle to the given vector, in radians.
|
||||
</description>
|
||||
</method>
|
||||
<method name="angle_to_point">
|
||||
<method name="angle_to_point" qualifiers="const">
|
||||
<return type="float">
|
||||
</return>
|
||||
<argument index="0" name="to" type="Vector2">
|
||||
@@ -87,14 +87,14 @@
|
||||
Returns the angle between the line connecting the two points and the X axis, in radians.
|
||||
</description>
|
||||
</method>
|
||||
<method name="aspect">
|
||||
<method name="aspect" qualifiers="const">
|
||||
<return type="float">
|
||||
</return>
|
||||
<description>
|
||||
Returns the aspect ratio of this vector, the ratio of [member x] to [member y].
|
||||
</description>
|
||||
</method>
|
||||
<method name="bounce">
|
||||
<method name="bounce" qualifiers="const">
|
||||
<return type="Vector2">
|
||||
</return>
|
||||
<argument index="0" name="n" type="Vector2">
|
||||
@@ -103,14 +103,14 @@
|
||||
Returns the vector "bounced off" from a plane defined by the given normal.
|
||||
</description>
|
||||
</method>
|
||||
<method name="ceil">
|
||||
<method name="ceil" qualifiers="const">
|
||||
<return type="Vector2">
|
||||
</return>
|
||||
<description>
|
||||
Returns the vector with all components rounded up (towards positive infinity).
|
||||
</description>
|
||||
</method>
|
||||
<method name="clamped">
|
||||
<method name="clamped" qualifiers="const">
|
||||
<return type="Vector2">
|
||||
</return>
|
||||
<argument index="0" name="length" type="float">
|
||||
@@ -119,7 +119,7 @@
|
||||
Returns the vector with a maximum length by limiting its length to [code]length[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="cross">
|
||||
<method name="cross" qualifiers="const">
|
||||
<return type="float">
|
||||
</return>
|
||||
<argument index="0" name="with" type="Vector2">
|
||||
@@ -128,7 +128,7 @@
|
||||
Returns the cross product of this vector and [code]with[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="cubic_interpolate">
|
||||
<method name="cubic_interpolate" qualifiers="const">
|
||||
<return type="Vector2">
|
||||
</return>
|
||||
<argument index="0" name="b" type="Vector2">
|
||||
@@ -143,7 +143,7 @@
|
||||
Cubically interpolates between this vector and [code]b[/code] using [code]pre_a[/code] and [code]post_b[/code] as handles, and returns the result at position [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="direction_to">
|
||||
<method name="direction_to" qualifiers="const">
|
||||
<return type="Vector2">
|
||||
</return>
|
||||
<argument index="0" name="b" type="Vector2">
|
||||
@@ -152,7 +152,7 @@
|
||||
Returns the normalized vector pointing from this vector to [code]b[/code]. This is equivalent to using [code](b - a).normalized()[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="distance_squared_to">
|
||||
<method name="distance_squared_to" qualifiers="const">
|
||||
<return type="float">
|
||||
</return>
|
||||
<argument index="0" name="to" type="Vector2">
|
||||
@@ -162,7 +162,7 @@
|
||||
This method runs faster than [method distance_to], so prefer it if you need to compare vectors or need the squared distance for some formula.
|
||||
</description>
|
||||
</method>
|
||||
<method name="distance_to">
|
||||
<method name="distance_to" qualifiers="const">
|
||||
<return type="float">
|
||||
</return>
|
||||
<argument index="0" name="to" type="Vector2">
|
||||
@@ -171,7 +171,7 @@
|
||||
Returns the distance between this vector and [code]to[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="dot">
|
||||
<method name="dot" qualifiers="const">
|
||||
<return type="float">
|
||||
</return>
|
||||
<argument index="0" name="with" type="Vector2">
|
||||
@@ -183,14 +183,14 @@
|
||||
[b]Note:[/b] [code]a.dot(b)[/code] is equivalent to [code]b.dot(a)[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="floor">
|
||||
<method name="floor" qualifiers="const">
|
||||
<return type="Vector2">
|
||||
</return>
|
||||
<description>
|
||||
Returns the vector with all components rounded down (towards negative infinity).
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_equal_approx">
|
||||
<method name="is_equal_approx" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<argument index="0" name="to" type="Vector2">
|
||||
@@ -199,21 +199,21 @@
|
||||
Returns [code]true[/code] if this vector and [code]v[/code] are approximately equal, by running [method @GlobalScope.is_equal_approx] on each component.
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_normalized">
|
||||
<method name="is_normalized" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<description>
|
||||
Returns [code]true[/code] if the vector is normalized, [code]false[/code] otherwise.
|
||||
</description>
|
||||
</method>
|
||||
<method name="length">
|
||||
<method name="length" qualifiers="const">
|
||||
<return type="float">
|
||||
</return>
|
||||
<description>
|
||||
Returns the length (magnitude) of this vector.
|
||||
</description>
|
||||
</method>
|
||||
<method name="length_squared">
|
||||
<method name="length_squared" qualifiers="const">
|
||||
<return type="float">
|
||||
</return>
|
||||
<description>
|
||||
@@ -221,7 +221,7 @@
|
||||
This method runs faster than [method length], so prefer it if you need to compare vectors or need the squared distance for some formula.
|
||||
</description>
|
||||
</method>
|
||||
<method name="lerp">
|
||||
<method name="lerp" qualifiers="const">
|
||||
<return type="Vector2">
|
||||
</return>
|
||||
<argument index="0" name="to" type="Vector2">
|
||||
@@ -232,7 +232,7 @@
|
||||
Returns the result of the linear interpolation between this vector and [code]b[/code] by amount [code]t[/code]. [code]t[/code] is on the range of 0.0 to 1.0, representing the amount of interpolation.
|
||||
</description>
|
||||
</method>
|
||||
<method name="move_toward">
|
||||
<method name="move_toward" qualifiers="const">
|
||||
<return type="Vector2">
|
||||
</return>
|
||||
<argument index="0" name="to" type="Vector2">
|
||||
@@ -243,7 +243,7 @@
|
||||
Moves the vector toward [code]to[/code] by the fixed [code]delta[/code] amount.
|
||||
</description>
|
||||
</method>
|
||||
<method name="normalized">
|
||||
<method name="normalized" qualifiers="const">
|
||||
<return type="Vector2">
|
||||
</return>
|
||||
<description>
|
||||
@@ -390,14 +390,14 @@
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="orthogonal">
|
||||
<method name="orthogonal" qualifiers="const">
|
||||
<return type="Vector2">
|
||||
</return>
|
||||
<description>
|
||||
Returns a perpendicular vector rotated 90 degrees counter-clockwise compared to the original, with the same length.
|
||||
</description>
|
||||
</method>
|
||||
<method name="posmod">
|
||||
<method name="posmod" qualifiers="const">
|
||||
<return type="Vector2">
|
||||
</return>
|
||||
<argument index="0" name="mod" type="float">
|
||||
@@ -406,7 +406,7 @@
|
||||
Returns a vector composed of the [method @GlobalScope.fposmod] of this vector's components and [code]mod[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="posmodv">
|
||||
<method name="posmodv" qualifiers="const">
|
||||
<return type="Vector2">
|
||||
</return>
|
||||
<argument index="0" name="modv" type="Vector2">
|
||||
@@ -415,7 +415,7 @@
|
||||
Returns a vector composed of the [method @GlobalScope.fposmod] of this vector's components and [code]modv[/code]'s components.
|
||||
</description>
|
||||
</method>
|
||||
<method name="project">
|
||||
<method name="project" qualifiers="const">
|
||||
<return type="Vector2">
|
||||
</return>
|
||||
<argument index="0" name="b" type="Vector2">
|
||||
@@ -424,7 +424,7 @@
|
||||
Returns the vector projected onto the vector [code]b[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="reflect">
|
||||
<method name="reflect" qualifiers="const">
|
||||
<return type="Vector2">
|
||||
</return>
|
||||
<argument index="0" name="n" type="Vector2">
|
||||
@@ -433,7 +433,7 @@
|
||||
Returns the vector reflected from a plane defined by the given normal.
|
||||
</description>
|
||||
</method>
|
||||
<method name="rotated">
|
||||
<method name="rotated" qualifiers="const">
|
||||
<return type="Vector2">
|
||||
</return>
|
||||
<argument index="0" name="phi" type="float">
|
||||
@@ -442,21 +442,21 @@
|
||||
Returns the vector rotated by [code]phi[/code] radians. See also [method @GlobalScope.deg2rad].
|
||||
</description>
|
||||
</method>
|
||||
<method name="round">
|
||||
<method name="round" qualifiers="const">
|
||||
<return type="Vector2">
|
||||
</return>
|
||||
<description>
|
||||
Returns the vector with all components rounded to the nearest integer, with halfway cases rounded away from zero.
|
||||
</description>
|
||||
</method>
|
||||
<method name="sign">
|
||||
<method name="sign" qualifiers="const">
|
||||
<return type="Vector2">
|
||||
</return>
|
||||
<description>
|
||||
Returns the vector with each component set to one or negative one, depending on the signs of the components, or zero if the component is zero, by calling [method @GlobalScope.sign] on each component.
|
||||
</description>
|
||||
</method>
|
||||
<method name="slerp">
|
||||
<method name="slerp" qualifiers="const">
|
||||
<return type="Vector2">
|
||||
</return>
|
||||
<argument index="0" name="to" type="Vector2">
|
||||
@@ -468,7 +468,7 @@
|
||||
[b]Note:[/b] Both vectors must be normalized.
|
||||
</description>
|
||||
</method>
|
||||
<method name="slide">
|
||||
<method name="slide" qualifiers="const">
|
||||
<return type="Vector2">
|
||||
</return>
|
||||
<argument index="0" name="n" type="Vector2">
|
||||
@@ -477,7 +477,7 @@
|
||||
Returns this vector slid along a plane defined by the given normal.
|
||||
</description>
|
||||
</method>
|
||||
<method name="snapped">
|
||||
<method name="snapped" qualifiers="const">
|
||||
<return type="Vector2">
|
||||
</return>
|
||||
<argument index="0" name="step" type="Vector2">
|
||||
|
||||
Reference in New Issue
Block a user