arg: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) (Initial write-up.) |
No edit summary |
||
| Line 1: | Line 1: | ||
{{MacroFunction | {{MacroFunction | ||
|name=arg | |name=arg | ||
|version=1.3b51 | |version=1.3b51 | ||
|description= | |description= | ||
The {{code|arg()}} function is used to extract arguments that are passed to a macro when called as a user defined function. | |||
User functions are defined with the [[defineFunction|defineFunction()]] function. Once you have defined a function you can | |||
call it as you would call any of the existing functions, for example | |||
{{code| attackRoll(Strength, -1)}}. The {{code|arg()}} function is used within the macro that is called to extract each | |||
of these arguments. | |||
The [[argCount|{{code|argCount()}}]] function is often used in conjunction with {{code|arg()}} to determine the number | |||
of arguments that have been passed to the user defined function. | |||
|usage= | |usage= | ||
| Line 12: | Line 20: | ||
'''Parameters''' | '''Parameters''' | ||
* {{code|index}} - The index of the argument to return. Indexes begin at {{code|0}}. | * {{code|index}} - The index of the argument to return. Indexes begin at {{code|0}}. | ||
|example= | |||
Given a user defined function called {{code|attackRoll()}} which accepts two arguments, which are attribute value and | |||
bonus you could call it in the following way. | |||
<source lang="mtmacro" line> | |||
[attackRoll(12, -1)] | |||
</source> | |||
Then inside the macro that implements the user defined function you can do the following. | |||
<source lang="mtmacro" line> | |||
[h: attr = arg(0)] | |||
[h: bonus = arg(1)] | |||
[r: 1d20 + floor(attr/2) + bonus] | |||
</source> | |||
|also= | |also= | ||
Revision as of 10:28, 25 March 2009
arg() Function
• Introduced in version 1.3b51
The
arg() function is used to extract arguments that are passed to a macro when called as a user defined function.
User functions are defined with the defineFunction() function. Once you have defined a function you can
call it as you would call any of the existing functions, for example
attackRoll(Strength, -1). The arg() function is used within the macro that is called to extract each
of these arguments.
The argCount() function is often used in conjunction with arg() to determine the number
Usage
arg(index)Parameters
index- The index of the argument to return. Indexes begin at0.
Example
Given a user defined function called
attackRoll() which accepts two arguments, which are attribute value and
bonus you could call it in the following way.
[attackRoll(12, -1)]Then inside the macro that implements the user defined function you can do the following.
[h: attr = arg(0)]
[h: bonus = arg(1)]
[r: 1d20 + floor(attr/2) + bonus]