Differences

This shows you the differences between two versions of the page.

--- crpl:docs:randint [2015/03/19 17:24] – added example warren
+++ crpl:docs:randint [2020/05/28 05:42] (current) – WithersChat
@@ Line 3: / Line 3: @@
 ^Arguments^Result^Notation^
-|Min, Max|Random Integer |''n1 n2 -- n2 ''|
+|A, B|Random Integer |''n1 n2 -- n3 ''|
 === Description ===
-Pops Min and Max from the stack and pushes a random integer to stack where min %%<=%% RandInt < max.
+//Pops A and B from the stack and pushes a random integer to the stack that can be any value from A up to, but not including, B.//
+**In the case that ''A < B'':**
+Pops A and B from the stack and pushes a random integer to stack where ''A <= RandInt < B''. In this case A and B may be treated as Min and Max similar to how many other languages treat random functions. For consistent results it is best to make sure that your input is always structured like this.
+**In the case that ''A > B'':**
+Pops A and B from the stack and pushes a random integer to stack where ''B < RandInt <= A''.
+**In the case that ''A == B'':**
+Pops A and B from the stack and pushes back a single integer equal to A and B. Example: ''RandInt(1, 1)'' will always return 1.
 === Examples ===
 <code>
 #Creates a dancing number readout. Very high tech hackery.
 10 RandInt
 10 RandInt concat
 10 RandInt concat
 10 RandInt concat
-    SetPopupText
+SetPopupText
 :awake
   TRUE OperateWhilePaused
+</code>
+<code>
+# Showcases the difference between passing (Low, High) or (High, Low) into the function.
+once
+    ClearTraceLog
+    ShowTraceLog
+0 do
+        #        A    B                      results         logic
+        "lohi " -2    2   RandInt " "     #  -2 -1 0 1       A <= RandInt < B
+        "hilo "  2   -2   RandInt Trace5  #     -1 0 1 2     B < RandInt <= A
+    loop
+endonce
 </code>

Knuckle Cracker Wiki

User Tools

Site Tools

Differences

Page Tools