Difference between revisions of "Configurations"
From SupaHam
(Initial page creation.) |
(Added types) |
||
| Line 1: | Line 1: | ||
| − | == Format == | + | ==Format== |
Copied from: http://wiki.sk89q.com/wiki/WorldEdit/Configuration/Bukkit | Copied from: http://wiki.sk89q.com/wiki/WorldEdit/Configuration/Bukkit | ||
| Line 9: | Line 9: | ||
* If you want to check the format of this file before putting it into WorldEdit, paste it into http://yaml-online-parser.appspot.com/ and see if it gives "ERROR:". | * If you want to check the format of this file before putting it into WorldEdit, paste it into http://yaml-online-parser.appspot.com/ and see if it gives "ERROR:". | ||
* Lines starting with # are comments and so they are ignored. | * Lines starting with # are comments and so they are ignored. | ||
| + | |||
| + | ==Types== | ||
| + | |||
| + | ===String=== | ||
| + | This can be set to any arbitrary text. | ||
| + | |||
| + | Some strings support colour formatting. The following colour codes are: | ||
| + | <!-- Copied from CommandBook/Configuration page with substituted ampersand --> | ||
| + | {| class="wikitable" | ||
| + | |- | ||
| + | ! Color code | ||
| + | ! Color on white | ||
| + | ! Color on black | ||
| + | |- | ||
| + | | &0 | ||
| + | | style="background-color: white;" | <font color="#000000">black</font> | ||
| + | | style="background-color: black;" | <font color="#000000">black</font> | ||
| + | |- | ||
| + | | &1 | ||
| + | | style="background-color: white;" | <font color="#0000aa">dark blue</font> | ||
| + | | style="background-color: black;" | <font color="#0000aa">dark blue</font> | ||
| + | |- | ||
| + | | &2 | ||
| + | | style="background-color: white;" | <font color="#00aa00">dark green</font> | ||
| + | | style="background-color: black;" | <font color="#00aa00">dark green</font> | ||
| + | |- | ||
| + | | &3 | ||
| + | | style="background-color: white;" | <font color="#00aaaa">dark cyan/aqua</font> | ||
| + | | style="background-color: black;" | <font color="#00aaaa">dark cyan/aqua</font> | ||
| + | |- | ||
| + | | &4 | ||
| + | | style="background-color: white;" | <font color="#aa0000">dark red</font> | ||
| + | | style="background-color: black;" | <font color="#aa0000">dark red</font> | ||
| + | |- | ||
| + | | &5 | ||
| + | | style="background-color: white;" | <font color="#aa00aa">dark purple</font> | ||
| + | | style="background-color: black;" | <font color="#aa00aa">dark purple</font> | ||
| + | |- | ||
| + | | &6 | ||
| + | | style="background-color: white;" | <font color="#ffaa00">dark yellow (gold)</font> | ||
| + | | style="background-color: black;" | <font color="#ffaa00">dark yellow (gold)</font> | ||
| + | |- | ||
| + | | &7 | ||
| + | | style="background-color: white;" | <font color="#aaaaaa">light grey</font> | ||
| + | | style="background-color: black;" | <font color="#aaaaaa">light grey</font> | ||
| + | |- | ||
| + | | &8 | ||
| + | | style="background-color: white;" | <font color="#555555">dark grey</font> | ||
| + | | style="background-color: black;" | <font color="#555555">dark grey</font> | ||
| + | |- | ||
| + | | &9 | ||
| + | | style="background-color: white;" | <font color="#5555ff">blue</font> | ||
| + | | style="background-color: black;" | <font color="#5555ff">blue</font> | ||
| + | |- | ||
| + | | &a | ||
| + | | style="background-color: white;" | <font color="#55ff55">green</font> | ||
| + | | style="background-color: black;" | <font color="#55ff55">green</font> | ||
| + | |- | ||
| + | | &b | ||
| + | | style="background-color: white;" | <font color="#55ffff">cyan/aqua</font> | ||
| + | | style="background-color: black;" | <font color="#55ffff">cyan/aqua</font> | ||
| + | |- | ||
| + | | &c | ||
| + | | style="background-color: white;" | <font color="#ff5555">red</font> | ||
| + | | style="background-color: black;" | <font color="#ff5555">red</font> | ||
| + | |- | ||
| + | | &d | ||
| + | | style="background-color: white;" | <font color="#ff55ff">purple/pink</font> | ||
| + | | style="background-color: black;" | <font color="#ff55ff">purple/pink</font> | ||
| + | |- | ||
| + | | &e | ||
| + | | style="background-color: white;" | <font color="#ffff55">yellow</font> | ||
| + | | style="background-color: black;" | <font color="#ffff55">yellow</font> | ||
| + | |- | ||
| + | | &f | ||
| + | | style="background-color: white;" | <font color="#ffffff">white</font> | ||
| + | | style="background-color: black;" | <font color="#ffffff">white</font> | ||
| + | |} | ||
| + | |||
| + | In addition, &k, &l, &m, &n, &o, and &r are 'obfuscated/magic', bold, strikethrough, underline, italic, and reset, respectively. | ||
| + | |||
| + | ===List=== | ||
| + | This type is basically a Collection, you can give it more than one Type. An example for usage of List would be player names that should be allowed to build in an area. | ||
| + | |||
| + | ===Integer=== | ||
| + | This type can be any '''whole''' number, negative or positive, that does not have a fraction or decimal portion. | ||
| + | |||
| + | ===Double=== | ||
| + | This type is like an '''Integer''', but accepts decimals. | ||
| + | |||
| + | ===Boolean=== | ||
| + | A boolean can be 0 or 1, true or false, yes or no, etc. This type is used to toggle states. | ||
| + | |||
| + | ===String Location=== | ||
| + | This type represents a '''Location''' converted into a '''String'''. It consists of an x, y, and z coordinate. An example of a '''String Location''' would be "10,64,30" which when parsed would create a location with the x as 10, y as 64, and z as 30. | ||
Revision as of 01:26, 18 January 2014
Contents
Format
Copied from: http://wiki.sk89q.com/wiki/WorldEdit/Configuration/Bukkit
The file is written in the YAML format and you must follow these guidelines:
- Do not use tabs. You MUST use spaces or Bukkit will complain. If you use an editor like Notepad++ (recommended for Windows users), you must configure it to "replace tabs with spaces." In Notepad++, this can be changed in Settings > Preferences > Language Menu.
- Don't get rid of the indents. They are indented so some entries are in categories (like "max-blocks-changed" is in the "limits" category.
- If you want to check the format of this file before putting it into WorldEdit, paste it into http://yaml-online-parser.appspot.com/ and see if it gives "ERROR:".
- Lines starting with # are comments and so they are ignored.
Types
String
This can be set to any arbitrary text.
Some strings support colour formatting. The following colour codes are:
| Color code | Color on white | Color on black |
|---|---|---|
| &0 | black | black |
| &1 | dark blue | dark blue |
| &2 | dark green | dark green |
| &3 | dark cyan/aqua | dark cyan/aqua |
| &4 | dark red | dark red |
| &5 | dark purple | dark purple |
| &6 | dark yellow (gold) | dark yellow (gold) |
| &7 | light grey | light grey |
| &8 | dark grey | dark grey |
| &9 | blue | blue |
| &a | green | green |
| &b | cyan/aqua | cyan/aqua |
| &c | red | red |
| &d | purple/pink | purple/pink |
| &e | yellow | yellow |
| &f | white | white |
In addition, &k, &l, &m, &n, &o, and &r are 'obfuscated/magic', bold, strikethrough, underline, italic, and reset, respectively.
List
This type is basically a Collection, you can give it more than one Type. An example for usage of List would be player names that should be allowed to build in an area.
Integer
This type can be any whole number, negative or positive, that does not have a fraction or decimal portion.
Double
This type is like an Integer, but accepts decimals.
Boolean
A boolean can be 0 or 1, true or false, yes or no, etc. This type is used to toggle states.
String Location
This type represents a Location converted into a String. It consists of an x, y, and z coordinate. An example of a String Location would be "10,64,30" which when parsed would create a location with the x as 10, y as 64, and z as 30.
