Configuration & Permissions
Configuration
Below are the configuration options available in config.yml
Event Listeners
Normally, even when flags are turned off, GriefPreventionFlags must still perform checks to see that the flags are turned off. Event Listener options allow you to tell GriefPreventionFlags to stop monitoring certain "high-impact" events that can cause slower servers or very high population servers some problems. However, doing so will disable any flags that require these events, it may also disable events being used by 3rd party extensions of GriefPreventionFlags.
| Option | Flags & Events |
| Block | All Ice, Snow, Grass, and DragonEggTp flags. |
| CreatureSpawn | All Spawn and Build flags, BreedVillager. |
| EntityDamage | All "damage" flags (does not include Pvp or MonsterDamage) |
| Inventory | SpendExp Flag |
| LeafDecay | The LeafDecay flag. |
| PlayerMove | NotifyEnter, NotifyExit, AllowEntry, AllowLeave flags. PlayerEnterClaimEvent and PlayerExitClaimEvent. |
| Weather | Lightning Flag. |
Clusters
Clusters provide a way of grouping flags together, allowing the user to bypass all the typing. New clusters can be added by the server operator by editing the clusters.yml file. Clusters maintain their own permissions system, they do not require a flag permission even if the flag is in the cluster. Setting a cluster permission will not automatically include the flag permission or vice versa. Below is a list of default clusters. These defaults are examples and can be edited or removed.
IMPORTANT: When adding new clusters, the name should ALWAYS be lower case. Flag names are not case sensitive, and using cluster names with command in-game are not case sensitive. You may use in-line YAML list format if you wish.
cluster:
buildcreature:
- BuildGolem
- BuildSnowman
- BuildWither
jail:
- AllowEntry
- AllowLeave
- AllowTpIn
- AllowTpOut
notify:
- NotifyExit
- NotifyEnter
spawnmonster:
- SpawnByPlugin
- SpawnInvasion
- SpawnJockey
- SpawnLightning
- SpawnMob
- Spawner
- SpawnChunk
- SpawnOther
damage:
- DamageBlockExplode
- DamageContact
- DamageDrown
- DamageFall
- DamageBlockFall
- DamageFire
- DamageBurn
- DamageLava
- DamageLightning
- DamageMagic
- DamageMelting
- DamagePoison
- DamageStarve
- DamageSuffocate
- DamageSuicide
- DamageThorns
- DamageVoid
- DamageWither
- DamageOther
Permissions
Below is the list of permissions available. In order to modify a flag you must give a user both the command permission and the specific flag permission.
| Permission | Description | Default |
| gpflags.* | Allows access to all permissions in the plugin. | op |
| gpflags.setflag.* | Allows access to set or remove flags, messages, and trust at any location. | op |
| gpflags.setcluster.* | Allows the user set or remove clusters at any location. | op |
| gpflags.getflag.* | Allows access to all getflag commands | everyone |
| gpflags.help | Allows access to all help commands in GriefPreventionFlags. | everyone |
| gpflags.flags.* | Allows you to set all flag types. | op |
| gpflags.bypass.* | Allows the user to bypass all player flag effects. | op |
| gpflags.cluster.* | Allows you to set all cluster types | op |
Flag Command Permissions
| Permission | Description | Default |
| gpflags.getflag | Gives access to the getflag command | everyone |
| gpflags.getflag.global | Gives access to the getflagglobal command | everyone |
| gpflags.setflag | Allows you to set or remove flags, messages, and trust in your own claim. | op |
| gpflags.setflag.others | Allows you to set or remove flags, messages, and trust in others claims (not admin claims) | op |
| gpflags.setflag.global | Allows you to set or remove flags globally. | op |
| gpflags.setflag.admin | Allows you to set or remove flags, messages, and trust in an admin claim | op |
| gpflags.setflag.unclaimed | Allows users to set flags for the world in unclaimed areas. | op |
Cluster Command Permissions
| Permission | Description | Default |
| gpflags.setcluster | Allows you to set or remove a cluster in your own claim | op |
| gpflags.setcluster.others | Allows you to set or remove a cluster in others claims (not admin claims) | op |
| gpflags.setcluster.global | Allows you to set or remove a cluster globally | op |
| gpflags.setcluster.admin | Allows you to set or remove a cluster in an admin claim | op |
| gpflags.setcluster.unclaimed | Allows users to set flags for the world in unclaimed areas. | op |
Help Command Permissions
| gpflags.flags | Gives access to the flags help command | everyone |
| gpflags.clusters | Gives access to the clusters help command. | everyone |
Flag Permissions
| Permission | Description | Default |
| gpflags.flags.<flag name> | Allows you to set <flag name> | op |
| gpflags.bypass.<flag name> | Allows a user to bypass a player flag effect. | op |
| gpflags.cluster.<cluster name> | Allows you to set <cluster name> | op |
Deprecated
These permissions still work, for now. Try to stop using them.
| Permission | Description | Default |
| gpflags.removeflag | Deprecated (use gpflags.setflag instead) | op |
