getStateImage: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Copied example over from previous article that was overlooked due to being orphaned.)
mNo edit summary
Line 4: Line 4:
|version=1.3b40
|version=1.3b40
|description=
|description=
Gets the image for a state, the state must be one of the image types for this to work.
Gets the [[Asset ID|asset id]] for the image of a state, the state must be one of the image types for this to work.


|usage=
|usage=

Revision as of 14:08, 25 March 2009

 This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.

getStateImage() Function

Introduced in version 1.3b40
Gets the asset id for the image of a state, the state must be one of the image types for this to work.

Usage

getStateImage(state)
getStateImage(state, size)

Parameters

  • state - The name of the state which has its image asset returned.
  • size - The size that the state image will be resized to; this is the height of the final size.

Example

To display the image for the "Dead" token state use.
<img src='[r:getStateImage("Dead")]'></img>