From a60f242982d70e85a5b2c182eb3289b2fa7812e1 Mon Sep 17 00:00:00 2001
From: Aaron Franke <arnfranke@yahoo.com>
Date: Sat, 27 Oct 2018 16:12:27 -0400
Subject: Add integer posmod and rename default arg names

"posmod" is the integer version of "fposmod". We do not need a "mod" because of the % operator.

I changed the default arg names from "x" and "y" to "a" and "b" because they are not coordinates. I also changed pow's arg names to "base" and "exp". Also, I reorganized the code in the VS built-in funcs switch statement.
---
 modules/gdscript/doc_classes/@GDScript.xml | 71 ++++++++++++++++++++++--------
 1 file changed, 52 insertions(+), 19 deletions(-)

(limited to 'modules/gdscript/doc_classes')

diff --git a/modules/gdscript/doc_classes/@GDScript.xml b/modules/gdscript/doc_classes/@GDScript.xml
index 3870a5ea7d..a21b6a2907 100644
--- a/modules/gdscript/doc_classes/@GDScript.xml
+++ b/modules/gdscript/doc_classes/@GDScript.xml
@@ -345,45 +345,78 @@
 		<method name="fmod">
 			<return type="float">
 			</return>
-			<argument index="0" name="x" type="float">
+			<argument index="0" name="a" type="float">
 			</argument>
-			<argument index="1" name="y" type="float">
+			<argument index="1" name="b" type="float">
 			</argument>
 			<description>
-				Returns the floating-point remainder of [code]x/y[/code].
+				Returns the floating-point remainder of [code]a/b[/code], keeping the sign of [code]a[/code].
 				[codeblock]
 				# Remainder is 1.5
 				var remainder = fmod(7, 5.5)
 				[/codeblock]
+				For the integer remainder operation, use the % operator.
 			</description>
 		</method>
 		<method name="fposmod">
 			<return type="float">
 			</return>
-			<argument index="0" name="x" type="float">
+			<argument index="0" name="a" type="float">
 			</argument>
-			<argument index="1" name="y" type="float">
+			<argument index="1" name="b" type="float">
+			</argument>
+			<description>
+				Returns the floating-point modulus of [code]a/b[/code] that wraps equally in positive and negative.
+				[codeblock]
+				var i = -6
+				while i &lt; 5:
+				    prints(i, fposmod(i, 3))
+				    i += 1
+				[/codeblock]
+				Produces:
+				[codeblock]
+				-6 0
+				-5 1
+				-4 2
+				-3 0
+				-2 1
+				-1 2
+				0 0
+				1 1
+				2 2
+				3 0
+				4 1
+				[/codeblock]
+			</description>
+		</method>
+		<method name="posmod">
+			<return type="int">
+			</return>
+			<argument index="0" name="a" type="int">
+			</argument>
+			<argument index="1" name="b" type="int">
 			</argument>
 			<description>
-				Returns the floating-point remainder of [code]x/y[/code] that wraps equally in positive and negative.
+				Returns the integer modulus of [code]a/b[/code] that wraps equally in positive and negative.
 				[codeblock]
-				var i = -10
-				while i &lt; 0:
-				    prints(i, fposmod(i, 10))
+				var i = -6
+				while i &lt; 5:
+				    prints(i, posmod(i, 3))
 				    i += 1
 				[/codeblock]
 				Produces:
 				[codeblock]
-				-10 10
-				-9 1
-				-8 2
-				-7 3
-				-6 4
-				-5 5
-				-4 6
-				-3 7
-				-2 8
-				-1 9
+				-6 0
+				-5 1
+				-4 2
+				-3 0
+				-2 1
+				-1 2
+				0 0
+				1 1
+				2 2
+				3 0
+				4 1
 				[/codeblock]
 			</description>
 		</method>
-- 
cgit v1.2.3