changed _ variable names (_name_) to <name>, <> are more generally expected to be placeholders

JurgenKuyper 2021-11-11 21:48:58 +01:00
parent f37ef82658
commit 1d3bba8588
1 changed files with 21 additions and 21 deletions

@ -4,45 +4,45 @@ To start, the /dmap editing commands (all the commands besides the /dmap worldli
Once rendering is paused, the /dmap commands can be used to add, remove, reorder, or modify existing map definitions. The order and many of the settings for the list of worlds can also be controlled. The following are a sample of the sorts of actions that can be done:
* To disable/hide a world: `/dmap worldset _worldname_ enabled:false`
* To disable/hide a world: `/dmap worldset <worldname> enabled:false`
* To reset a world's settings and maps to its default template: `/dmap worldreset _worldname_`
* To reset a world's settings and maps to its default template: `/dmap worldreset <worldname>`
* To reset a world's settings and maps to a specific template (replacing all existing maps): `/dmap worldreset _worldname_ _templatename_`
* To reset a world's settings and maps to a specific template (replacing all existing maps): `/dmap worldreset <worldname> <templatename>`
* To make a world first in the list of worlds: `/dmap worldset _worldname_ order:1`
* To make a world first in the list of worlds: `/dmap worldset <worldname> order:1`
* To set the title of a world: `/dmap worldset _worldname_ title:_"title string"_`
* To set the title of a world: `/dmap worldset <worldname> title:<"title string">`
* To hide the reporting of player positions and health on a world: `/dmap worldset _worldname_ sendposition:false sendhealth:false`
* To hide the reporting of player positions and health on a world: `/dmap worldset <worldname> sendposition:false sendhealth:false`
* To set the default center position of a world to the player's current location: `/dmap worldset _worldname_ center:here`
* To set the default center position of a world to the player's current location: `/dmap worldset <worldname> center:here`
* To set the default center position of a world to a given location: `/dmap worldset _worldname_ center:_X_/_Y_/_Z_`
* To set the default center position of a world to a given location: `/dmap worldset <worldname> center:<X>/<Y>/<Z>`
* To set the number of extra zoom out levels of a world to N: `/dmap worldset _worldname_ extrazoomout:_N_`
* To set the number of extra zoom out levels of a world to N: `/dmap worldset <worldname> extrazoomout:<N>`
* To list the maps for a given world: `/dmap maplist _worldname_`
* To list the maps for a given world: `/dmap maplist <worldname>`
* To delete a map from a given world: `/map mapdelete _worldname_:_mapname_`
* To delete a map from a given world: `/map mapdelete <worldname>:<mapname>`
* To add a new map to a given world (with a given title, perspective, shader, and lighting): `/dmap mapadd _worldname_:_mapname_ title:_"map-title"_ perspective:_perspective-id_ shader:_shader-id_ lighting:_lighting-id_`
* To add a new map to a given world (with a given title, perspective, shader, and lighting): `/dmap mapadd <worldname>:<mapname> title:<"map-title"> perspective:<perspective-id> shader:<shader-id> lighting:<lighting-id>`
* To edit the order/position of a map in the list of maps for a world to be Nth: `/dmap mapset _worldname_:_mapname_ order:_N_`
* To edit the order/position of a map in the list of maps for a world to be Nth: `/dmap mapset <worldname>:<mapname> order:<N>`
* To edit the title of a map: `/dmap mapset _worldname_:_mapname_ title:_"new-title"_`
* To edit the title of a map: `/dmap mapset <worldname>:<mapname> title:<"new-title">`
* To change the perspective of a map (new scale, new point of view): `/dmap mapset _worldname_:_mapname_ perspective:_perspective-id_`
* To change the perspective of a map (new scale, new point of view): `/dmap mapset <worldname>:<mapname> perspective:<perspective-id>`
* To change the filename prefix of a map: `/dmap mapset _worldname_:_mapname_ prefix:_prefix_`
* To change the filename prefix of a map: `/dmap mapset <worldname>:<mapname> prefix:<prefix>`
* To set the icon file for a map (relative path under 'webpath' - e.g. images/block_skylands.png) : `/dmap mapset _worldname_:_mapname_ icon:images/block_skylands.png`
* To set the icon file for a map (relative path under 'webpath' - e.g. images/block_skylands.png) : `/dmap mapset <worldname>:<mapname> icon:images/block_skylands.png`
* To set the map zoom in level for a map to N: `/dmap mapset _worldname_:_mapname_ mapzoomin:_N_`
* To set the map zoom in level for a map to N: `/dmap mapset <worldname>:<mapname> mapzoomin:<N>`
* To change the image format used for a map to JPG: `/dmap mapset _worldname_:_mapname_ img-format:jpg`
* To change the image format used for a map to JPG: `/dmap mapset <worldname>:<mapname> img-format:jpg`
* To change the default cave map to use the new 'textured cave view': `/dmap mapset _worldname_:_mapname_ shader:stdtexture-cave`
* To change the default cave map to use the new 'textured cave view': `/dmap mapset <worldname>:<mapname> shader:stdtexture-cave`
* To list the available perspectives: `/dmap perspectivelist`
@ -50,7 +50,7 @@ Once rendering is paused, the /dmap commands can be used to add, remove, reorder
* To list the available lightings: `/dmap lighinglist`
* To set a map to appear on the same line as maps of another world: `/dmap mapset _worldname_:_mapname_ append-to-world:_another_worldname_`
* To set a map to appear on the same line as maps of another world: `/dmap mapset <worldname>:<mapname> append-to-world:<another_worldname>`
Note: any attributes settable using 'mapset' can also be set on a new map using 'mapadd'.