diff options
Diffstat (limited to 'doc/classes/Vector2.xml')
| -rw-r--r-- | doc/classes/Vector2.xml | 106 |
1 files changed, 53 insertions, 53 deletions
diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml index f99231de39..b979425b85 100644 --- a/doc/classes/Vector2.xml +++ b/doc/classes/Vector2.xml @@ -53,23 +53,23 @@ 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> Returns this vector's angle with respect to the positive X axis, or [code](1, 0)[/code] vector, in radians. For example, [code]Vector2.RIGHT.angle()[/code] will return zero, [code]Vector2.DOWN.angle()[/code] will return [code]PI / 2[/code] (a quarter turn, or 90 degrees), and [code]Vector2(1, -1).angle()[/code] will return [code]-PI / 4[/code] (a negative eighth turn, or -45 degrees). - Equivalent to the result of [method @GDScript.atan2] when called with the vector's [member y] and [member x] as parameters: [code]atan2(y, x)[/code]. + 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"> @@ -137,22 +137,22 @@ </argument> <argument index="2" name="post_b" type="Vector2"> </argument> - <argument index="3" name="t" type="float"> + <argument index="3" name="weight" type="float"> </argument> <description> - 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]t[/code]. [code]t[/code] is on the range of 0.0 to 1.0, representing the amount of interpolation. + 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"> </argument> <description> - Returns the normalized vector pointing from this vector to [code]b[/code]. + 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,37 +183,37 @@ [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"> </argument> <description> - Returns [code]true[/code] if this vector and [code]v[/code] are approximately equal, by running [method @GDScript.is_equal_approx] on each component. + 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,18 +221,18 @@ 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="with" type="Vector2"> + <argument index="0" name="to" type="Vector2"> </argument> - <argument index="1" name="t" type="float"> + <argument index="1" name="weight" type="float"> </argument> <description> 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,25 +390,32 @@ <description> </description> </method> - <method name="posmod"> + <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" qualifiers="const"> <return type="Vector2"> </return> <argument index="0" name="mod" type="float"> </argument> <description> - Returns a vector composed of the [method @GDScript.fposmod] of this vector's components and [code]mod[/code]. + 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"> </argument> <description> - Returns a vector composed of the [method @GDScript.fposmod] of this vector's components and [code]modv[/code]'s components. + 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"> @@ -417,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"> @@ -426,42 +433,42 @@ 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"> </argument> <description> - Returns the vector rotated by [code]phi[/code] radians. See also [method @GDScript.deg2rad]. + 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 @GDScript.sign] on each component. + 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="with" type="Vector2"> + <argument index="0" name="to" type="Vector2"> </argument> - <argument index="1" name="t" type="float"> + <argument index="1" name="weight" type="float"> </argument> <description> Returns the result of spherical 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. [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"> @@ -470,22 +477,15 @@ 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="by" type="Vector2"> + <argument index="0" name="step" type="Vector2"> </argument> <description> Returns this vector with each component snapped to the nearest multiple of [code]step[/code]. This can also be used to round to an arbitrary number of decimals. </description> </method> - <method name="tangent"> - <return type="Vector2"> - </return> - <description> - Returns a perpendicular vector rotated 90 degrees counter-clockwise compared to the original, with the same length. - </description> - </method> </methods> <members> <member name="x" type="float" setter="" getter="" default="0.0"> |