查看“Residence”的源代码

==概览==
===关于===
   Residence不同于其他大多数的保护类插件，它旨在让用户能够自行保护他们自己的家而不需要麻烦管理员进行操作。     
   Residence支持很多种类的保护项目，包括限制地区内的移动,领地的拥有者可以配置这些保护项目，但同时仍受限于管理员。

===链接===
  Vault: Vault
GitHub资源:
GitHub
IRC discussion channel: irc://irc.esper.net/Residence
  Development builds of this project can be acquired at the provided
continuous integration server
. 
   这些开发版本还没有被BukkitDev的职员正式认可.使用时自负风险。

===拓展插件===
   Dynmap Residence
- 动态地图插件使得领地信息可以显示在网页地图中.
   ResExtras - 增加雪，冰，动物，怪物以及更多可以控制的项目.
   Residence Fly - 领地内控制飞行的开启/关闭，当玩家离开领地时，将会失去飞行能力.
   Residence Signs - 使用木牌实现购买，售卖，租赁领地的便捷功能.
   ResTown - 设置城镇型领地，使得领地外的建设行为纳入控制.(设置哪些玩家可以不受领地限制，在领地外能够建设)
   ResProtect - 通过权限保护领地内动物.
   ResCreative - 进入领地时激活创造模式.
   ResPerm - 添加更多的个人领地权限节点.
    
   SimpleClansResidence
- 合并领地与简易的家族两个插件的特性.
  Flags - 显然，这个拓展添加了旗帜或其它东西.

===贡献===
  smbarbour (代码编译)
inorixu (代码编译)
lemon42 (代码编译)
Daniel Few (Wiki编写)
Linaks (Residence图标设计)
SirHedgehog (代码编译)
GSValore (代码编译)
Samkio (Wiki音频)
JustinGuy (代码编译)
Tonkovich (代码编译)

===捐助===
   Donations
   如果你感谢我这些年来对插件的更新与维护，你可以自愿地捐助一些钱来作为谢意。

==使用==
===权限===
  注1：本条目中的“越权”指无视当前领地的权限设置，直接使命令生效。
  注2：true即启用，false即关闭。

====管理员权限====

residence.admin:
  描述: 给你使用/resadmin命令的权限
  默认开启: op

子权限:
  residence.admin.tp: true
  描述: 允许越权使用强制TP命令
  默认开启: op

  residence.admin.move: true
  描述: 允许越权在领地中移动
  默认开启: op

  residence.commands.admin: true
  描述: 允许应用默认的基础权限设置
  默认开启: true

====管理员命令权限====

residence.commands.admin:
  描述: 允许使用管理员的命令
  默认开启: op

子权限:
  residence.commands.user: true
  residence.commands.setowner: true
  residence.commands.listallhidden: true
  residence.commands.server: true

====用户权限====

residence.user:
  描述: 允许应用默认的基础权限设置
  默认开启: true

子权限:
  residence.commands.user: true
  residence.flags.*: true

====用户命令权限====

residence.commands.user:
  描述: 允许使用普通用户的命令
  默认开启: op

子权限:
  residence.commands.create: true
  residence.commands.select: true
  residence.commands.remove: true
  residence.commands.subzone: true
  residence.commands.gui: true
  residence.commands.sublist: true
  residence.commands.compass: true
  residence.commands.info: true
  residence.commands.current: true
  residence.commands.set: true
  residence.commands.pset: true
  residence.commands.rset: true
  residence.commands.rentlink: true
  residence.commands.rentlinks: true
  residence.commands.rename: true
  residence.commands.unstuck: true
  residence.commands.mirror: true
  residence.commands.defualt: true
  residence.commands.list: true
  residence.commands.listall: true
  residence.commands.tp: true
  residence.commands.tpset: true
  residence.commands.market: true
  residence.commands.give: true
  residence.commands.message: true
  residence.commands.clearflags: true
  residence.commands.tool: true

====命令权限====

residence.commands:
  描述: 允许使用所有命令
  默认开启: op
子权限:
  residence.commands.admin: true

residence.commands.create:
  描述: 允许创建领地
  默认开启: op
子权限:
  residence.commands.select: true

residence.commands.select:
  描述: 允许选择一个地区来创建领地
  默认开启: op

