Pages

Region Configuration

Default configuration entry

regions:
    test:
        region: 62,0,150|74,255,158
        world: world
        cross_placing: false
        deny_block_drops: border
        deny_item_drops: full
        deny_death_drops: full
        deny_usage:
            '381': full
            '408': full
            '154': full
            '23': full
            '158': full
            '29': border
            '33': border
            '342': full
            '343': full
            '407': full
            '54': full
            '61': full
            '146': full
            '130': full
            '379': full
            '138': full
        deny_place:
            '408': full
            '154': full
        deny_remove:
        enter:
            inventory:
            - store
            - clear
            xp:
            health:
            hunger:
        exit:
            inventory:
            - restore
            xp:
            health:
            hunger:
        messages:
            enter: '%gold%Welcome to %green%TEST%gold%.'
            exit: '%gold%Bye bye'
        cmdBlacklist:
        cmdWhitelist:
        cmdEnter:
        cmdExit:
        permissions:

Parameters

region
The WorldEdit coordinates or the WorlGuard region name for this region
world
The world where this region is.
cross_placing
Determines if placing blocks across the border (outside -> inside and inside -> outside) of the region is allowed. (Value: true/false)
deny_*
Deny certain actions to prevent users from smuggling items across the region border.
Available values for "deny"-settings:
none: The protection is disabled (= "false" in version 1.0)
full: The protection is enabled across the whole region (= "true" in version 1.0)
border: The protecition is enabled near the border of the region.
deny_block_drops
Disable all item drops.
deny_item_drops
Do not allow a player to drop items.
deny_death_drops
Do not drop items when a player dies.
deny_usage
A list of item-IDs which the player is not allowed to use/access in this region. (Format: 'ItemID': DenyMode)
deny_place
A list of item-IDs which the player is not allowed to place.
deny_remove
A list of item-IDs which the player is not allowed to destroy.
enter
exit
The values of the sub-items "health", "hunger", "xp" and "inventory" define what TaxFreeRegion does with the inventory/health/hunger/xp of a player when he enters/leaves the region.
Available values are:
clear: Reset the item to default value.
store: Save the item for the region where the player is coming from.
restore: Restore the saved item for the region where the player is going to.
reward : Save the current inventory as reward for the player. This can be accessed with the command /tf reward. The reward is available until a new reward is generated or the player crosses the border of another region. The reward is a copy of the inventory - it will not affect the real inventory.

You can use more than one value for the sub-items. You can combine them in any way you want - but not all combinations are usefull. If no value is provided, nothing will happen.
You can find some examples for this here: Configuration Tips & Tricks
messages -> enter
The message displayed when a player enters the region.
messages -> exit
The message displayed when a player leaves the region.
cmdBlacklist
A list of commands which are disabled inside this region. For example:
cmdBlacklist:
  - home
  - warp somewhere
cmdWhitelist
A list of commands which are only allowed in this region (or in any other region where this command is in the whitelist)
Example see cmdBlacklist
cmdEnter
cmdExit
Commands that are executed when a player enters/leaves the region.
The commands are executed in the context of the player and after the region-permissions are applied (prefix p:) or in the context of the server-console (prefix c:). %name% will be replaced with the name of the player. If you prepend the prefix dXXX: in front of p: or c: the command execution will be delayed for XXX seconds.
cmdEnter:
  - p:give %name% 278
cmdExit: 
  - c:time set 0
  - d10:c:say 10 seconds delay
permissions
A list of permissions that are applied to any player who is inside the region.
permissions:
    - worldguard.god: true
    - this.is.my.permission: false

Full configuration entry

regions:
    Creative-Area:
        region: wg|CREATIVE
        world: world
        cross_placing: false
        deny_block_drops: border
        deny_item_drops: full
        deny_death_drops: full
        deny_usage:
            '381': full
            '408': full
            '154': full
            '23': full
            '158': full
            '29': border
            '33': border
            '342': full
            '343': full
            '407': full
            '54': full
            '61': full
            '146': full
            '130': full
            '379': full
            '138': full
        deny_place:
            '408': full
            '154': full
        deny_remove:
        enter:
            inventory:
            - store
            - restore
            xp:
            - store
            - restore
            health:
            - store
            - restore
            hunger:
            - store
            - restore
        exit:
            inventory:
            - restore
            - store
            xp:
            - store
            - restore
            health:
            - store
            - restore
            hunger:
            - store
            - restore
        messages:
            enter: '%gold%Welcome to the %green%Creative-Area%gold%.'
            exit: '%gold%Bye bye'
        cmdBlacklist:
        - tpa
        - tpaccept
        - sethome
        - logout
        cmdWhitelist:
        - warp somewhere
        cmdEnter:
        - p:item 278|durability:3,dig_speed:5,LOOT_BONUS_BLOCKS:3,silk_touch:1
        - p:item 322 64
        - p:item 1 64
        - p:item 50 64
        cmdExit:
        - c:broadcast %name% left the region!
        permissions:
        -   taxfreeregion.clear: true
        -   spoutflight.fly: true
        -   commandbook.give: true
        -   commandbook.give.stacks: true
        -   commandbook.give.stacks.unlimited: true
        -   teleport.user: false
        -   teleport.tpa: false
        -   commandbook.home.set: false