CompanionsPlusApi

java.lang.Object

cn.handyplus.companions.api.CompanionsPlusApi

public class CompanionsPlusApi extends Object

精灵 API, 供外部插件通过代码调用精灵相关功能。

从以下版本开始:: 3.0.0

构造器概要

构造器

构造器

说明

CompanionsPlusApi()
方法概要

修饰符和类型

方法

说明

int

giveCompanion(@NotNull org.bukkit.entity.Player player, @NotNull String companionKey)

给予玩家指定精灵, 写入数据库但不自动切换为使用中。

int

giveCompanion(@NotNull org.bukkit.entity.Player player, @NotNull String companionKey, boolean setActive)

给予玩家指定精灵, 写入数据库并可选立即切换为使用中。

从类继承的方法 Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料
- CompanionsPlusApi
  
  public CompanionsPlusApi()
方法详细资料
- giveCompanion
  
  public int giveCompanion(@NotNull @NotNull org.bukkit.entity.Player player, @NotNull @NotNull String companionKey)
  
  给予玩家指定精灵, 写入数据库但不自动切换为使用中。
  
  参数:
  
  player - 玩家
  
  companionKey - 精灵种类 KEY
  
  返回:
  
  新增精灵实例 ID; 仓库已满、精灵配置不存在或入库失败时返回 -1
- giveCompanion
  
  public int giveCompanion(@NotNull @NotNull org.bukkit.entity.Player player, @NotNull @NotNull String companionKey, boolean setActive)
  
  给予玩家指定精灵, 写入数据库并可选立即切换为使用中。
  
  参数:
  
  player - 玩家
  
  companionKey - 精灵种类 KEY
  
  setActive - 是否立即设为使用中
  
  返回:
  
  新增精灵实例 ID; 仓库已满、精灵配置不存在或入库失败时返回 -1