More function documentation

git-svn-id: svn://svn.code.sf.net/p/magicseteditor/code/trunk@568 0fc631ac-6414-0410-93d0-97cfa31319b6
This commit is contained in:
twanvl
2007-07-13 20:03:43 +00:00
parent 700a941125
commit 32c1b5f4d1
13 changed files with 234 additions and 16 deletions
+22
View File
@@ -0,0 +1,22 @@
Function: number_of_items
--Usage--
> number_of_items(in: some_collection)
Returns the position of an item in a list or characters in a string.
--Parameters--
| @in@ [[type:list]] or [[type:map]] or [[type:set]] or [[type:string]]
Object to determine the number of items of.
When it is a set, returns the number of cards.
When it is a string, returns the number of characters.
| @filter@ [[type:function]] (optional) Act as if the list was [[fun:filter_list|filtered]] by this criterion.
Only when @in@ is a set.
--Examples--
> number_of_items(in: ["x", "y", "z"]) == 3
> number_of_items(in: "pink") == 4
> number_of_items(in: set) == # number of cards in the set
>
> # the number of red cards in the set
> number_of_items(in: set, filter: { card.color == "red" } )