跳到正文
本頁目錄

日誌與定時任務

本指南介紹幾乎每個插件都需要的兩件事:向控制台或日誌文件寫消息,以及稍後或定期運行代碼。最後介紹如何不寫插件、直接在控制台中試運行代碼。

示例使用 JavaScript;API 在每種語言中都相同。

輸出到控制台

log 把它的參數依次寫到服務器控制台的同一行:

JavaScript
log("MyPlugin is running!");
log(`Players online: ${mc.getOnlinePlayers().length}`);

插件輸出的每一行都帶有插件的名字:LSE 為每個插件創建一個以插件命名的日誌記錄器,log 和 logger 都通過它輸出。 colorLog(color, ...) 輸出一行彩色文本,fastLog 不等這一行寫完就返回。見腳本輔助 API。

按等級輸出消息

logger 按等級輸出消息,讓警告和錯誤更醒目,並且可以隱藏調試信息:

JavaScript
logger.info("Loaded 12 homes.");
logger.warn("config.json has no 'welcome' setting, using the default.");
logger.error("Could not open the database.");
logger.debug("Home of Steve: 10 64 -3");

等級用數字表示:1 致命錯誤、2 錯誤、3 警告、4 信息、5 調試。高於日誌記錄器等級的消息不會輸出;默認等級為 4, 因此調試信息是隱藏的。開發插件時可以顯示它們:

JavaScript
logger.setLogLevel(5);

同時輸出到文件或玩家

JavaScript
logger.setFile("logs/MyPlugin.log");

會在輸出到控制台的同時,把消息也寫進一個文件。logger.setPlayer(player) 還會把消息作為聊天消息發給遊戲中的一個玩家, 便於在遊戲中測試。logger.setConsole(false) 停止向控制台輸出。這些函數都可以把等級作為可選的第二個參數;這個等級作用於整個日誌記錄器, 而不只是那一個輸出目標。見日誌 API。

稍後運行代碼

setTimeout(func, ms) 在延遲若干毫秒後調用一次函數。它返回任務的 ID:

JavaScript
mc.listen("onJoin", (player) => {
    const xuid = player.xuid;
    setTimeout(() => {
        const pl = mc.getPlayer(xuid);
        if (pl) pl.tell("Type /menu to open the menu.");
    }, 5000);
});

五秒之後,玩家可能已經離開:根據能標識玩家的信息重新獲取玩家,並檢查結果(見 API 的工作方式)。

定期運行代碼

setInterval(func, ms) 每隔 ms 毫秒調用一次函數,直到你用 clearInterval(id) 取消它:

JavaScript
const announcement = setInterval(() => {
    mc.broadcast("Remember to read the rules: /menu");
}, 10 * 60 * 1000);

// 之后要停止它时:
clearInterval(announcement);

插件卸載時,LSE 會取消它的定時任務(QuickJS、Lua 和 Python)。

定時任務有多精確

定時任務在服務器線程上運行,並以 50 毫秒的遊戲刻計時,所以延遲不會短於一個遊戲刻,服務器變慢時還會更長。定時任務適合「五秒後」 或「每十分鐘」,不適合精確的時間點。要在一天中的某個時刻執行任務,算出到那時的延遲再用 setTimeout,而不要在每個遊戲刻檢查時間。 讓這些函數保持簡短:和事件監聽器一樣,它們運行時會拖住服務器。

Node.js 引擎使用 Node.js 自己的 setTimeout 和 setInterval。

在控制台中試運行代碼

QuickJS、Lua 和 Python 引擎在服務器控制台中有調試模式。輸入 jsdebug(QuickJS)、luadebug(Lua)或 pydebug(Python) 並回車:此後你輸入的每一行都會作為該語言的代碼運行並輸出結果,就像瀏覽器的開發者工具控制台一樣。再次輸入同一個命令即可退出。 Node.js 引擎沒有調試模式。

使用 QuickJS 和 Lua 時,還可以直接運行一行代碼:jsdebug mc.getOnlinePlayers().length。誰可以運行這些命令,由引擎配置中的 debugCommandLevel 決定(見插件與引擎)。