scratch-dsl/org.scratchapi.scratchdsl/StageBuilder

StageBuilder

class StageBuilder : HatBlockHost

Properties

backdrops

val backdrops: List<Backdrop>

Functions

addBackdrop

fun addBackdrop(path: Path, name: String): Backdrop

Adds a backdrop from a local file.

fun addBackdrop(name: String, dataFormat: String, assetId: String, rotationCenter: Pair<Double, Double>? = null, bitmapResolution: Int = 1, path: Path? = null): Backdrop

Adds a backdrop to the stage.

addHatBlock

open override fun <B : HatBlock> addHatBlock(hatBlock: B): B

Adds a hat block to this host.

addSound

fun addSound(path: Path, name: String): Sound

Adds a sound from a local file to the stage.

fun addSound(name: String, dataFormat: String, assetId: String, rate: Int? = null, sampleCount: Int? = null, path: Path? = null): Sound

Adds a sound to the stage.

impl

open fun ProcedurePrototypeBuilder.impl(block: BlockHost.() -> Unit): Procedure

Implements the logic for a custom block procedure.

isolated

fun HatBlockHost.isolated(block: BlockHost.() -> Unit): HatBlock

Creates an isolated stack of blocks that is not attached to any hat block.

makeBroadcast

fun makeBroadcast(name: String = IdGenerator.makeRandomId(6)): Broadcast

Creates a global broadcast message (scoped to the stage).

makeList

fun makeList(name: String = IdGenerator.makeRandomId(6), block: JsonArrayBuilder.() -> Unit): ScratchList

Creates a global list with a builder (scoped to the stage).

fun makeList(name: String = IdGenerator.makeRandomId(6), value: JsonArray): ScratchList

Creates a global list (scoped to the stage).

makeVar

fun makeVar(name: String = IdGenerator.makeRandomId(6), value: JsonPrimitive = JsonPrimitive(""), cloud: Boolean = false): Variable

Creates a global variable (scoped to the stage).

procedure

fun HatBlockHost.procedure(name: String, warp: Boolean = false, block: ProcedurePrototypeBuilder.() -> Unit): Lazy<Procedure>

Defines a custom block procedure.

whenBackdropSwitchesTo

fun HatBlockHost.whenBackdropSwitchesTo(backdrop: Costume, block: BlockHost.() -> Unit): NormalHatBlock

Creates a 'when backdrop switches to' hat block.

whenClicked

fun HatBlockHost.whenClicked(block: BlockHost.() -> Unit): NormalHatBlock

Creates a 'when this sprite clicked' hat block.

whenGreaterThan

fun HatBlockHost.whenGreaterThan(compared: WhenGreaterThanComparedValue, value: Expression?, block: BlockHost.() -> Unit): NormalHatBlock

Creates a 'when loudness >' or 'when timer >' hat block.

whenGreenFlagClicked

fun HatBlockHost.whenGreenFlagClicked(block: BlockHost.() -> Unit): HatBlock

Creates a 'when green flag clicked' hat block.

whenIReceive

fun HatBlockHost.whenIReceive(broadcast: Broadcast, block: BlockHost.() -> Unit): NormalHatBlock

Creates a 'when I receive' hat block.

whenIStartAsClone

fun HatBlockHost.whenIStartAsClone(block: BlockHost.() -> Unit): HatBlock

Creates a 'when I start as a clone' hat block.

whenKeyPressed

fun HatBlockHost.whenKeyPressed(key: AnyKeyboardKey, block: BlockHost.() -> Unit): NormalHatBlock

Creates a 'when key pressed' hat block.