PlayTime
The session’s time.
Methods
Section titled “Methods”frames()
Section titled “frames()”frames(
count?):Promise<void>
Waits for the page to draw count frames, 1 by default: a held
world draws them without a step.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
count? |
number |
Returns
Section titled “Returns”Promise<void>
sample()
Section titled “sample()”sample<
Value>(read,request):Promise<FrameSample<Value>[]>
Reads read on each frame the page draws while the session runs
steps or seconds, a room at real time, and answers each frame’s value.
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
Value |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
read |
(scope) => Value |
request |
Pick<PlayStepRequest, "steps" | "seconds"> |
Returns
Section titled “Returns”Promise<FrameSample<Value>[]>
step()
Section titled “step()”step(
request):Promise<PlayStepReading>
Steps the session, as spawnite play step does, and says where it
stopped.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
request |
PlayStepRequest |
Returns
Section titled “Returns”Promise<PlayStepReading>