Upstream/PlotSquared
1
0
Fork 0
mirror of https://github.com/IntellectualSites/PlotSquared.git synced 2024-11-21 11:45:19 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated Plot flags (markdown)

NotMyFault 2020-02-17 15:41:03 +01:00
parent d61a28dafe
commit dffb0b143d
1 changed files with 60 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
Plot-flags.md

@ -22,16 +22,12 @@ worlds:
## Flag types:
#### - String
Accepts any letter, number, space, color codes, and a few symbols.
#### - String (restricted)
Usually only accepts a few specific values (See in game documentation)
#### - Boolean
Accepts `true` or `false`
#### - Long
Accepts a positive whole number (can be large)
#### - Interval
Two sets of numbers e.g. `53 6` or `7 93`
#### - UnsignedInteger
A positive whole numer, e.g. `43`
#### - BlockList
A list of blocks, supporting both legacy numerical IDs and new string IDs e.g.
- `grass_block` for grass blocks
@ -54,10 +50,11 @@ The asterisk covers the values of the flag, if it's a boolean flag you cover `tr
### Terminology
#### The following tables contain phrases covering certain stances of plot member inheritance. We will explain the phrases used below.
- Player: The player, as in user of the server.
- Guest: Person who is not added to the plot ([Check Plot Rank Tiers](https://github.com/IntellectualSites/PlotSquared/wiki/Plot-Rank-Tiers))
- False: The flag intended behavior is not enabled by default
- True: The flag intended behavior is enabled by default
- Null: The flag intended behavior is not set by default
- Guest: Person who is not added to the plot ([Check Plot Rank Tiers].(https://github.com/IntellectualSites/PlotSquared/wiki/Plot-Rank-Tiers)).
- False: The flag intended behavior is not enabled by default.
- True: The flag intended behavior is enabled by default.
- Null: The flag intended behavior is not set by default.
- Infinity: The flag is not bound to an amount and allows infinite types of the flag.
## Flags
### Boolean:
@ -75,6 +72,7 @@ The asterisk covers the values of the flag, if it's a boolean flag you cover `tr
| vine-grow | Set to `true` allow vines to grow | Null |
| mycel-grow | Set to `true` mycel to grow | Null |
| kelp-grow | Set to `true` kelp to grow | Null |
| instabreak | Set to `true` to allow blocks to be broken instantly | False |
| disable-physics | Set to `true` to disable block physics | False |
| liquid-flow | Set to `false` to disable liquid flowing | True |
| snow-melt | Set to `true` to enable snow melting | Null |
@ -121,3 +119,57 @@ The asterisk covers the values of the flag, if it's a boolean flag you cover `tr
| greeting | Message sent to players on plot entry. Supports '&' color codes | Null |
| farewell | Message sent to players when leaving the plot. Supports '&' color codes | Null |
| done | Mark a plot as done | Null |
### StringList:
| Name | Description | Default Value
|------------------------------------------------------------|--------------------------------------------------------------------------------| ------------------- |
| blocked-cmds | Any command added to this list cannot be executed within the plot | Null |
### Interval:
| Name | Description | Default Value
|------------------------------------------------------------|--------------------------------------------------------------------------------| ------------------- |
| feed | Feed a player a certain amount at an interval whilst inside a plot | Null |
| heal | Heal a player a certain amount at an interval whilst inside a plot | Null |
### Gamemode:
| Name | Description | Default Value
|------------------------------------------------------------|--------------------------------------------------------------------------------| ------------------- |
| gamemode | Set players' gamemode is set upon plot entry according | Null |
| guest-gamemode | Set guests' gamemode is set upon plot entry according | Null |
### BlockStateList:
| Name | Description | Default Value
|------------------------------------------------------------|--------------------------------------------------------------------------------| ------------------- |
| use | Contains a list of blocks allowed to be interacted with inside the plot | Null |
| break | Contains a list of blocks allowed to be broken within the plot | Null |
| place | Contains a list of blocks allowed to be placed within the plot | Null |
### Long:
| Name | Description | Default Value
|------------------------------------------------------------|--------------------------------------------------------------------------------| ------------------- |
| time | Whilst on the plot, a player will experience the time (in ticks) set by the flag | Null |
### PlotWeather:
| Name | Description | Default Value
|------------------------------------------------------------|--------------------------------------------------------------------------------| ------------------- |
| weather | Whilst in the plot, a player will experience the weather set by the flag | Null |
### Double:
| Name | Description | Default Value
|------------------------------------------------------------|--------------------------------------------------------------------------------| ------------------- |
| price | If set a plot can be bought for this price using `/plot buy`. Requires economy to be enabled and lists plots under `/plots list forsale` | Null |
### TeleportDeny:
| Name | Description | Default Value
|------------------------------------------------------------|--------------------------------------------------------------------------------| ------------------- |
| deny-teleport | If set blocked players can no longer teleport to the plot. Supports the following groups: `trusted`, `members`, `nonmembers`, `nontrusted`, `nonowners` | Null |
### Integer:
| Name | Description | Default Value
|------------------------------------------------------------|--------------------------------------------------------------------------------| ------------------- |
| misc-cap | Limits the amount of paintings, item frames and signs within the plot based on the flag value | Infinity |
| entity-cap | Limits the amount of entities allowed to be spawned within the plot based on the flag value | Infinity |
| mob-cap | Limits the amount of creatures allowed to be spawned within the plot based on the flag value | Infinity |
| animal-cap | Limits the amount of animals allowed to be spawned within the plot based on the flag value | Infinity |
| hostile-cap | Limits the amount of hostile mobs allowed to be spawned within the plot based on the flag value | Infinity |
| vehicle-cap | Limits the amount of vehicles allowed to be spawned within the plot based on the flag value. This includes all minecart types and boats | Infinity |