Jump to a label within the current section, optionally based on a condition. The goto method will only navigate to a label within the same section.

Properties

goto

objectRequired

An object that accepts the following properties.

goto.label

stringRequired

The label in section to jump to.

goto.when

string

A JavaScript condition that determines whether to perform the jump. If the condition evaluates to true, the jump is executed. If omitted, the jump is unconditional.

goto.max

integerDefaults to 100

The maximum number of times to jump, from the minimum of 1 to max 100 jumps.

Examples

Loop with max

YAMLJSON

version: 1.0.0
sections:
  main:
    - label: foo
    - play:
        url: 'say: This speech will be repeated 4 times.'
    - goto:
        label: foo
        max: 3

Loop if a condition is satisfied

YAMLJSON

version: 1.0.0
sections:
  main:
    - label: foo
    - play:
        url: 'say: This is some text that will be repeated 4 times.'
    - set:
        do_loop: true
    - goto:
        label: foo
        when: do_loop === true
        max: 3