From 7dfba3cda9f13427f9f10a6eefbec52aef62274c Mon Sep 17 00:00:00 2001 From: Rémi Verschelde Date: Fri, 24 Nov 2017 23:16:30 +0100 Subject: doc: Fix enum tags thanks to 2bc6db6 --- .../doc_classes/VisualScriptBuiltinFunc.xml | 128 ++++++++++----------- .../doc_classes/VisualScriptCustomNode.xml | 16 +-- .../doc_classes/VisualScriptFunctionCall.xml | 20 ++-- .../doc_classes/VisualScriptInputAction.xml | 8 +- .../doc_classes/VisualScriptMathConstant.xml | 18 +-- .../doc_classes/VisualScriptPropertyGet.xml | 6 +- .../doc_classes/VisualScriptPropertySet.xml | 30 ++--- .../doc_classes/VisualScriptYield.xml | 6 +- .../doc_classes/VisualScriptYieldSignal.xml | 6 +- 9 files changed, 119 insertions(+), 119 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 1a9dfc333..9f7d38e95 100644 --- a/modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml +++ b/modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml @@ -19,192 +19,192 @@ - + Return the sine of the input. - + Return the cosine of the input. - + Return the tangent of the input. - + Return the hyperbolic sine of the input. - + Return the hyperbolic cosine of the input. - + Return the hyperbolic tangent of the input. - + Return the arc sine of the input. - + Return the arc cosine of the input. - + Return the arc tangent of the input. - + Return the arc tangent of the input, using the signs of both parameters to determine the exact angle. - + Return the square root of the input. - + Return 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. - + Return the input rounded down. - + Return the input rounded up. - + Return the input rounded to the nearest integer. - + Return 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. - + Return 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. - + Return [b]e[/b] raised to the power of the input. [b]e[/b] sometimes called "Euler's number" is a mathematical constant whose value is approximately 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. - + 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. - + 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. - + Return 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]. - + - + - + Return the result of 'value' decreased by 'step' * 'amount'. - + 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. - + 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. - + Return a random floating-point value between the two inputs. - + Set the seed for the random number generator. - + Return a random value from the given seed, along with the new seed. - + Convert the input from degrees to radians. - + Convert the input from radians to degrees. - + Convert the input from linear volume to decibel volume. - + Convert the input from decibel volume to linear volume. - + Converts a 2D point expressed in the polar coordinate system (a distance from the origin [code]r[/code] and an angle [code]th[/code]) to the cartesian coordinate system (x and y axis). - + Converts a 2D point expressed in the cartesian coordinate system (x and y axis) to the polar coordinate system (a distance from the origin and an angle). - + - + - + Return the greater of the two numbers, also known as their maximum. - + Return 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 `min(max(input, range_low), range_high)` - + Return the nearest power of 2 to the input. - + Create a [WeakRef] from the input. - + Create a [FuncRef] from the input. - + Convert between types. - + Return 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. - + Convert the input to a string. - + Print the given string to the output window. - + Print the given string to the standard error output. - + Print the given string to the standard output, without adding a newline. - + Serialize a [Variant] to a string. - + Deserialize a [Variant] from a string serialized using [VAR_TO_STR]. - + Serialize a [Variant] to a [PoolByteArray]. - + Deserialize a [Variant] from a [PoolByteArray] serialized using [VAR_TO_BYTES]. - + Return the [Color] with the given name and alpha ranging from 0 to 1. Note: names are defined in color_names.inc. - + The maximum value the [member function] property can have. diff --git a/modules/visual_script/doc_classes/VisualScriptCustomNode.xml b/modules/visual_script/doc_classes/VisualScriptCustomNode.xml index 100f76bbb..c321c616a 100644 --- a/modules/visual_script/doc_classes/VisualScriptCustomNode.xml +++ b/modules/visual_script/doc_classes/VisualScriptCustomNode.xml @@ -136,28 +136,28 @@ - + The start mode used the first time when [method _step] is called. - + The start mode used when [method _step] is called after coming back from a STEP_PUSH_STACK_BIT. - + The start mode used when [method _step] is called after resuming from STEP_YIELD_BIT. - + Hint used by [method _step] to tell that control should return to it when there is no other node left to execute. This is used by [VisualScriptCondition] to redirect the sequence to the "Done" port after the true/false branch has finished execution. - + Hint used by [method _step] to tell that control should return back, either hitting a previous STEP_PUSH_STACK_BIT or exiting the function. - + - + Hint used by [method _step] to tell that control should stop and exit the function. - + Hint used by [method _step] to tell that the function should be yielded. Using this requires you to have at least one working memory slot, which is used for the [VisualScriptFunctionState]. diff --git a/modules/visual_script/doc_classes/VisualScriptFunctionCall.xml b/modules/visual_script/doc_classes/VisualScriptFunctionCall.xml index 4f1ddc78c..cc2360fc2 100644 --- a/modules/visual_script/doc_classes/VisualScriptFunctionCall.xml +++ b/modules/visual_script/doc_classes/VisualScriptFunctionCall.xml @@ -35,25 +35,25 @@ - + - + - + - + - + - + - + - + - + - + diff --git a/modules/visual_script/doc_classes/VisualScriptInputAction.xml b/modules/visual_script/doc_classes/VisualScriptInputAction.xml index 08297ed2e..afe72ba56 100644 --- a/modules/visual_script/doc_classes/VisualScriptInputAction.xml +++ b/modules/visual_script/doc_classes/VisualScriptInputAction.xml @@ -17,13 +17,13 @@ - + - + - + - + diff --git a/modules/visual_script/doc_classes/VisualScriptMathConstant.xml b/modules/visual_script/doc_classes/VisualScriptMathConstant.xml index 8ebea37ff..2cb053ee5 100644 --- a/modules/visual_script/doc_classes/VisualScriptMathConstant.xml +++ b/modules/visual_script/doc_classes/VisualScriptMathConstant.xml @@ -22,31 +22,31 @@ - + Unity: [code]1[/code] - + Pi: [code]3.141593[/code] - + Pi divided by two: [code]1.570796[/code] - + Tau: [code]6.283185[/code] - + Natural log: [code]2.718282[/code] - + Square root of two: [code]1.414214[/code] - + Infinity: [code]inf[/code] - + Not a number: [code]nan[/code] - + diff --git a/modules/visual_script/doc_classes/VisualScriptPropertyGet.xml b/modules/visual_script/doc_classes/VisualScriptPropertyGet.xml index b2a51b80b..f68f0edee 100644 --- a/modules/visual_script/doc_classes/VisualScriptPropertyGet.xml +++ b/modules/visual_script/doc_classes/VisualScriptPropertyGet.xml @@ -29,11 +29,11 @@ - + - + - + diff --git a/modules/visual_script/doc_classes/VisualScriptPropertySet.xml b/modules/visual_script/doc_classes/VisualScriptPropertySet.xml index ac91b23dd..d4305af57 100644 --- a/modules/visual_script/doc_classes/VisualScriptPropertySet.xml +++ b/modules/visual_script/doc_classes/VisualScriptPropertySet.xml @@ -31,35 +31,35 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/modules/visual_script/doc_classes/VisualScriptYield.xml b/modules/visual_script/doc_classes/VisualScriptYield.xml index 26d865f06..b42fc027c 100644 --- a/modules/visual_script/doc_classes/VisualScriptYield.xml +++ b/modules/visual_script/doc_classes/VisualScriptYield.xml @@ -17,11 +17,11 @@ - + - + - + diff --git a/modules/visual_script/doc_classes/VisualScriptYieldSignal.xml b/modules/visual_script/doc_classes/VisualScriptYieldSignal.xml index 46cdf9dbc..f69043a68 100644 --- a/modules/visual_script/doc_classes/VisualScriptYieldSignal.xml +++ b/modules/visual_script/doc_classes/VisualScriptYieldSignal.xml @@ -21,11 +21,11 @@ - + - + - + -- cgit v1.3.1