residence.commands.remove:
  描述: 允许删除领地
  默认开启: op

residence.commands.setowner:
  描述: 允许设置领地拥有者
  默认开启: op

residence.commands.subzone:
  描述: 允许创建子领地
  默认开启: op

residence.commands.gui:
  描述: 暂时无效
  默认开启: op

residence.commands.sublist:
  描述: 允许你查看子领地列表
  默认开启: op

residence.commands.compass:
  描述: Allows you to set compass destinations to residences
  默认开启: op

residence.commands.info:
  描述: 允许你查看领地信息
  默认开启: op

residence.commands.current:
  描述: 查看你现在所处的领地
  默认开启: op

residence.commands.set:
  描述: 允许你设置领地的flags
  默认开启: op

residence.commands.pset:
  描述: 允许你设置玩家flags
  默认开启: op

residence.commands.rset:
  描述: 允许你设置租赁flags
  默认开启: op

residence.commands.rentlink:
  描述: 允许你通过rentlink把子领地租赁给另一个人
  默认开启: op

residence.commands.rentlinks:
  描述: 允许你查看领地内的rentlinks
  默认开启: op

residence.commands.rename:
  描述: 允许重命名领地
  默认开启: op

residence.commands.unstuck:
  描述: 允许你在领地里脱离卡死
  默认开启: op

residence.commands.mirror:
  描述: 允许你继承另一个领地的权限
  默认开启: op

residence.commands.defualt:
  描述: 允许你把领地的权限设置为默认
  默认开启: op

residence.commands.list:
  描述: 允许查看自己领地的列表
  默认开启: op

residence.commands.listall:
  描述: 允许查看所有领地列表
  默认: op

residence.commands.listall.hidden:
  描述: 允许你查看隐藏领地
  默认: op

residence.commands.tp:
  描述: 允许使用/res tp
  默认: op

residence.commands.tpset:
  描述: 允许设置领地传送点
  默认: op

residence.commands.market:
  描述: 允许使用交易命令
  默认: op

residence.commands.give:
  描述: 允许赠送领地
  默认: op

residence.commands.message:
  描述: 允许设置领地信息
  默认: op

residence.commands.clearflags:
  描述: 允许你清楚领地flags
  默认(开启): op

residence.commands.tool:
  描述: 允许查看圈地工具
  默认(开启): op

residence.commands.server:
  描述: 允许建立服务器领地
  默认(开启): op

residence.flags.*:
  描述:允许设置所有的领地权限   
  默认(开启): op

residence.flags.FLAGNAME:
  描述:允许设置FLAFGNAME这个领地权限(替换为特定的领地权限名)
  默认(开启): op


