getFillColor: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Created page with "{{MacroFunction |name=getFillColor |version=1.4.1.9 |trusted=true |description= Returns a string representing the colour or texture of the pen for a specified drawing. A colou...")
 
m (Text replacement - "<source" to "<syntaxhighlight")
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{MacroFunction
{{MacroFunction
|name=getFillColor
|name=getFillColor
|version=1.4.1.9
|version=1.5.0
|trusted=true
|trusted=true
|description=
|description=
Line 7: Line 7:
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")
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=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getFillColor(mapName, drawingId)
getFillColor(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.}}
{{param|drawingId|A string containing the id of the drawing. The easiest way to discover a drawing's Id is via the Draw Explorer interface.}}
{{param|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=
|examples=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[r:getFillColor("Grasslands", "0000000074836E675D00000000000000")]
[r:getFillColor("Grasslands", "0000000074836E675D00000000000000")]
</source>
</syntaxhighlight>
|also=
|also=
{{func|setFillColor}}
{{func|setFillColor}}
}}
}}
[[Category:Draw Function]]
[[Category:Draw Function]]

Latest revision as of 17:54, 14 March 2023

getFillColor() 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

getFillColor(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

[r:getFillColor("Grasslands", "0000000074836E675D00000000000000")]

See Also