Events functions

Free functions you can call directly in sprite code.

broadcast

broadcast(message: string): void

Send a broadcast message to all sprites without waiting.

See also Sprite.broadcast

broadcastAndWait

broadcastAndWait(message: string): void

Send a broadcast message and wait until all receiving scripts finish.

⏸️ This pauses your script until it finishes — the next line runs only after it’s done.

See also Sprite.broadcastAndWait

whenBackdropChanged

whenBackdropChanged(method: Function): void

Run a method when the stage backdrop changes.

See also Sprite.whenBackdropChanged

whenBroadcast

whenBroadcast(nameOrOptions: string | object, method: Function): void

Run a method when a matching broadcast is received.

See also Sprite.whenBroadcast

whenClicked

whenClicked(method: Function): void

Run a method when this sprite is clicked.

See also Sprite.whenClicked

Used by

• Play a sound on click
• Say hello when clicked

whenClickedOrTapped

whenClickedOrTapped(method: Function): void

Run a method when this sprite is clicked or tapped (mobile).

See also Sprite.whenClickedOrTapped

whenCloneStart

whenCloneStart(method: Function): void

Run a method when a clone of this sprite starts.

See also Sprite.whenCloneStart

Used by

• Create a clone army

whenGreenFlag

whenGreenFlag(method: Function): void

Run a method when the green flag is clicked.

See also Sprite.whenGreenFlag

Used by

• Animate a sprite with costumes
• Ask the player a question
• Bounce off the edge
• Create a clone army
• Follow the mouse
• Glide smoothly to a point
• Make a sprite grow and shrink
• Point and move towards the mouse
• Repeat an action
• Build a keyboard-controlled sprite

whenKeyPressed

whenKeyPressed(keyOrOptions: "space" | "up arrow" | "down arrow" | "right arrow" | "left arrow" | "any" | object, method: Function): void

Run a method when a key is pressed.

See also Sprite.whenKeyPressed

Used by

• Move a sprite with the arrow keys
• Show and hide a sprite
• Build a keyboard-controlled sprite

whenTouchEnd

whenTouchEnd(method: Function): void

Run a method when a touch on this sprite ends.

See also Sprite.whenTouchEnd

whenTouchMove

whenTouchMove(method: Function): void

Run a method when a touch on this sprite moves.

See also Sprite.whenTouchMove

whenTouchStart

whenTouchStart(method: Function): void

Run a method when a touch on this sprite begins.

See also Sprite.whenTouchStart