类 System实验性

只读 实验性afterEvents

只读 实验性beforeEvents

只读 实验性currentTick

只读 实验性isEditorWorld

只读 实验性serverSystemInfo

clearJob

• clearJob(jobId: number): void
• 实验性

  参数

  • jobId: number

    The job ID returned from System.runJob.

  返回 void

  备注

  Cancels the execution of a job queued via System.runJob.

  This function can be called in early-execution mode.

clearRun

• clearRun(runId: number): void
• 实验性

  参数

  • runId: number

  返回 void

  备注

  Cancels the execution of a function run that was previously scheduled via System.run.

  This function can be called in early-execution mode.

run

• run(callback: () => void): number
• 实验性

  参数

  • callback: () => void

    Function callback to run at the next game tick.

  返回 number

  An opaque identifier that can be used with the clearRun function to cancel the execution of this run.

  备注

  Runs a specified function at the next available future time. This is frequently used to implement delayed behaviors and game loops. When run within the context of an event handler, this will generally run the code at the end of the same tick where the event occurred. When run in other code (a system.run callout), this will run the function in the next tick. Note, however, that depending on load on the system, running in the same or next tick is not guaranteed.

  This function can be called in early-execution mode.

  示例: trapTick.ts

  import { world, system } from "@minecraft/server";
  
  function trapTick() {
    try {
      // Minecraft runs at 20 ticks per second.
      if (system.currentTick % 1200 === 0) {
        world.sendMessage("Another minute passes...");
      }
    } catch (e) {
      console.warn("Error: " + e);
    }
  
    system.run(trapTick);
  }
  复制

runInterval

• runInterval(callback: () => void, tickInterval?: number): number
• 实验性

  参数

  • callback: () => void

    Functional code that will run when this interval occurs.
  • 可选tickInterval: number

    An interval of every N ticks that the callback will be called upon.

  返回 number

  An opaque handle that can be used with the clearRun method to stop the run of this function on an interval.

  备注

  Runs a set of code on an interval.

  This function can be called in early-execution mode.

  示例: every30Seconds.ts

  import { world, system, DimensionLocation } from "@minecraft/server";
  
  function every30Seconds(targetLocation: DimensionLocation) {
    const intervalRunIdentifier = Math.floor(Math.random() * 10000);
  
    system.runInterval(() => {
      world.sendMessage("This is an interval run " + intervalRunIdentifier + " sending a message every 30 seconds.");
    }, 600);
  }
  复制

runJob

• runJob(generator: Generator<void, void, void>): number
• 实验性

  参数

  • generator: Generator<void, void, void>

    The instance of the generator to run.

  返回 number

  An opaque handle that can be used with System.clearJob to stop the run of this generator.

  备注

  Queues a generator to run until completion. The generator will be given a time slice each tick, and will be run until it yields or completes.

  This function can be called in early-execution mode.

  示例: cubeGenerator.ts

  import { system, BlockPermutation, DimensionLocation } from "@minecraft/server";
  
  function cubeGenerator(targetLocation: DimensionLocation) {
    const blockPerm = BlockPermutation.resolve("minecraft:cobblestone");
  
    system.runJob(blockPlacingGenerator(blockPerm, targetLocation, 15));
  }
  
  function* blockPlacingGenerator(blockPerm: BlockPermutation, startingLocation: DimensionLocation, size: number) {
    for (let x = startingLocation.x; x < startingLocation.x + size; x++) {
      for (let y = startingLocation.y; y < startingLocation.y + size; y++) {
        for (let z = startingLocation.z; z < startingLocation.z + size; z++) {
          const block = startingLocation.dimension.getBlock({ x: x, y: y, z: z });
          if (block) {
            block.setPermutation(blockPerm);
          }
          yield;
        }
      }
    }
  }
  复制

runTimeout

• runTimeout(callback: () => void, tickDelay?: number): number
• 实验性

  参数

  • callback: () => void

    Functional code that will run when this timeout occurs.
  • 可选tickDelay: number

    Amount of time, in ticks, before the interval will be called.

  返回 number

  An opaque handle that can be used with the clearRun method to stop the run of this function on an interval.

  备注

  Runs a set of code at a future time specified by tickDelay.

  This function can be called in early-execution mode.

sendScriptEvent

• sendScriptEvent(id: string, message: string): void
• 预览版 实验性

  参数

  • id: string

    Identifier of the message to send. This is custom and dependent on the kinds of behavior packs and content you may have installed within the world.
  • message: string

    Data component of the message to send. This is custom and dependent on the kinds of behavior packs and content you may have installed within the world. Message may not exceed 2048 characters in length.

  返回 void

  备注

  Causes an event to fire within script with the specified message ID and payload.

  无法在只读模式下调用此函数，详见 WorldBeforeEvents。

  抛出

  This function can throw errors.

  minecraftcommon.EngineError

  minecraftcommon.InvalidArgumentError

  NamespaceNameError

waitTicks

• waitTicks(ticks: number): Promise<void>
• 实验性

  参数

  • ticks: number

    The amount of ticks to wait. Minimum value is 1.

  返回 Promise<void>

  A promise that is resolved when the specified amount of ticks have occurred.

  备注

  waitTicks returns a promise that resolves after the requested number of ticks.

  This function can be called in early-execution mode.

  抛出

  This function can throw errors.

  minecraftcommon.EngineError