Home Commands Examples Getting Started With Scripts Global Keywords

SequenceBuilder<T : Object, U : Object>

A builder for Sequence<T,U>.

Importing the class

It might be required for you to import the package if you encounter any issues (like casting an Array), so better be safe than sorry and add the import at the very top of the file.

script.zs
import crafttweaker.api.util.sequence.SequenceBuilder;

Methods

Adds a task to the sequence.

Returns: This builder to chain calls.
Return Type: SequenceBuilder<T,U>

script.zs
// SequenceBuilder.addTask(task as ISequenceTask<T,U>) as SequenceBuilder<T,U>
level.sequence().addTask(new SleepTask(20));
ParameterTypeDescription
Parameter
task
Type
ISequenceTask<T,U>
Description
The task to add.

Runs the function as part of the sequence.

Returns: This builder to chain calls.
Return Type: SequenceBuilder<T,U>

script.zs
// SequenceBuilder.run(function as BiConsumer<T,SequenceContext<T,U>>) as SequenceBuilder<T,U>
level.sequence().run((level, context) => level.setRainLevel(0.5));
ParameterTypeDescription
Parameter
function
Type
BiConsumer<T,SequenceContext<T,U>>
Description
The function to run.

Runs the function as part of the sequence.

Returns: This builder to chain calls.
Return Type: SequenceBuilder<T,U>

script.zs
// SequenceBuilder.run(function as Consumer<T>) as SequenceBuilder<T,U>
level.sequence().run((level) => level.setRainLevel(0.5));
ParameterTypeDescription
Parameter
function
Type
Consumer<T>
Description
The function to run.

Sleep (wait) for the given amount of ticks.

Returns: This builder to chain calls.
Return Type: SequenceBuilder<T,U>

script.zs
// SequenceBuilder.sleep(ticks as long) as SequenceBuilder<T,U>
level.sequence().sleep(20);
ParameterTypeDescription
Parameter
ticks
Type
long
Description
The amount of ticks to wait.

Sleeps until the given condition is met.

Returns: This builder to chain calls.
Return Type: SequenceBuilder<T,U>

script.zs
// SequenceBuilder.sleepUntil(condition as BiPredicate<T,SequenceContext<T,U>>) as SequenceBuilder<T,U>
level.sequence().sleepUntil((level, context) => level.isRaining);
ParameterTypeDescription
Parameter
condition
Type
BiPredicate<T,SequenceContext<T,U>>
Description
The condition to wait for.

Sleeps until the given condition is met.

Returns: This builder to chain calls.
Return Type: SequenceBuilder<T,U>

script.zs
// SequenceBuilder.sleepUntil(condition as Predicate<T>) as SequenceBuilder<T,U>
level.sequence().sleepUntil((level) => level.isRaining);
ParameterTypeDescription
Parameter
condition
Type
Predicate<T>
Description
The condition to wait for.

Builds and starts the sequence.

Returns: The sequence that was built.
Return Type: Sequence<T,U>

script.zs
// SequenceBuilder.start() as Sequence<T,U>
level.sequence().start();

Runs the function as part of the sequence.

This method is an alias for run

Returns: This builder to chain calls.
Return Type: SequenceBuilder<T,U>

script.zs
// SequenceBuilder.then(function as BiConsumer<T,SequenceContext<T,U>>) as SequenceBuilder<T,U>
level.sequence().then((level, context) => level.setRainLevel(0.5));
ParameterTypeDescription
Parameter
function
Type
BiConsumer<T,SequenceContext<T,U>>
Description
The function to run.

Runs the function as part of the sequence.

This method is an alias for run

Returns: This builder to chain calls.
Return Type: SequenceBuilder<T,U>

script.zs
// SequenceBuilder.then(function as Consumer<T>) as SequenceBuilder<T,U>
level.sequence().then((level) => level.setRainLevel(0.5));
ParameterTypeDescription
Parameter
function
Type
Consumer<T>
Description
The function to run.