@pumpkin-plugins/plugin-kit API / host / scheduleRepeating

Function: scheduleRepeating()

scheduleRepeating(periodTicks, run): number

Defined in: tools/plugin-kit/src/host.ts:35

Runs a function every periodTicks game ticks, starting after the same delay.

Parameters

periodTicks

number

Ticks between runs.

run

(server) => void

The function to run.

Returns

number

The scheduler's task id, for cancelTask.