com.simibubi.create.foundation.ponder

Class SceneBuilder

java.lang.Object

com.simibubi.create.foundation.ponder.SceneBuilder

public class SceneBuilder
extends java.lang.Object

Enqueue instructions to the schedule via this object's methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SceneBuilder.DebugInstructions
class	SceneBuilder.EffectInstructions
class	SceneBuilder.OverlayInstructions
class	SceneBuilder.SpecialInstructions
class	SceneBuilder.WorldInstructions

Field Summary

Fields

Modifier and Type	Field and Description
SceneBuilder.DebugInstructions	debug Additional tools for debugging ponder and bypassing the facade
SceneBuilder.EffectInstructions	effects Special effects to embellish and communicate with
SceneBuilder.OverlayInstructions	overlay Ponder's toolkit for showing information on top of the scene world, such as highlighted bounding boxes, texts, icons and keybindings.
SceneBuilder.SpecialInstructions	special Random other instructions that might come in handy
SceneBuilder.WorldInstructions	world Instructions for manipulating the schematic and its currently visible areas.

Constructor Summary

Constructors

Constructor and Description
SceneBuilder(PonderScene ponderScene)

Method Summary

Modifier and Type	Method and Description
void	addInstruction(java.util.function.Consumer<PonderScene> callback) Adds a simple instruction to the scene.
void	addInstruction(PonderInstruction instruction) Adds an instruction to the scene.
void	addKeyframe() Adds a Key Frame at the end of the last delay() instruction for the users to skip to
void	addLazyKeyframe() Adds a Key Frame a couple ticks after the last delay() instruction for the users to skip to
void	configureBasePlate(int xOffset, int zOffset, int basePlateSize) Communicates to the ponder UI which parts of the schematic make up the base horizontally.
void	idle(int ticks) Before running the upcoming instructions, wait for a duration to let previous actions play out.
void	idleSeconds(int seconds) Before running the upcoming instructions, wait for a duration to let previous actions play out.
void	markAsFinished() Once the scene reaches this instruction in the timeline, mark it as "finished".
void	rotateCameraY(float degrees) Pans the scene's camera view around the vertical axis by the given amount
void	scaleSceneView(float factor) Use this in case you are not happy with the scale of the scene relative to the overlay
void	setSceneOffsetY(float yOffset) Use this in case you are not happy with the vertical alignment of the scene relative to the overlay
void	showBasePlate() Fade the layer of blocks into the scene ponder assumes to be the base plate of the schematic's structure.
void	title(java.lang.String sceneId, java.lang.String title) Assign a unique translation key, as well as the standard english translation for this scene's title using this method, anywhere inside the program function.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

overlay

public final SceneBuilder.OverlayInstructions overlay

Ponder's toolkit for showing information on top of the scene world, such as highlighted bounding boxes, texts, icons and keybindings.

world

public final SceneBuilder.WorldInstructions world

Instructions for manipulating the schematic and its currently visible areas. Allows to show, hide and modify blocks as the scene plays out.

debug

public final SceneBuilder.DebugInstructions debug

Additional tools for debugging ponder and bypassing the facade

effects

public final SceneBuilder.EffectInstructions effects

Special effects to embellish and communicate with

special

public final SceneBuilder.SpecialInstructions special

Random other instructions that might come in handy

Constructor Detail

SceneBuilder

public SceneBuilder(PonderScene ponderScene)

Method Detail

title

public void title(java.lang.String sceneId,
                  java.lang.String title)

Assign a unique translation key, as well as the standard english translation for this scene's title using this method, anywhere inside the program function.

Parameters:

sceneId -

title -

configureBasePlate

public void configureBasePlate(int xOffset,
                               int zOffset,
                               int basePlateSize)

Communicates to the ponder UI which parts of the schematic make up the base horizontally. Use of this is encouraged whenever there are components outside the the base plate.
As a result, showBasePlate() will only show the configured size, and the scene's scaling inside the UI will be consistent with its base size.

Parameters:

xOffset - Block spaces between the base plate and the schematic boundary on the Western side.

zOffset - Block spaces between the base plate and the schematic boundary on the Northern side.

basePlateSize - Length in blocks of the base plate itself. Ponder assumes it to be square

scaleSceneView

public void scaleSceneView(float factor)

Use this in case you are not happy with the scale of the scene relative to the overlay

Parameters:

factor - >1 will make the scene appear larger, smaller otherwise

setSceneOffsetY

public void setSceneOffsetY(float yOffset)

Use this in case you are not happy with the vertical alignment of the scene relative to the overlay

Parameters:

yOffset - >0 moves the scene up, down otherwise

showBasePlate

public void showBasePlate()

Fade the layer of blocks into the scene ponder assumes to be the base plate of the schematic's structure. Makes for a nice opener

addInstruction

public void addInstruction(PonderInstruction instruction)

Adds an instruction to the scene. It is recommended to only use this method if another method in this class or its subclasses does not already allow adding a certain instruction.

addInstruction

public void addInstruction(java.util.function.Consumer<PonderScene> callback)

Adds a simple instruction to the scene. It is recommended to only use this method if another method in this class or its subclasses does not already allow adding a certain instruction.

idle

public void idle(int ticks)

Before running the upcoming instructions, wait for a duration to let previous actions play out.
Idle does not stall any animations, only schedules a time gap between instructions.

Parameters:

ticks - Duration to wait for

idleSeconds

public void idleSeconds(int seconds)

Before running the upcoming instructions, wait for a duration to let previous actions play out.
Idle does not stall any animations, only schedules a time gap between instructions.

Parameters:

seconds - Duration to wait for

markAsFinished

public void markAsFinished()

Once the scene reaches this instruction in the timeline, mark it as "finished". This happens automatically when the end of a storyboard is reached, but can be desirable to do earlier, in order to bypass the wait for any residual text windows to time out.
So far this event only affects the "next scene" button in the UI to flash.

rotateCameraY

public void rotateCameraY(float degrees)

Pans the scene's camera view around the vertical axis by the given amount

Parameters:

degrees -

addKeyframe

public void addKeyframe()

Adds a Key Frame at the end of the last delay() instruction for the users to skip to

addLazyKeyframe

public void addLazyKeyframe()

Adds a Key Frame a couple ticks after the last delay() instruction for the users to skip to