Upstream/dynmap
1
0
Fork 0
mirror of https://github.com/webbukkit/dynmap.git synced 2024-11-24 11:15:21 +01:00
Code Issues Projects Releases Wiki Activity

Updated Using markers (markdown)

mikeprimm 2015-07-14 09:33:37 -05:00
parent 8b08542919
commit bc500fe417
1 changed files with 36 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
Using-markers.md

@ -86,6 +86,42 @@ To delete an area marker, use the `/dmarker deletearea id:<area-id> set:<markers
Existing areas, and their attributes, can be shown using the `/dmarker listareas set:<markerset-id>` command.
### Circle Markers
Circle markers are used to place 2-D circular (or elliptical) outlines on the world maps. The area defined by a circle marker is defined by a center point (x, y, z) and either a radius (for a circle, via radius setting) or an X vs Z radius (for an ellipse, via radiusx and radiusz setting).
The appearance of the edges of the outline can be controlled by setting the color attribute (#RRGGBB), line weight (0-N), and opacity (0.0-1.0). The appearance of the filled area within the outlines can be controled by setting the fill color attribute (#RRGGBB), and fill opacity (0.0-1.0).
A circle marker can be created using the `/dmarker addcircle <circle-label> set:<markerset-id>` or `/dmarker addcircle id:<circle-id> <circle-label> set:<markerset-id>` commands. Additional attributes can be set with these commands, or later updated using the `/dmarker updatecircle id:<circle-id> set:<markerset-id>` or `/dmarker updatecircle <circle-label> set:<markerset-id>` command. These settings include:
* `x` - X coordinate of center (default is current location of player issuing command)
* `y` - Y coordinate of center (default is current location of player issuing command)
* `z` - Z coordinate of center (default is current location of player issuing command)
* `radius` - radius of circle (default is 1)
* 'radiusx' - radius of ellipse on X axis (default is 1)
* 'radiusz' - radius of ellipse on Z axis (default is 1)
* `world` - world of center (default is current location of player issuing command)
* `color` - outline color (#RRGGBB format)
* `fillcolor` - fill color (within the outlines) (#RRGGBB format)
* 'opacity` - Opacity of the outline strokes (0.0 = transparent, 1.0 = solid)
* 'fillopacity` - Opacity of the filled color areas (0.0 = transparent, 1.0 = solid)
* `weight` - Stroke weight of outline (0=minimum, higher=thicker)
To delete a circle marker, use the `/dmarker deletecircle id:<circle-id> set:<markerset-id>` command.
Existing circles, and their attributes, can be shown using the `/dmarker listcircles set:<markerset-id>` command.
### Poly-Line Markers
Poly-line markers are used to place a sequence of connected line segments on the world maps. Each poly-line marker is defined by a sequence of 1 or more X,Y,Z coordinates, along with a label, an optional description popup, and associated line color, weight, and opacity settings.