refreshDrawing: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 4: Line 4:
|trusted=true
|trusted=true
|description=
|description=
The function causes the specified drawing to be updated on all of the clients connected to the server. If this function is not invoked for each drawing updated by via script, then the client maps will get out of sync.
Causes the specified drawing to be updated on all of the clients connected to the server. If this function is not invoked for each drawing updated by via script, then the client maps will get out of sync.
|usage=
|usage=
<source lang="mtmacro" line>
<source lang="mtmacro" line>
Line 11: Line 11:
'''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 ids is via the '''Draw Explorer''' interface.}}
|example=
|example=
<source lang="mtmacro" line>
<source lang="mtmacro" line>

Revision as of 04:40, 7 March 2019

refreshDrawing() Function

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

Introduced in version 1.5.0
Causes the specified drawing to be updated on all of the clients connected to the server. If this function is not invoked for each drawing updated by via script, then the client maps will get out of sync.

Usage

refreshDrawing(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 ids is via the Draw Explorer interface.

Example

[h:setFillColor("Grasslands", "00000000CCF6B567CC00000000000000","blue")]
[h:refreshDrawing("Grasslands", "00000000CCF6B567CC00000000000000")]

See Also