===配置文件===
注：以下配置文件均来源于Residence V2.6.6.6版本，仅做参考!
#这些是Residence插件的全局设定.
Global:
    # 这是在Residence语言文件夹中加载的语言文件 <你想设置的语言>.yml 
    # 所有 Residence 的文本均来源于此(NOT DONE YET)
    Language: English
    #木锄是Residence默认的选择工具.
    # 你可以选择另外一个列表中的物品的ID http://www.minecraftwiki.net/wiki/Data_values
    SelectionToolId: 290
    # 这是你想用来查看领地信息的工具 默认为线.
    # 简单的选中这个工具并且在你想要查询的领地区域内单击一下地面，聊天栏内就会出现领地的信息
    InfoToolId: 287
    # 移动权限检查间隔, 以毫秒（ms）为单位.
    # 减少这个数值将会增加服务器负担.
    # 增加这个数值将会允许玩家在被传送走之前无移动权限下走的更远.
    MoveCheckInterval: 500
    # 保存领地间隔，单位: 分钟(min)
    SaveInterval: 10
    # 默认权限组
    DefaultGroup: default
    # 开启/关闭租赁系统
    UseLeaseSystem: false
    # 检查租赁间隔，单位: 分钟(min)
    LeaseCheckInterval: 10
    # Allows leases to automatically renew so long as the player has the money, if economy is disabled, this setting does nothing.
    LeaseAutoRenew: true
    # Whether or not to use the Permissions system in conjunction with this config.
    EnablePermissions: true
    # Set to true if NOT using Permissions or PermissionsBukkit, or using a really old version of Permissions
    LegacyPermissions: false
    # Enable / Disable Residence's Economy System (iConomy, MineConomy, Essentials, BOSEconomy, and RealEconomy supported).
    EnableEconomy: true
    # Enables or disables the Rent System
    EnableRentSystem: false
    # The interval, in minutes, between residence rent expiration checks (if the rent system is enabled).
    RentCheckInterval: 10
    # Enable or disable residence chat channels.
    ResidenceChatEnable: true
    # Color of residence chat.
    ResidenceChatColor: DARK_PURPLE
    # Whether or not to ignore the usual Permission flags and only allow OPs and groups with 'residence.admin' to change residences.
    AdminOnlyCommands: false
    # Setting this to true makes server OPs admins.
    AdminOPs: true
    # This is the name of the plugin you use for multiworld, if you dont have a multiworld plugin you can safely ignore this.
    # The only thing this does is check to make sure the multiworld plugin is enabled BEFORE Residence, to ensure properly loading residences for other worlds.
    MultiWorldPlugin: Multiverse-Core
    # Setting this to true causes subzones to inherit flags from their parent zones.
    ResidenceFlagsInherit: true
    # Setting this to false will allow rented residences to be modified by the renting player.
    PreventRentModify: true
    # Setting this to false will cause residence to continue to load even if a error is detected in the save file.
    StopOnSaveFault: true
    # This is the residence name filter, that filters out invalid characters.  Google "Java RegEx" or "Java Regular Expressions" for more info on how they work.
    ResidenceNameRegex: '[^a-zA-Z0-9\\-\\_]'
    # Setting this to true sends a message to the console every time Residence does a rent expire check or a lease expire check.
    ShowIntervalMessages: false
    # Experimental - The following settings are lists of block IDs to be used as part of the checks for the "container" and "use" flags when using mods.
    CustomContainers: []
    CustomBothClick: []
    CustomRightClick: []
    # These are world flags that are applied when the player is NOT within a residence.
    Flags:
        Global: #these are default for all worlds unless specified below, they can be overridden per group
            use: true
            build: true
            ignite: true
            firespread: true
            damage: true
            creeper: true
            tnt: true
            pvp: true
        WorldNameHere: #here you can set flags for individual worlds, these override Global
            #build: true
    # This gives permission to change certain flags to all groups, unless specifically denied to the group.
    FlagPermission:
        move: true
        build: true
        place: true
        destroy: true
        use: true
        container: true
        pvp: true
        tp: true
        ignite: true
        firespread: true
        bucket: true
        flow: true
        lavaflow: true
        waterflow: true
        creeper: true
        tnt: true
        monsters: true
        animals: true
        subzone: true
        healing: true
        piston: true
        diode: true
        lever: true
        button: true
        door: true
        table: true
        enchant: true
        brew: true
        bed: true
        cake: true
        note: true
        trample: false
        burn: true
        explode: false
        fireball: true
    # These are default flags applied to all residences from any user group.
    ResidenceDefault:
        build: false
        use: false
        container: false
        pvp: false
        tnt: false
        creeper: false
        flow: false
        piston: false
        ignite: false
        firespread: false
    # These are default flags applied to the residence creator of any group.
    CreatorDefault:
        build: true
        move: true
        use: true
        ignite: true
        container: true
     # These are default group flags applied to a residence made by a user of any group.
    GroupDefault:
        #default: #group name
            #build: true
    
