getPenColor

From RPTools Wiki
Revision as of 20:20, 14 March 2023 by Taustin (talk | contribs) (Text replacement - "<source" to "<syntaxhighlight")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

getPenColor() Function

 Note: This function can only be used in a Trusted Macro

Introduced in version 1.5.0
Returns a string representing the colour or texture of the pen for a specified drawing. A colour will be returned in the hex format (i.e. "#000000" for black) while a texture will be returned as the asset url (i.e. "asset://ffff0fe019c241c7456b0ec0b347ef37")

Usage

getPenColor(mapName, drawingId)

Parameters

  • mapName - A string containing the name of the map.
  • drawingId - A string containing the id of the drawing. The easiest way to discover a drawing's Id is via the Draw Explorer interface.

Examples

[getPenColor("Grasslands", "0000000074836E675D00000000000000")]

See Also