@occultus/core - v2.0.0-beta.4
    Preparing search index...

    Class ModInitializer

    一个初始化 Occultus SDK 模组环境的类

    const modInstance = ModInitializer.initialize(
    "occultus-test-mod",
    "Occultus SDK Test Mod",
    "1.14.514",
    (event: StartupEvent) => {
    console.log("[Test Mod] 模组初始化完成!");
    }
    );
    console.log("模组ID:", modInstance.getModId());
    modInstance.setModName("Updated Test Mod Name");
    Index

    Methods

    • 获取模组的 ID

      Returns string

      模组的 ID

    • 获取模组的名称

      Returns string

      模组的名称

    • 获取模组版本

      Returns string

      要获取的模组版本

    • 设置模组的名称

      Parameters

      • name: string

        要设置的模组名称

      Returns void

    • 设置模组版本

      Parameters

      • version: string

        要设置的模组版本

      Returns void

    • 获取当前的初始化器实例

      Returns ModInitializer

      当前的初始化器实例

      如果没有初始化器实例,会抛出错误

    • 为 Occultus SDK 初始化该脚本环境

      Parameters

      • id: string

        该模组的 ID

      • name: string

        该模组的名称

      • version: string

        该模组的版本号

      • OptionalonInitialize: (arg: StartupEvent) => void

        当脚本环境初始化后触发的事件

      Returns ModInitializer

      如果传入了非法的 ID 或版本号,或者重复声明会抛出错误