getTerrainModifier: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Text replacement - "<source" to "<syntaxhighlight") |
||
| (4 intermediate revisions by 3 users not shown) | |||
| Line 4: | Line 4: | ||
|version=1.5.2 | |version=1.5.2 | ||
|description= | |description= | ||
Gets the Terrain Modifier for the named Token or for the Current Token if no name is given. | Gets the Terrain Modifier for the named Token or for the Current Token if no name is given. If the first parameter is {{code|"JSON"}} then a JSON Object is returned with the Terrain Modifier, Terrain Modifier Type and an array of Ignored Terrain Modifier Types. | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getTerrainModifier() | getTerrainModifier() | ||
getTerrainModifier(token) | getTerrainModifier(token) | ||
</ | getTerrainModifier(token, map) | ||
getTerrainModifier(type) | |||
getTerrainModifier(type, token) | |||
getTerrainModifier(type, token, map) | |||
</syntaxhighlight> | |||
'''Parameters''' | '''Parameters''' | ||
{{param|token|Optional token name.}} | {{param|token|Optional token name or return type.}} | ||
{{param|type|First parameter can be the string "JSON" to get a JSON Object back.}} | |||
{{param|map|Optional map name to find the token on. Current map is used if not supplied.}} | |||
|example= | |example= | ||
Get the Terrain Modifier for the named token: | Get the Terrain Modifier for the named token: | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[r: tmod = getTerrainModifier("Sticky Floor Tile")] | [r: tmod = getTerrainModifier("Sticky Floor Tile")] | ||
</ | </syntaxhighlight> | ||
'''Output:''' | '''Output:''' | ||
< | <syntaxhighlight lang="mtmacro"> | ||
2.0 | 2.0 | ||
</ | </syntaxhighlight> | ||
Get terrain modifiers as a JSON Object on the Wizard's Keep map. | |||
<syntaxhighlight lang="mtmacro" line> | |||
[r: tmod = getTerrainModifier("JSON", "Sticky Floor Tile", "Wizard's Keep")] | |||
</syntaxhighlight> | |||
'''Output:''' | |||
<syntaxhighlight lang="javascript"> | |||
{ | |||
"terrainModifier": 2.0, | |||
"terrainModifierOperation": "ADD", | |||
"terrainModifiersIgnored": ["NONE"] | |||
} | |||
</syntaxhighlight> | |||
Get terrain modifiers for the named token that ignores ADD & MULTIPLY mod types. | |||
<syntaxhighlight lang="mtmacro" line> | |||
[r: tmod = getTerrainModifier("Elf with Fancy Feet")] | |||
</syntaxhighlight> | |||
'''Output:''' | |||
<syntaxhighlight lang="javascript"> | |||
{ | |||
"terrainModifier": 0.0, | |||
"terrainModifierOperation": "NONE", | |||
"terrainModifiersIgnored": ["ADD","MULTIPLY"] | |||
} | |||
</syntaxhighlight> | |||
|also= | |also= | ||
{{func|setTerrainModifier}} | {{func|setTerrainModifier}} | ||
|changes= | |||
* '''1.5.11''' - Added support for new terrain modifier types. | |||
}} | }} | ||
[[Category:Token Function]] | [[Category:Token Function]] | ||
Latest revision as of 20:29, 14 March 2023
getTerrainModifier() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.5.2
Gets the Terrain Modifier for the named Token or for the Current Token if no name is given. If the first parameter is
"JSON" then a JSON Object is returned with the Terrain Modifier, Terrain Modifier Type and an array of Ignored Terrain Modifier Types.Usage
getTerrainModifier()
getTerrainModifier(token)
getTerrainModifier(token, map)
getTerrainModifier(type)
getTerrainModifier(type, token)
getTerrainModifier(type, token, map)Parameters
token- Optional token name or return type.type- First parameter can be the string "JSON" to get a JSON Object back.map- Optional map name to find the token on. Current map is used if not supplied.
Example
Get the Terrain Modifier for the named token:
[r: tmod = getTerrainModifier("Sticky Floor Tile")]Output:
2.0Get terrain modifiers as a JSON Object on the Wizard's Keep map.
[r: tmod = getTerrainModifier("JSON", "Sticky Floor Tile", "Wizard's Keep")]Output:
{
"terrainModifier": 2.0,
"terrainModifierOperation": "ADD",
"terrainModifiersIgnored": ["NONE"]
}
Get terrain modifiers for the named token that ignores ADD & MULTIPLY mod types.
[r: tmod = getTerrainModifier("Elf with Fancy Feet")]Output:
{
"terrainModifier": 0.0,
"terrainModifierOperation": "NONE",
"terrainModifiersIgnored": ["ADD","MULTIPLY"]
}
See Also
Version Changes
- 1.5.11 - Added support for new terrain modifier types.