mirror of
https://github.com/amyinspace/MagicSetEditor2.git
synced 2026-06-10 04:57:00 -04:00
twanvl
f510a35647
git-svn-id: svn://svn.code.sf.net/p/magicseteditor/code/trunk@1173 0fc631ac-6414-0410-93d0-97cfa31319b6
23 lines
730 B
Plaintext
23 lines
730 B
Plaintext
Function: random_boolean
|
|
|
|
DOC_MSE_VERSION: since 0.3.8
|
|
|
|
--Usage--
|
|
> random_boolean(probability)
|
|
|
|
Returns a random [[type:bool]], either @true@ or @false@.
|
|
The parameter is the probability of returning @true@, so @random_boolean(0.0)@ always returns @true@, @random_boolean(1.0)@ always returns @false@ and @random_boolean(0.5)@ simulates a fair coin toss.
|
|
|
|
Since the result is random, calling the function twice will give a different answer.
|
|
|
|
--Parameters--
|
|
! Parameter Type Default Description
|
|
| @input@ [[type:double]] @0.5@ Probability of returining true
|
|
|
|
--Examples--
|
|
> random_boolean(0.5) == true
|
|
> random_boolean(0.5) == false
|
|
|
|
--See also--
|
|
| [[fun:random_real]] Generate a random [[type:double]].
|