From 2cad7754617f3d7b434d1e9dd7e9ceb30e93d323 Mon Sep 17 00:00:00 2001 From: kobewi Date: Sun, 2 Jan 2022 18:32:49 +0100 Subject: Fix usage of "Return" in the docs --- .../doc_classes/VisualScriptBuiltinFunc.xml | 78 +++++++++++----------- .../doc_classes/VisualScriptCustomNode.xml | 34 +++++----- 2 files changed, 56 insertions(+), 56 deletions(-) (limited to 'modules/visual_script/doc_classes') diff --git a/modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml b/modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml index b3fd678379..1ac5768755 100644 --- a/modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml +++ b/modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml @@ -16,85 +16,85 @@ - Return the sine of the input. + Returns the sine of the input. - Return the cosine of the input. + Returns the cosine of the input. - Return the tangent of the input. + Returns the tangent of the input. - Return the hyperbolic sine of the input. + Returns the hyperbolic sine of the input. - Return the hyperbolic cosine of the input. + Returns the hyperbolic cosine of the input. - Return the hyperbolic tangent of the input. + Returns the hyperbolic tangent of the input. - Return the arc sine of the input. + Returns the arc sine of the input. - Return the arc cosine of the input. + Returns the arc cosine of the input. - Return the arc tangent of the input. + Returns the arc tangent of the input. - Return the arc tangent of the input, using the signs of both parameters to determine the exact angle. + Returns the arc tangent of the input, using the signs of both parameters to determine the exact angle. - Return the square root of the input. + Returns the square root of the input. - Return the remainder of one input divided by the other, using floating-point numbers. + Returns the remainder of one input divided by the other, using floating-point numbers. - Return the positive remainder of one input divided by the other, using floating-point numbers. + Returns the positive remainder of one input divided by the other, using floating-point numbers. - Return the input rounded down. + Returns the input rounded down. - Return the input rounded up. + Returns the input rounded up. - Return the input rounded to the nearest integer. + Returns the input rounded to the nearest integer. - Return the absolute value of the input. + Returns the absolute value of the input. - Return the sign of the input, turning it into 1, -1, or 0. Useful to determine if the input is positive or negative. + Returns the sign of the input, turning it into 1, -1, or 0. Useful to determine if the input is positive or negative. - Return the input raised to a given power. + Returns the input raised to a given power. - Return the natural logarithm of the input. Note that this is not the typical base-10 logarithm function calculators use. + Returns the natural logarithm of the input. Note that this is not the typical base-10 logarithm function calculators use. - Return the mathematical constant [b]e[/b] raised to the specified power of the input. [b]e[/b] has an approximate value of 2.71828. + Returns the mathematical constant [b]e[/b] raised to the specified power of the input. [b]e[/b] has an approximate value of 2.71828. - Return whether the input is NaN (Not a Number) or not. NaN is usually produced by dividing 0 by 0, though other ways exist. + Returns whether the input is NaN (Not a Number) or not. NaN is usually produced by dividing 0 by 0, though other ways exist. - Return whether the input is an infinite floating-point number or not. Infinity is usually produced by dividing a number by 0, though other ways exist. + Returns whether the input is an infinite floating-point number or not. Infinity is usually produced by dividing a number by 0, though other ways exist. Easing function, based on exponent. 0 is constant, 1 is linear, 0 to 1 is ease-in, 1+ is ease out. Negative values are in-out/out in. - Return the number of digit places after the decimal that the first non-zero digit occurs. + Returns the number of digit places after the decimal that the first non-zero digit occurs. - Return the input snapped to a given step. + Returns the input snapped to a given step. - Return a number linearly interpolated between the first two inputs, based on the third input. Uses the formula [code]a + (a - b) * t[/code]. + Returns a number linearly interpolated between the first two inputs, based on the third input. Uses the formula [code]a + (a - b) * t[/code]. @@ -107,16 +107,16 @@ Randomize the seed (or the internal state) of the random number generator. Current implementation reseeds using a number based on time. - Return a random 32 bits integer value. To obtain a random value between 0 to N (where N is smaller than 2^32 - 1), you can use it with the remainder function. + Returns a random 32 bits integer value. To obtain a random value between 0 to N (where N is smaller than 2^32 - 1), you can use it with the remainder function. - Return a random floating-point value between 0 and 1. To obtain a random value between 0 to N, you can use it with multiplication. + Returns a random floating-point value between 0 and 1. To obtain a random value between 0 to N, you can use it with multiplication. - Return a random 32-bit integer value between the two inputs. + Returns a random 32-bit integer value between the two inputs. - Return a random floating-point value between the two inputs. + Returns a random floating-point value between the two inputs. Returns a normally-distributed pseudo-random number, using Box-Muller transform with the specified mean and a standard deviation. This is also called Gaussian distribution. @@ -125,7 +125,7 @@ Set the seed for the random number generator. - Return a random value from the given seed, along with the new seed. + Returns a random value from the given seed, along with the new seed. Convert the input from degrees to radians. @@ -144,19 +144,19 @@ - Return the [code]value[/code] wrapped between [code]0[/code] and the [code]length[/code]. If the limit is reached, the next value the function returned is decreased to the [code]0[/code] side or increased to the [code]length[/code] side (like a triangle wave). If [code]length[/code] is less than zero, it becomes positive. + Returns the [code]value[/code] wrapped between [code]0[/code] and the [code]length[/code]. If the limit is reached, the next value the function returned is decreased to the [code]0[/code] side or increased to the [code]length[/code] side (like a triangle wave). If [code]length[/code] is less than zero, it becomes positive. - Return the greater of the two numbers, also known as their maximum. + Returns the greater of the two numbers, also known as their maximum. - Return the lesser of the two numbers, also known as their minimum. + Returns the lesser of the two numbers, also known as their minimum. - Return the input clamped inside the given range, ensuring the result is never outside it. Equivalent to [code]min(max(input, range_low), range_high)[/code]. + Returns the input clamped inside the given range, ensuring the result is never outside it. Equivalent to [code]min(max(input, range_low), range_high)[/code]. - Return the nearest power of 2 to the input. + Returns the nearest power of 2 to the input. Create a [WeakRef] from the input. @@ -165,13 +165,13 @@ Convert between types. - Return the type of the input as an integer. Check [enum Variant.Type] for the integers that might be returned. + Returns the type of the input as an integer. Check [enum Variant.Type] for the integers that might be returned. Checks if a type is registered in the [ClassDB]. - Return a character with the given ascii value. + Returns a character with the given ascii value. Convert the input to a string. @@ -200,7 +200,7 @@ Deserialize a [Variant] from a [PackedByteArray] serialized using [constant VAR_TO_BYTES]. - Return a number smoothly interpolated between the first two inputs, based on the third input. Similar to [constant MATH_LERP], but interpolates faster at the beginning and slower at the end. Using Hermite interpolation formula: + Returns a number smoothly interpolated between the first two inputs, based on the third input. Similar to [constant MATH_LERP], but interpolates faster at the beginning and slower at the end. Using Hermite interpolation formula: [codeblock] var t = clamp((weight - from) / (to - from), 0.0, 1.0) return t * t * (3.0 - 2.0 * t) diff --git a/modules/visual_script/doc_classes/VisualScriptCustomNode.xml b/modules/visual_script/doc_classes/VisualScriptCustomNode.xml index 2c6313c80a..486f60400a 100644 --- a/modules/visual_script/doc_classes/VisualScriptCustomNode.xml +++ b/modules/visual_script/doc_classes/VisualScriptCustomNode.xml @@ -12,112 +12,112 @@ - Return the node's title. + Returns the node's title. - Return the node's category. + Returns the node's category. - Return the count of input value ports. + Returns the count of input value ports. - Return the specified input port's hint. See the [enum @GlobalScope.PropertyHint] hints. + Returns the specified input port's hint. See the [enum @GlobalScope.PropertyHint] hints. - Return the specified input port's hint string. + Returns the specified input port's hint string. - Return the specified input port's name. + Returns the specified input port's name. - Return the specified input port's type. See the [enum Variant.Type] values. + Returns the specified input port's type. See the [enum Variant.Type] values. - Return the amount of output [b]sequence[/b] ports. + Returns the amount of output [b]sequence[/b] ports. - Return the specified [b]sequence[/b] output's name. + Returns the specified [b]sequence[/b] output's name. - Return the amount of output value ports. + Returns the amount of output value ports. - Return the specified output port's hint. See the [enum @GlobalScope.PropertyHint] hints. + Returns the specified output port's hint. See the [enum @GlobalScope.PropertyHint] hints. - Return the specified output port's hint string. + Returns the specified output port's hint string. - Return the specified output port's name. + Returns the specified output port's name. - Return the specified output port's type. See the [enum Variant.Type] values. + Returns the specified output port's type. See the [enum Variant.Type] values. - Return the custom node's text, which is shown right next to the input [b]sequence[/b] port (if there is none, on the place that is usually taken by it). + Returns the custom node's text, which is shown right next to the input [b]sequence[/b] port (if there is none, on the place that is usually taken by it). - Return the size of the custom node's working memory. See [method _step] for more details. + Returns the size of the custom node's working memory. See [method _step] for more details. - Return whether the custom node has an input [b]sequence[/b] port. + Returns whether the custom node has an input [b]sequence[/b] port. -- cgit v1.2.3