类 GameTestSequence实验性

Executes a set of steps defined via chained .thenXyz methods, sequentially. This facilitates a 'script' of GameTest setup methods and assertions over time.

方法

thenExecute thenExecuteAfter thenExecuteFor thenFail thenIdle thenSucceed thenWait thenWaitAfter

方法

thenExecute

  • thenExecute(callback: () => void): GameTestSequence
  • 实验性

    参数

    • callback: () => void

      Callback function to execute.

    返回 GameTestSequence

    Returns a GameTestSequence object where additional .thenXyz method steps can be added.

    备注

    Runs the given callback as a step within a GameTest sequence. Exceptions thrown within the callback will end sequence execution.

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

thenExecuteAfter

  • thenExecuteAfter(delayTicks: number, callback: () => void): GameTestSequence
  • 实验性

    参数

    • delayTicks: number

      Number of ticks to wait before executing the callback.

    • callback: () => void

      Callback function to execute.

    返回 GameTestSequence

    Returns a GameTestSequence object where additional .thenXyz method steps can be added.

    备注

    After a delay, runs the given callback as a step within a GameTest sequence. Exceptions thrown within the callback will end sequence execution.

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

thenExecuteFor

  • thenExecuteFor(tickCount: number, callback: () => void): GameTestSequence
  • 实验性

    参数

    • tickCount: number
    • callback: () => void

      Callback function to execute.

    返回 GameTestSequence

    Returns a GameTestSequence object where additional .thenXyz method steps can be added.

    备注

    Runs the given callback every tick for the given number of ticks.

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

thenFail

  • thenFail(errorMessage: string): void
  • 实验性

    参数

    • errorMessage: string

      Error message summarizing the failure condition.

    返回 void

    备注

    Causes the test to fail if this step in the GameTest sequence is reached.

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

thenIdle

  • thenIdle(delayTicks: number): GameTestSequence
  • 实验性

    参数

    • delayTicks: number

      Number of ticks to delay for this step in the GameTest sequence.

    返回 GameTestSequence

    Returns a GameTestSequence object where additional .thenXyz method steps can be added.

    备注

    Idles the GameTest sequence for the specified delayTicks.

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

thenSucceed

  • thenSucceed(): void
  • 实验性

    返回 void

    备注

    Marks the GameTest a success if this step is reached in the GameTest sequence.

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

thenWait

  • thenWait(callback: () => void): GameTestSequence
  • 实验性

    参数

    • callback: () => void

      Testing callback function to execute. Typically, this function will have .assertXyz functions within it.

    返回 GameTestSequence

    Returns a GameTestSequence object where additional .thenXyz method steps can be added.

    备注

    Executes the given callback every tick until it succeeds. Exceptions thrown within the callback will end sequence execution.

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

thenWaitAfter

  • thenWaitAfter(delayTicks: number, callback: () => void): GameTestSequence
  • 实验性

    参数

    • delayTicks: number

      Tick (after the previous step in the GameTest sequence) to run the callback at.

    • callback: () => void

      Testing callback function to execute. Typically, this function will have .assertXyz functions within it.

    返回 GameTestSequence

    Returns a GameTestSequence object where additional .thenXyz method steps can be added.

    备注

    After a delay from the previous step, executes the given callback every tick until it succeeds. Exceptions thrown within the callback will end sequence execution.

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

显示设置

成员可见性

目录

方法