flagGroups.yml Old - alex9849/advanced-region-market GitHub Wiki

The flagGroups.yml contains all FlagGroups that can be assigned to regions. A FlagGroup contains multiple WorldGuard flags that will be applied to a region depending if its sold or not. Flags can also be made editable. That means that for example, you can decide if your players can edit some flags via a GUI flageditor.
There are 2 static flagGroups the subregion flagGroup and the default flagGroup. The subregion-flagGroup is used by (and only by) subregions. The default flagGroup will be automatically assigned to all regions that don't have a flagGroup set.

Example:

FlagGroups:
  examplegroup:
    priority: 10
    available:
      0:
        setting: 'deny g:non_members'
        editable: false
        flag: ride
      1:
        setting: '&b[ARM] &6This region can be bought for &2%price%%currency%'
        editable: false
        flag: greeting
        applyto:
          - SellRegion
      2:
        setting: '&b[ARM] &6This region can be rented! Please rent me :P'
        editable: false
        flag: greeting
        applyto:
          - RentRegion
          - ContractRegion
      3:
        setting: 'allow g:all'
        editable: false
        flag: use
      4:
        setting: 'deny g:non_members'
        editable: false
        flag: build
    sold:
      0:
        setting: 'deny g:non_members'
        editable: true
        flag: ride
        editPermission: "my.custom.permission"
        guidescription:
          - '&2Decides if players can use vehicles'
      1:
        setting: 'remove'
        editable: true
        flag: greeting
        guidescription:
          - '&2Sets a message that will be'
          - '&2shown to players that enter'
          - '&2the region'
      2:
        setting: 'deny g:non_members'
        editable: true
        flag: use
        guidescription:
          - '&2Decides if players can use things'
          - '&2like doors, levers, etc.'
      3:
        setting: 'deny g:non_members'
        editable: false
        flag: build

Variable/Placeholder	Meaning
examplegroup	The internal name of the flagGroup
priority	The priority of the region in WorldGuard
available	The flags that should be set if the region is available
sold	The flags that should be set if the region is sold
the number	Must be unique within the section
setting	The setting of the flag (flags that don't appear in the section will be removed however, "remove" can be used if you don't want the flag to be set, but want to make it editable by users)
editable	If true the region owner can edit that flag
flag	The name of the flag in WorldGuard
guidescription	A description of the flag that will be shown to users that open the flageditor
editPermission	If the region is editable you can specify a permission that a player needs in order to edit the flag. This is an optional parameter. If you set it to null or "" no permission will be needed.
applyto	Specifies the selltypes on which a flag should be applied to. You can write multiple selltypes if you want. This is an optional parameter. If you set it to null or [] the flag will be applied to all selltypes

---

Commands:

/arm setflaggroup [REGION] [FLAGGROUP]
/arm setflaggroup rk:[REGIONKIND] [FLAGGROUP]

Will set a flaggroup as flaggroup of a specific region or to all regions with a specific regionkind

Permission(s):

• arm.admin.setflaggroup

---

/arm flageditor [REGION]
/arm flageditor

Opens the flageditor of a specific region or of the region at your position

Permission(s):

• arm.admin.flageditor (For all regions)
• arm.member.flageditor (For own regions)