跳到正文
本頁目錄

💻 服務端設置 API

下面這些API提供了自定義某些服務器設置的接口

獲取服務器版本號

mc.getBDSVersion()

  • 返回值:服務端版本號字符串,格式形如v1.17.10
  • 返回值類型:String

獲取服務器協議版本

mc.getServerProtocolVersion()

  • 返回值:服務端協議版本
  • 返回值類型:Number

獲取服務器MOTD字符串

Warning

此函數僅在0.19.1及以後版本可用

mc.getMotd()

  • 返回值:當前服務器MOTD字符串
  • 返回值類型:String

設置服務器MOTD字符串

mc.setMotd(motd)

  • 參數:
  • motd : String
    目標MOTD字符串
  • 返回值:是否設置成功
  • 返回值類型:Boolean

設置服務器最大玩家數

mc.setMaxPlayers(num)

  • 參數:
  • num : Number
    最大玩家數
  • 返回值:是否設置成功
  • 返回值類型:Boolean

獲取在線玩家數量

Warning

此函數僅在0.19.1及以後版本可用

mc.getOnlinePlayerNum([ignoreSimulatedPlayer])

  • 參數:
  • ignoreSimulatedPlayer : Boolean = false
    是否忽略模擬玩家
  • 返回值:當前在線玩家數量
  • 返回值類型:Number

獲取服務器最大玩家數

Warning

此函數僅在0.19.1及以後版本可用

mc.getMaxNumPlayers()

  • 返回值:當前服務器最大玩家數
  • 返回值類型:Number

獲取服務器遊戲時間

mc.getTime(TimeID)

  • 參數:
  • TimeID : Integer
    想要查詢的時間 (0 代表daytime,1 代表gametime,2 代表day)
  • 返回值:獲取到的時間
  • 返回值類型:Integer

其中,daytime 代表自當天日出後流逝的遊戲刻數,gametime 代表世界總共流逝的遊戲刻數,day 代表已流逝的遊戲天數。

設置服務器遊戲時間

mc.setTime(tick)

  • 參數:
  • tick : Integer
    想要設置的時間
  • 返回值:是否設置成功
  • 返回值類型:Boolean

獲取服務器天氣

mc.getWeather()

  • 返回值:當前天氣 (0 代表晴天,1 代表雨天,2 代表雷暴)
  • 返回值類型:Integer

設置服務器天氣

mc.setWeather(WeatherID)

  • 參數:
  • WeatherID : Integer
    想要設置的天氣 (0 代表晴天,1 代表雨天,2 代表雷暴)
  • 返回值:是否設置成功
  • 返回值類型:Boolean

獲取維度ID

Warning

此函數僅在0.19.1及以後版本可用

mc.getDimensionId(name)

  • 參數:
  • name : String
    維度名稱
  • 返回值:對應維度名稱的維度ID,若維度名稱無效則返回null
  • 返回值類型:Number

獲取維度名稱

Warning

此函數僅在0.19.1及以後版本可用

mc.getDimensionName(dimid)

  • 參數:
  • dimid : Integer
    維度ID
  • 返回值:對應維度ID的維度名稱,若維度ID無效則返回null
  • 返回值類型:String