documented new script functions

git-svn-id: svn://svn.code.sf.net/p/magicseteditor/code/trunk@1015 0fc631ac-6414-0410-93d0-97cfa31319b6
This commit is contained in:
twanvl
2008-07-09 16:28:46 +00:00
parent bde65525ad
commit 9073764a62
12 changed files with 232 additions and 76 deletions
+21
View File
@@ -0,0 +1,21 @@
Function: random_shuffle
DOC_MSE_VERSION: since 0.3.7
--Usage--
> random_shuffle(some_list)
Randomly shuffle a list, putting the elements in a different order.
Since the result is random, calling the function twice will give a different answer.
--Parameters--
! Parameter Type Description
| @input@ [[type:list]] List to shuffle.
--Examples--
> random_shuffle([1,2,3,4]) == [4,1,2,3]
> random_shuffle([1,2,3,4]) == [2,3,4,1]
--See also--
| [[fun:random_select]] Pick random elements from a list.