Package cn.lunadeer.dominion.api.dtos

Interface DominionDTO

public interface DominionDTO

  • Method Details

    • getId

      @NotNull @NotNull Integer getId()
      获取领地 ID
      Returns:
      领地 ID

    • getOwner

      @NotNull @NotNull UUID getOwner()
      获取领地所有者 UUID
      Returns:
      领地所有者 UUID

    • getOwnerDTO

      @NotNull @NotNull PlayerDTO getOwnerDTO()
      获取领地所有者 DTO
      Returns:
      领地所有者 DTO

    • setOwner

      @Nullable @Nullable DominionDTO setOwner(UUID owner)
      设置领地所有者，设置成功后返回领地对象，设置失败返回null
      Parameters:
      owner - 领地所有者 UUID
      Returns:
      领地对象

    • setOwner

      @Nullable @Nullable DominionDTO setOwner(org.bukkit.entity.Player owner)
      设置领地所有者，设置成功后返回领地对象，设置失败返回null
      Parameters:
      owner - 领地所有者
      Returns:
      领地对象

    • getName

      @NotNull @NotNull String getName()
      获取领地名称
      Returns:
      领地名称

    • setName

      @Nullable @Nullable DominionDTO setName(String name)
      设置领地名称，设置成功后返回领地对象，设置失败返回null
      Parameters:
      name - 领地名称
      Returns:
      领地对象

    • getWorld

      @Nullable @Nullable org.bukkit.World getWorld()
      获取领地所在世界，如果世界不存在，则返回null
      Returns:
      领地所在世界

    • getWorldUid

      @NotNull @NotNull UUID getWorldUid()
      获取领地所在世界 UUID，该接口返回的 UUID 一定不为 null，但是不保证世界一定存在。 如果需要判断世界是否存在，请使用 getWorld() 方法。
      Returns:
      领地所在世界 UUID

    • getX1

      @NotNull @NotNull Integer getX1()
      获取领地角点坐标1（小角点）的X坐标，X1 < X2
      Returns:
      领地角点坐标1（小角点）的X坐标

    • getY1

      @NotNull @NotNull Integer getY1()
      获取领地角点坐标1（小角点）的Y坐标，Y1 < Y2
      Returns:
      领地角点坐标1（小角点）的Y坐标

    • getZ1

      @NotNull @NotNull Integer getZ1()
      获取领地角点坐标1（小角点）的Z坐标，Z1 < Z2
      Returns:
      领地角点坐标1（小角点）的Z坐标

    • getX2

      @NotNull @NotNull Integer getX2()
      获取领地角点坐标2（大角点）的X坐标，X2 > X1
      Returns:
      领地角点坐标2（大角点）的X坐标

    • getY2

      @NotNull @NotNull Integer getY2()
      获取领地角点坐标2（大角点）的Y坐标，Y2 > Y1
      Returns:
      领地角点坐标2（大角点）的Y坐标

    • getZ2

      @NotNull @NotNull Integer getZ2()
      获取领地角点坐标2（大角点）的Z坐标，Z2 > Z1
      Returns:
      领地角点坐标2（大角点）的Z坐标

    • setXYZ

      @Nullable @Nullable DominionDTO setXYZ(Integer x1, Integer y1, Integer z1, Integer x2, Integer y2, Integer z2)
      设置领地角点坐标，设置成功后返回领地对象，设置失败返回null
      Parameters:
      x1 - 小角点X坐标
      y1 - 小角点Y坐标
      z1 - 小角点Z坐标
      x2 - 大角点X坐标
      y2 - 大角点Y坐标
      z2 - 大角点Z坐标
      Returns:
      领地对象

    • setXYZ

      @Nullable @Nullable DominionDTO setXYZ(int[] cords)
      设置领地角点坐标，设置成功后返回领地对象，设置失败返回null
      Parameters:
      cords - 领地角点坐标数组，长度为6，依次为 x1, y1, z1, x2, y2, z2
      Returns:
      领地对象

    • getSquare

      @NotNull @NotNull Integer getSquare()
      获取领地面积
      Returns:
      领地面积

    • getVolume

      @NotNull @NotNull Integer getVolume()
      获取领地体积
      Returns:
      领地体积

    • getWidthX

      @NotNull @NotNull Integer getWidthX()
      获取领地X轴向（东西向）宽度
      Returns:
      领地X轴向（东西向）宽度

    • getHeight

      @NotNull @NotNull Integer getHeight()
      获取领地Y轴向（上下向）高度
      Returns:
      领地Y轴向（上下向）高度

    • getWidthZ

      @NotNull @NotNull Integer getWidthZ()
      获取领地Z轴向（南北向）宽度
      Returns:
      领地Z轴向（南北向）宽度

    • getParentDomId

      @NotNull @NotNull Integer getParentDomId()
      获取父领地 ID
      Returns:
      父领地 ID 如果没有父领地，则返回 -1

    • getJoinMessage

      @NotNull @NotNull String getJoinMessage()
      获取领地欢迎提示语
      Returns:
      领地欢迎提示语

    • setJoinMessage

      @Nullable @Nullable DominionDTO setJoinMessage(String joinMessage)
      设置领地欢迎提示语，设置成功后返回领地对象，设置失败返回null
      Parameters:
      joinMessage - 领地欢迎提示语
      Returns:
      领地对象

    • getLeaveMessage

      @NotNull @NotNull String getLeaveMessage()
      获取领地离开提示语
      Returns:
      领地离开提示语

    • setLeaveMessage

      @Nullable @Nullable DominionDTO setLeaveMessage(String leaveMessage)
      设置领地离开提示语，设置成功后返回领地对象，设置失败返回null
      Parameters:
      leaveMessage - 领地离开提示语
      Returns:
      领地对象

    • getEnvironmentFlagValue

      @NotNull @NotNull Map<EnvFlag,Boolean> getEnvironmentFlagValue()
      获取领地所有环境配置
      Returns:
      领地环境权限配置

    • getEnvFlagValue

      boolean getEnvFlagValue(@NotNull @NotNull EnvFlag flag)
      获取领地某个环境配置的值
      Parameters:
      flag - 权限
      Returns:
      权限值

    • getGuestPrivilegeFlagValue

      @NotNull @NotNull Map<PreFlag,Boolean> getGuestPrivilegeFlagValue()
      获取领地访客所有权限配置
      Returns:
      领地访客权限配置

    • getGuestFlagValue

      boolean getGuestFlagValue(@NotNull @NotNull PreFlag flag)
      获取领地某个访客权限的值
      Parameters:
      flag - 权限
      Returns:
      权限值

    • setEnvFlagValue

      @Nullable @Nullable DominionDTO setEnvFlagValue(@NotNull @NotNull EnvFlag flag, @NotNull @NotNull Boolean value)
      设置领地某个环境配置或访客权限的值，设置成功后返回领地对象，设置失败返回null
      Parameters:
      flag - 权限
      value - 权限值
      Returns:
      领地对象

    • setGuestFlagValue

      @Nullable @Nullable DominionDTO setGuestFlagValue(@NotNull @NotNull PreFlag flag, @NotNull @NotNull Boolean value)
      设置领地某个环境配置或访客权限的值，设置成功后返回领地对象，设置失败返回null
      Parameters:
      flag - 权限
      value - 权限值
      Returns:
      领地对象

    • getTpLocation

      @Nullable @Nullable org.bukkit.Location getTpLocation()
      获取领地传送点坐标
      Returns:
      领地传送点坐标 如果没有设置传送点，则返回null

    • setTpLocation

      @Nullable @Nullable DominionDTO setTpLocation(org.bukkit.Location tpLocation)
      设置领地传送点坐标，设置成功后返回领地对象，设置失败返回null
      Parameters:
      tpLocation - 领地传送点坐标
      Returns:
      领地对象

    • getLocation1

      @NotNull @NotNull org.bukkit.Location getLocation1()
      领地角点坐标1，小角点（小角点的xyz小于大角点的xyz）
      Returns:
      领地角点坐标1

    • getLocation2

      @NotNull @NotNull org.bukkit.Location getLocation2()
      领地角点坐标2，大角点（大角点的xyz大于小角点的xyz）
      Returns:
      领地角点坐标2

    • getColorR

      int getColorR()

    • getColorG

      int getColorG()

    • getColorB

      int getColorB()

    • getColor

      @NotNull @NotNull String getColor()

    • getColorHex

      int getColorHex()

    • setColor

      @Nullable @Nullable DominionDTO setColor(@NotNull @NotNull org.bukkit.Color color)
      设置领地颜色，设置成功后返回领地对象，设置失败返回null
      Parameters:
      color - 颜色
      Returns:
      领地对象

    • getGroups

      List<GroupDTO> getGroups()
      获取领地的所有权限组
      Returns:
      权限组列表

    • getMembers

      List<MemberDTO> getMembers()
      获取领地的所有成员
      Returns:
      成员列表