Files
twanvl ad48e2ae16 Documented 'length' function
git-svn-id: svn://svn.code.sf.net/p/magicseteditor/code/trunk@590 0fc631ac-6414-0410-93d0-97cfa31319b6
2007-08-01 18:45:58 +00:00

32 lines
1.2 KiB
Plaintext

Function: position
--Usage--
> position(of: some_item, in: some_list)
Returns the position of an item in a list.
The first position is @0@.
If the item is not found in the list, returns @-1@.
--Parameters--
! Parameter Type Description
| @of@ ''anything'' Item to look for.
| @in@ [[type:list]] or [[type:set]] List to look in.
Can be a [[type:set]] when looking for a card.
| @order_by@ [[type:function]] (optional) Find the position as if the list was [[fun:sort_list|sorted]] by this criterion.
Only when looking in a set.
| @filter@ [[type:function]] (optional) Find the position as if the list was [[fun:filter_list|filtered]] by this criterion.
Only when looking in a set.
--Examples--
> postion(of: "x", in: ["x", "y", "z"]) == 0
> postion(of: "z", in: ["x", "y", "z"]) == 2
> postion(of: "a", in: ["x", "y", "z"]) == -1
>
> # The position of the card in the list of red cards, ordered by name
> postion(of: card, in: set, order_by: {card.name}, filter:{card.color == "red"})
--See also--
| [[fun:length]] / [[fun:number_of_items]] Return the number of items in a list.
| [[fun:sort_list]] Sort a list.
| [[fun:filter_list]] Filter a list, keeping only elements that match a predicate.