Difference between revisions of "Osiris/API/Random"

From Divinity Engine Wiki
Jump to: navigation, search
(Created page with "===== Full Definition(s) ===== * query '''Random'''('''''[in]'''(INTEGER)'''''_Modulo''',''''' [out]'''(INTEGER)'''''_Random''') ===== Description ===== Returns a random integ...")
 
m
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
 
===== Full Definition(s) =====
 
===== Full Definition(s) =====
* query '''Random'''('''''[in]'''(INTEGER)'''''_Modulo''',''''' [out]'''(INTEGER)'''''_Random''')
+
* query '''Random'''('''''[in]'''(INTEGER)'''''_Modulo''', '''''[out]'''(INTEGER)'''''_Random''')
 
===== Description =====
 
===== Description =====
 
Returns a random integer value between 0 and ('''_Modulo''' - 1).
 
Returns a random integer value between 0 and ('''_Modulo''' - 1).
 +
For a negative '''_Modulo''', the result will be between '''_Modulo''' and 0.
 
===== Return Values =====
 
===== Return Values =====
 
* '''Success/Failure''': Never fails.
 
* '''Success/Failure''': Never fails.
 
* '''_Random''': A random number.
 
* '''_Random''': A random number.
 
===== Notes =====
 
===== Notes =====
For a negative '''_Modulo''', the result will be between ('''_Modulo''' + 1) and 0.
+
* /
 
===== See Also =====
 
===== See Also =====
-
+
* /
 
    
 
    
[[Category:Osiris Queries]]
+
[[Category:Osiris Queries|Random]]

Latest revision as of 15:40, 19 December 2017

Full Definition(s)
  • query Random([in](INTEGER)_Modulo, [out](INTEGER)_Random)
Description

Returns a random integer value between 0 and (_Modulo - 1). For a negative _Modulo, the result will be between _Modulo and 0.

Return Values
  • Success/Failure: Never fails.
  • _Random: A random number.
Notes
  • /
See Also
  • /