getTerrainModifier

From RPTools Wiki
Jump to navigationJump to search

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.0

Get 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.