模块 linlang.api
程序包 api.linlang.runtime

接口 Linlang

public interface Linlang
单个插件使用的 Linlang 服务门面。

通过该门面取得命令、文件、消息和界面服务。门面及其子服务的生命周期通常与插件一致。

  • 嵌套类概要

    嵌套类
    修饰符和类型
    接口
    说明
    static final class 
    Linlang.Parameters
    琳琅服务的「运行参数」设置项（需要重建琳琅）
    static final class 
    Linlang.Settings
    琳琅服务的「个性化」设置项

  • 方法概要

    修饰符和类型
    方法
    说明
    default void
    close()
    安全关闭该插件门面持有的服务。
    LinCommand
    linCommand()
    琳琅的命令服务
    LinFile
    linFile()
    琳琅的文件服务，包含配置文件、语言文件与数据库（H2 与 MySQL）
    LinMessenger
    linMessenger()
    琳琅的信息服务，可以方便地向任何位置（玩家或控制台）发送聊天框、动作栏、标题消息
    LinView
    linView()
    琳琅的界面服务
    default Linlang.Parameters
    parameters()
    更改琳琅服务的系统参数
    default void
    reload()
    重新载入琳琅服务
    default void
    restart()
    重建琳琅服务
    default Linlang.Settings
    settings()
    设置琳琅服务的个性化设置

  • 方法详细资料

    • linMessenger

      LinMessenger linMessenger()

      琳琅的信息服务，可以方便地向任何位置（玩家或控制台）发送聊天框、动作栏、标题消息

      对于控制台，消息统一降级至聊天框

      返回:
      可用的 LinMessenger 实例

    • linFile

      LinFile linFile()

      琳琅的文件服务，包含配置文件、语言文件与数据库（H2 与 MySQL）

      返回:
      琳琅文件服务类

    • linCommand

      LinCommand linCommand()

      琳琅的命令服务

      返回:
      可用的 LinCommand 实例

    • linView

      LinView linView()

      琳琅的界面服务

      返回:
      可用的 LinView 实例

    • close

      default void close()
      安全关闭该插件门面持有的服务。

      应在插件卸载时调用。

    • settings

      default Linlang.Settings settings()
      设置琳琅服务的个性化设置

      例如琳琅服务消息前缀等。调用 Linlang.Settings.apply() 将热应用修改

      返回:
      个性化设置构建器
      抛出:
      IllegalStateException - 当前运行时不支持动态设置时

    • parameters

      default Linlang.Parameters parameters()
      更改琳琅服务的系统参数

      例如平台上下文、启动语言等。调用 Linlang.Parameters.apply() 后将触发一次重建

      返回:
      运行参数构建器
      抛出:
      IllegalStateException - 当前运行时不支持参数重建时

    • reload

      default void reload()
      重新载入琳琅服务

    • restart

      default void restart()
      重建琳琅服务

      这将导致整个琳琅服务被重新构建，一些正在进行中的任务可能被中断。