Plot flags
Introduction
The extensive flagging system allows you to do all sorts of things such as setting the plot weather.
Setting a flag is easy, just use /plot flag set <flag> <value>
. For a boolean flag, the value would either be 'true' or 'false'.
Flag List
To bring up a list of flags use /plot flag list
. These values are clickable, and clicking a flag name will show you information about that particular flag. You can also use /plot flag info <flag>
directly, if you already know the flag name.
Default Plot and Road Flags
You can set default flags per world in the plugins/PlotSquared/config/worlds.yml
. Default flags will be present in each claimed plot unless a different value is manually set for that plot.
The following is an example of setting the use
flag to allow interaction with doors, and trapdoors, levers, gates, pressure plates, buttons and trip wires:
<world>
indicates the name of that plotworld.
You can use Vanilla block tags too.
The same works for road flags.
Example:
<world>
indicates the name of that plotworld.
Flag types
BlockTypeList
A list of blocks, supporting both legacy numerical IDs and new string IDs e.g.
grass_block
for grass blocks7
for bedrock7,3
for bedrock and dirt35:14,35:15
for red and black wool
These flags also support vanilla-tags, like:
#signs
for all sign types#buttons
for all button types
Boolean
Accepts true
or false
.
Double
Accepts any decimal number (all real numbers).
Enum
Accepts a predefined collection of values.
Integer
Accepts all integers.
Internal
Flags used internally.
Miscellaneous
Accept commands with multiple parameters, e.g /gamemode creative
.
String
Accept flags with multiple string parameters, e.g. /plot f set greeting Welcome to my plot!
TeleportDeny
Accepts the follow plot membership trusted
, members
, nonmembers
, nontrusted
and nonowners
.
Timed
A binary tuple of numbers e.g. 53 6
or 7 93
.
Flag Permissions
Basic Permission Schema
To give a player access to a flag, you need to assign the following permissions, and exchange the value if wanted:
plots.set.flag
plots.flag
plots.flag.add
plots.flag.remove
Also, you can assign plots.permpack.basicflags
to cover the following permissions and lots of the basic flags.
Flag specific permission
plots.set.flag.<name>.*
(e.g. plots.set.flag.fly.*
) The asterisk covers the values of the flag, if it's a boolean flag you cover true
and false
, if it's a Long flag you cover all positive numbers and so on. Make sure to decide whether you need it or not.
Terminology
The following tables contain phrases covering certain stances of plot member inheritance and flag states. 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 tiers.
False: The flag intended behavior is not enabled by default.
True: The flag intended behavior is enabled by default.
None: 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.
Null: The flag intended behavior cannot be set outside of the API.
Empty: The flag variable is empty and won't appear to the user.
Not Buyable: The flag variable is not set, therefore the plot is not buyable.
Disabled: The flag variable is not set, therefore the intended behavior is not defined.
Entity Categories
Flags such as mob caps, interaction flags, etc, make use of entity categories. PlotSquared divides entities in the following categories:
animal: cod donkey squid skeleton_horse mule trader_llama parrot zombie_horse cow horse bee polar_bear pufferfish cat bat salmon fox pig llama iron_golem turtle tropical_fish sheep snow_golem mooshroom ocelot dolphin chicken wolf panda rabbit
hostile: blaze pillager skeleton giant elder_guardian zombie_pigman end_crystal ravager ghast guardian vindicator magma_cube spider creeper wither evoker slime illusioner phantom witch wither_skeleton husk ender_dragon cave_spider stray enderman silverfish endermite vex zombie drowned zombie_villager, shulker
player: player
projectile: ender_pearl dragon_fireball fireball wither_skull llama_spit fishing_bobber experience_bottle egg arrow small_fireball
vehicle: spawner_minecart donkey pig llama furnace_minecart skeleton_horse mule hopper_minecart trader_llama zombie_horse tnt_minecart boat chest_minecart horse command_block_minecart minecart
villager: villager wandering_trader snowball spectral_arrow shulker_bullet potion trident
hanging: item_frame leash_knot painting
other: dragon_fireball tnt experience_orb lightning_bolt fireball wither_skull area_effect_cloud evoker_fangs eye_of_ender armor_stand small_fireball firework_rocket falling_block item
tamable: cat trader_llama parrot zombie_horse donkey wolf llama horse skeleton_horse mule
Flags
BlockTypeList
Name | Description | Default Value |
---|---|---|
break | Define a list of materials players should be able to break in the plot even when they aren’t added to the plot. | None |
place | Define a list of materials players should be able to place in the plot even when they aren’t added to the plot. | None |
use | Define a list of materials players should be able to interact with in the plot even when they aren’t added to the plot. | None |
Boolean
Name | Description | Default Value |
---|---|---|
animal-attack | Set to | False |
animal-interact | Set to | False |
beacon-effects | Set to | True |
block-burn | Set to | False |
block-ignition | Set to | True |
chat | Set to | False |
concrete-harden | Set to | True |
coral-dry | Set to | False |
crop-grow | Set to | True |
copper-oxide | Set to | False |
deny-exit | Set to | False |
deny-portal-travel | Prevents players from travelling across dimensions by using portals. | False |
deny-portals | Prevents players from creating portals of any kind. | False |
device-interact | Set to | False |
disable-physics | Set to | False |
drop-protection | Set to | False |
edit-sign | Set to | False |
entity-change-block | Set to | False |
explosion | Set to | False |
fishing | Set to | False |
fly | Set to | False |
forcefield | Set to | False |
grass-grow | Set to | True |
hanging-break | Set to | False |
hanging-place | Set to | False |
hide-info | Set to | False |
hostile-attack | Set to | False |
hostile-interact | Set to | False |
ice-form | Set to | False |
ice-melt | Set to | False |
instabreak | Set to | False |
invincible | Set to | False |
item-drop | Set to | True |
keep-inventory | Prevents players from dropping their items when they die inside the plot. | False |
kelp-grow | Set to | True |
leaf-decay | Set to | True |
lectern-read-book | Prevent players taking books from lecterns. | False |
misc-break | Set to | False |
misc-place | Set to | False |
misc-interact | Set to | |
mob-break | Set to | False |
mob-place | Set to | False |
mycel-grow | Set to | True |
no-worldedit | Set to | False |
notify-enter | Set to | False |
notify-leave | Set to | False |
player-interact | Set to | False |
pve | Set to | False |
pvp | Set to | False |
prevent-creative-copy | Prevents people from copying item NBT data in the plot unless they're added as members. | False |
projectiles | Prevents guests from shooting projectiles on the plot when set to false. | False |
projectile-change-block | Set to | False |
redstone | Set to | True |
server-plot | Set to | False |
snow-form | Set to | False |
snow-melt | Set to | True |
soil-dry | Set to | False |
tamed-attack | Set to | False |
tamed-interact | Set to | False |
tile-drop | Set to | True |
untrusted-visit | Set to | True |
vehicle-break | Set to | False |
vehicle-place | Set to | False |
vehicle-use | Set to | False |
villager-interact | Set to | False |
vine-grow | Set to | True |
Double
Name | Description | Default Value |
---|---|---|
price | If set a plot can be bought for this price using | Not Buyable |
Enum
Name | Description | Default Value |
---|---|---|
deny-teleport | Deny a certain group from teleporting to the plot. Available groups: members, nonmembers, trusted, nontrusted, nonowners | None |
liquid-flow | Set to | None |
titles | Set to | None |
weather | Specifies the simulated weather inside the plot. This hasn’t an effet of weather dependent game mechanics. | None |
Integer
Name | Description | Default Value |
---|---|---|
animal-cap | Set to an integer value to limit the amount of animals on the plot. Applies to the following entity categories: animal, villager, tamable | Infinity |
entity-cap | Set to an integer value to limit the amount of entities on the plot. | Infinity |
hostile-cap | Set to an integer value to limit the amount of hostile entities on the plot. Applies to the following entity categories: hostile | Infinity |
misc-cap | Set to an integer value to limit the amount of miscellaneous entities on the plot. Applies to the following entity categories: projectile, other, hanging | Infinity |
mob-cap | Set to an integer value to limit the amount of mobs on the plot. Applies to the following entity categories: animal, villager, tamable, hostile | Infinity |
vehicle-cap | Set to an integer value to limit the amount of vehicles on the plot. Applies to the following entity categories: vehicle | Infinity |
time | Specifies the simulated time inside the plot. This has no effect of time dependent game mechanics. | Disabled |
Internal
Name | Description | Default Value |
---|---|---|
analysis | A multi purpose debug analysis flag. | Null |
done | Mark a plot as done. | Null |
Miscellaneous
Name | Description | Default Value |
---|---|---|
blocked-cmds | A list of commands that are blocked in the plot. | None |
gamemode | Determines the gamemode in the plot. | None |
guest-gamemode | Determines the guest gamemode in the plot. | None |
music | Set to a music disk ID (item name) to play the music disc. | None |
String
Name | Description | Default Value |
---|---|---|
description | Plot description. | None |
farewell | Message sent to players when leaving the plot. | None |
greeting | Message sent to players on plot entry. | None |
plot-title | Set the pop-up title's title and subtitle. Format: | None |
Timed
Name | Description | Default Value |
---|---|---|
feed | Specify an interval in seconds and an optional amount by which the players will be fed (amount is 0 by default = vanilla-regeneration). | None |
heal | Specify an interval in seconds and an optional amount by which the players will be healed (amount is 0 by default = vanilla-regeneration). | None |
Last updated