类 PlayerTitleApi

java.lang.Object
cn.handyplus.title.api.PlayerTitleApi
public final class PlayerTitleApi extends Object
PlayerTitleApi
从以下版本开始:
5.0.0

  • 构造器详细资料

    • PlayerTitleApi

      public PlayerTitleApi()

  • 方法详细资料

    • addTitle

      public static Integer addTitle(@NotNull @NotNull TitleListParam titleListParam)
      新增称号
      参数:
      titleListParam - 入参
      返回:
      称号唯一编号id，请保存好

    • addBuffType

      public static boolean addBuffType(@NotNull @NotNull String buffType, @NotNull @NotNull String buffTypeName, @NotNull @NotNull String pluginName)
      新增称号Buff类型
      参数:
      buffType - buff类型
      buffTypeName - buff类型名称
      pluginName - 注册插件名称
      返回:
      true/成功

    • existTitleId

      public static boolean existTitleId(@NotNull @NotNull Integer titleId)
      查询称号是否存在
      参数:
      titleId - 称号唯一编号id
      返回:
      true/存在

    • findTitleById

      public static Optional<TitleList> findTitleById(@NotNull @NotNull Integer titleId)
      查询称号信息
      参数:
      titleId - 称号唯一编号id
      返回:
      称号信息包含buff和粒子

    • removeTitle

      public static boolean removeTitle(@NotNull @NotNull Integer titleId)
      删除称号
      参数:
      titleId - 称号id
      返回:
      true/成功
      从以下版本开始:
      2.10.1

    • addTitleBuff

      public static boolean addTitleBuff(@NotNull @NotNull Integer titleId, @NotNull @NotNull List<TitleBuffParam> titleBuffs)
      添加称号buff
      参数:
      titleId - 称号id
      titleBuffs - 称号buff
      返回:
      true/成功

    • removeTitleBuff

      public static boolean removeTitleBuff(@NotNull @NotNull Integer titleId)
      删除称号buff
      参数:
      titleId - 称号id
      返回:
      true/成功

    • addTitleParticle

      public static boolean addTitleParticle(@NotNull @NotNull Integer titleId, @NotNull @NotNull TitleParticleParam titleParticleParam)
      添加称号粒子
      参数:
      titleId - 称号id
      titleParticleParam - 称号粒子
      返回:
      true/成功

    • removeTitleParticle

      public static boolean removeTitleParticle(@NotNull @NotNull Integer titleId)
      删除称号粒子
      参数:
      titleId - 称号id
      返回:
      true/成功

    • updateTitleName

      public static boolean updateTitleName(@NotNull @NotNull Integer titleId, @NotNull @NotNull String titleName, boolean isPrefixAndSuffix)
      更改名称
      参数:
      titleId - 称号id
      titleName - 称号名称
      isPrefixAndSuffix - 是否使用默认前后缀
      返回:
      true/成功

    • updateTitleDesc

      public static boolean updateTitleDesc(@NotNull @NotNull Integer titleId, String description)
      更改描述
      参数:
      titleId - 称号id
      description - 描述
      返回:
      true/成功

    • setPlayerTitle

      public static boolean setPlayerTitle(@NotNull @NotNull UUID playerUuid, @NotNull @NotNull Integer titleId, int day)
      给玩家称号
      参数:
      playerUuid - 玩家uid
      titleId - 称号编码
      day - 时间，0为永久
      返回:
      true/成功

    • setPlayerTitle

      public static boolean setPlayerTitle(@NotNull @NotNull UUID playerUuid, @NotNull @NotNull Integer titleId)
      给玩家称号
      参数:
      playerUuid - 玩家uid
      titleId - 称号编码
      返回:
      true/成功

    • setPlayerTitle

      public static boolean setPlayerTitle(String playerName, @NotNull @NotNull UUID playerUuid, @NotNull @NotNull Integer titleId, int day)
      给玩家称号
      参数:
      playerName - 玩家名
      playerUuid - 玩家uid
      titleId - 称号编码
      day - 时间，0为永久
      返回:
      true/成功

    • removePlayerTitle

      public static boolean removePlayerTitle(@NotNull @NotNull UUID playerUuid, @NotNull @NotNull Integer titleId)
      根据titleId和玩家Uid删除 玩家对应称号
      参数:
      playerUuid - 玩家Uid
      titleId - 称号id
      返回:
      true成功

    • findPlayerShowTitle

      public static Optional<TitlePlayer> findPlayerShowTitle(@NotNull @NotNull UUID playerUuid)
      获取玩家正在使用的展示称号信息
      参数:
      playerUuid - 玩家uid
      返回:
      展示称号

    • findPlayerBuffTitle

      public static Optional<TitlePlayer> findPlayerBuffTitle(@NotNull @NotNull UUID playerUuid)
      获取玩家正在使用的属性称号信息
      参数:
      playerUuid - 玩家uid
      返回:
      属性称号

    • findPlayerParticleTitle

      public static Optional<TitlePlayer> findPlayerParticleTitle(@NotNull @NotNull UUID playerUuid)
      获取玩家正在使用的粒子称号信息
      参数:
      playerUuid - 玩家uid
      返回:
      粒子称号

    • lookCoin

      public static Integer lookCoin(@NotNull @NotNull UUID playerUuid)
      获取玩家称号币
      参数:
      playerUuid - 玩家uid
      返回:
      称号币

    • giveCoin

      public static boolean giveCoin(@NotNull @NotNull UUID playerUuid, @NotNull @NotNull Integer amount)
      增加玩家称号币
      参数:
      playerUuid - 玩家uid
      amount - 数量
      返回:
      true/成功

    • takeCoin

      public static boolean takeCoin(@NotNull @NotNull UUID playerUuid, @NotNull @NotNull Integer amount)
      减少玩家称号币
      参数:
      playerUuid - 玩家uid
      amount - 数量
      返回:
      true/成功

    • setCoin

      public static boolean setCoin(@NotNull @NotNull UUID playerUuid, @NotNull @NotNull Integer amount)
      设置玩家称号币
      参数:
      playerUuid - 玩家uid
      amount - 数量
      返回:
      true/成功

    • getPlayerTitleNum

      public static Integer getPlayerTitleNum(@NotNull @NotNull UUID playerUuid)
      获取玩家称号数量
      参数:
      playerUuid - 玩家Uid
      返回:
      称号数量

    • removePlayerBuff

      public static void removePlayerBuff(@NotNull @NotNull org.bukkit.entity.Player player)
      移除buff
      参数:
      player - 玩家

    • setPlayerBuff

      public static void setPlayerBuff(@NotNull @NotNull org.bukkit.entity.Player player)
      设置buff
      参数:
      player - 玩家

    • playerExistTitleId

      public static boolean playerExistTitleId(@NotNull @NotNull UUID playerUuid, @NotNull @NotNull Integer titleId)
      玩家是否有对应的称号ID
      参数:
      playerUuid - 玩家Uid
      titleId - 称号id
      返回:
      true 有, false 无

    • findAllTitleIdByPlayer

      public static List<Integer> findAllTitleIdByPlayer(@NotNull @NotNull UUID playerUuid)
      获取玩家所有称号ID
      参数:
      playerUuid - 玩家uid
      返回:
      所有称号ID

    • findPlayerTitle

      public static List<TitlePlayer> findPlayerTitle(@NotNull @NotNull UUID playerUuid)
      获取玩家所有称号
      参数:
      playerUuid - 玩家uid
      返回:
      所有称号

    • findShopTitle

      public static List<TitleList> findShopTitle(@Nullable @Nullable UUID playerUuid)
      获取商店所有称号
      返回:
      所有称号

    • playerUseTitle

      public static void playerUseTitle(@NotNull @NotNull UUID playerUuid, @NotNull @NotNull Integer titlePlayerId)
      玩家使用称号
      参数:
      playerUuid - 玩家uid
      titlePlayerId - 玩家称号ID