# These groups correspond to the Permissions groups defined in your '<worldname>.yml'
Groups:
    Default: #group name
       # Information about the Residence zone that the player can define.
       #Uncomment the lines below to mirror this config to other groups.
       #Mirror:
         #- 'group1'
         #- 'group2'
       Residence:
           # Determins if this group can create residences or not.  This option can be overriden with the permissions node 'residence.create'
           CanCreate: true
           # The maximum number of Residences a player can have.
           MaxResidences: 3
           # The maximum number of physical areas a residence can have.
           MaxAreasPerResidence: 2
           # The maximum number of blocks a Residence can be, East to West (X).
           MaxEastWest: 16
           # The maximum number of blocks a Residence can be, North to South (Z).
           MaxNorthSouth: 16
           # The maximum number of blocks a Residence can be, High to Low (Y).
           MaxUpDown: 256
           # The lowest altitude this group is allowed to protect.
           MinHeight: 0
           # The highest altitude this group is allowed to protect.
           MaxHeight: 255
            # The maximum recursive depth that subzones can go.
            # A subzone within a subzone within the Residence zone would be a depth of 2.
            # Set to 0 to disable subzones.
           SubzoneDepth: 3
           # Whether or not to allow teleporting to Residences.
           CanTeleport: true
           # Allow or Disallow the use of /res unstuck, to get yourself out of a residence if stuck in one somehow
           Unstuck: true
           # Allow or Disallow the use of the /res select command, if disabled they can only use the selection tool.
           SelectCommandAccess: true
           # Allow or Disallow the group to access the Blacklist/Ignorelist for residences they own.
           ItemListAccess: true
       # Options relating to enter and leave messages on the residence.
       Messaging:
           # Whether or not the player can change the Residence enter and leave messages.
           CanChange: true
           # The default enter message to apply to new Residences created by players in this group.
           # Leaving the message blank will disable it.
           DefaultEnter: Welcome %player to %residence, owned by %owner.
           # The default leave message to apply to new Residences created by players in this group.
           # Leaving the message blank will disable it.
           DefaultLeave: Now leaving %residence.
       # Options relating to the Lease system.
       Lease:
          # The maximum number of days to allow leases.
          MaxDays: 16
          # The number of days to add to the lease following a '/res lease renew' command.
          RenewIncrement: 14
       #Options related to the rent system
       Rent:
           #determines how many residences can be rented by players of this group at once
           MaxRents: 3
           #determines how many residences can be set for rent by players of this group at once
           MaxRentables: 3
       # Options relating to the Residence Economy.
       Economy:
          # Whether or not players in this group can buy other Residences that are for sale.
          CanBuy: true
          # Whether or not players in this group can sell their Residences.
          CanSell: false
          # Whether or not to ignore the Residence size/count limits when buying a residence.
          IgnoreLimits: false
          # The cost, per block, of making a new Residence or adding a area to it.
          BuyCost: 0.05
          # The cost, per block, of renewing a Residence lease (if the lease system is enabled).
          RenewCost: 0.02
       # Flags are checked in the order:
       # 1: Player
       # 2: Group
       # 3: Owner
       # 4: If all others are undefined, reverts to default value (usually true).
       # Flag permissions default to false.
       # These flags settings override the globals.
       Flags:
          # Specifically allow or deny this group from changing certain flags.
          Permission:
               #build: true
          # Specifys the flags that are applied at residence creation for players of this group.
          Default:
              #build: true
          # Specifys the flags that are applied at to the creator at residence creation.
          CreatorDefault:
              #build: true
          # Specifys the flags that are applied to other groups for this residence, at creation.
          GroupDefault:
               #default: #group name
                   #build: false
          #these flags are applied specifically to this group whenever they are outside a residence
          #these flags will override the flags at the top, under the Global section.
          World:
                Global: #these flags will apply to all worlds
                     #build: false
                WorldNameHere: #or you can apply them by each individual world
                     #build: false

# You can manually specify the group a player is in below, this overrides their permissions group.
GroupAssignments:
     bekvon: default
     player: default

ItemList: #this is where you can create blacklists / whitelists
     DefaultList: #list name is not important, as long as it is unique. Its good to use a descripive name. 
        #type of the list, can be blacklist, whitelist, or ignorelist
        Type: blacklist
        #If you want, you can have this list only apply to one world, otherwise it applys to all worlds
        #World: world
        #You can also have the list apply only to one group, otherwise it applys for all groups
        #Group: default
        #this is the actual list of material names that this list allows or dissallows
        #You can look up the material name by item ID in game by typing /res material <id>
        #Alternativly, you can simply use the item ID in the list, but its less descriptive and harder to see what the list allows or dissallows at a glance
        Items: 
           - 'BEDROCK'
           - 'LAVA'
           - 'WATER'
           - 'STATIONARY_LAVA'
           - 'STATIONARY_WATER'
           - 'MOB_SPAWNER'
# Used to determine which major revision of Residence this config is from, dont change this.
ResidenceVersion: 2