setTokenImage

From RPTools Wiki
Jump to navigationJump to search

setTokenImage() Function

Introduced in version 1.3b48
Sets the image for the for the Current Token. The function accepts an Asset ID or an Image Token name. You can get Asset IDs from macro functions such as tblImage() or getTokenImage(). Image Tokens are special tokens whose name starts with "image:".

Usage

setTokenImage(assetId)
setTokenImage(assetId, id)
setTokenImage(assetId, id, mapname)
setTokenImage(imageToken)
setTokenImage(imageToken, id)
setTokenImage(imageToken, id, mapname)

Parameters

  • assetId - The Asset ID for an image.
  • imageToken - The name of an image token e.g. "image:myimage"
  • id - OPTIONAL: The token id of the token for which you want to set the image, defaults to the Current Token.
  • mapname - OPTIONAL: The name of the map to find the token. Defaults to the current map.

Example

[h: setTokenImage(tblImage("elfImages", 1))]
[h: setTokenImage("image:Elf-Dead")]


Version Changes

  • 1.5.4 - Added id and mapname parameter options.