Files
MagicSetEditor2/doc/function/format.txt
T
twanvl 689def7325 Yet more function documentation
git-svn-id: svn://svn.code.sf.net/p/magicseteditor/code/trunk@571 0fc631ac-6414-0410-93d0-97cfa31319b6
2007-07-14 00:29:25 +00:00

24 lines
714 B
Plaintext

Function: format
--Usage--
> format(some_number, format: format_specification)
> format_rule(format: format_specification)(some_number)
Format a number or other string as a string, [[http://www.cplusplus.com/reference/clibrary/cstdio/printf.html|printf]] style.
This function is available in [[script:rule form]].
--Parameters--
! Parameter Type Description
| @input@ [[type:int]] or [[type:double]] or [[type:string]]
Item to format.
| @format@ [[type:string]] Format specification.
--Examples--
> format(format: "%03X", 13) == "00D"
> format(format: "%03d", 13) == "013"
> format(format: "%3s", "xy") == " xy"
>
> f := format_rule(format: "%03d")
> f(1) == "001"