getPenColor: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page GetPenColor to getPenColor: Converting page titles to lowercase)
m (Text replacement - "source>" to "syntaxhighlight>")
Line 9: Line 9:
<source lang="mtmacro" line>
<source lang="mtmacro" line>
getPenColor(mapName, drawingId)
getPenColor(mapName, drawingId)
</source>
</syntaxhighlight>
'''Parameters'''
'''Parameters'''
{{param|mapName|A string containing the name of the map.}}
{{param|mapName|A string containing the name of the map.}}
Line 16: Line 16:
<source lang="mtmacro" line>
<source lang="mtmacro" line>
[getPenColor("Grasslands", "0000000074836E675D00000000000000")]
[getPenColor("Grasslands", "0000000074836E675D00000000000000")]
</source>
</syntaxhighlight>
|also=
|also=
{{func|setPenColor}}
{{func|setPenColor}}
}}
}}
[[Category:Draw Function]]
[[Category:Draw Function]]

Revision as of 18:38, 14 March 2023

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

<source lang="mtmacro" line> getPenColor(mapName, drawingId) </syntaxhighlight> 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

<source lang="mtmacro" line>

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

</syntaxhighlight>

See Also