setTokenHandout

From RPTools Wiki
(Redirected from SetTokenHandout)
Jump to navigation Jump to search

setTokenHandout() Function

• Introduced in version 1.3b77
Sets the handout image for the for the Current Token. The image can come from several sources. It can be an Asset ID (like from tblImage() orgetTokenImage().) or a Image Token.

Usage

setTokenHandout(assetId)
setTokenHandout(assetId, id)
setTokenHandout(assetId, id, mapname)
setTokenHandout(tokenImageName)
setTokenHandout(tokenImageName, id)
setTokenHandout(tokenImageName, id, mapname)

Parameters

  • id - OPTIONAL: The token id of the token for which you want to set the handout, defaults to the Current Token.
  • mapname - OPTIONAL: The name of the map to find the token. Defaults to the current map.


Version Changes

  • 1.5.4 - Added id and mapname parameter options.
Retrieved from "https://wiki.rptools.info/index.php?title=setTokenHandout&oldid=16737"