Class CameraSequenceBuilder

java.lang.Object

com.hypixel.hytale.server.core.modules.camera.CameraSequenceBuilder

public class CameraSequenceBuilder
extends Object

Fluent builder for a short, pre-authored camera sequence: an ordered track of eased keyframes (world position, look, optional FOV and depth of field) and a set of CameraSequenceFlags, applied with addFlag(byte). build() snapshots it into a list-backed CameraSequenceSource, and sendTo(PlayerRef) begins it on a player. A system that generates keyframes lazily implements CameraSequenceSource directly rather than using this builder.

Constructor Summary

Constructors

Constructor	Description
CameraSequenceBuilder()

Method Summary

Modifier and Type	Method	Description
CameraSequenceBuilder	addFlag(byte flag)
CameraSequenceBuilder	baseFov(Float baseFov)
CameraSequenceSource	build()	Snapshots the current keyframes into an immutable CameraSequenceSource.
CameraSequenceBuilder	keyframe(CameraKeyframeBuilder keyframe)	Adds a keyframe assembled with a CameraKeyframeBuilder, for the channels the positional overloads do not carry (FOV, depth of field, inherited position or look).
CameraSequenceBuilder	keyframe(org.joml.Vector3d position, Rotation3f look, float duration, EasingType easing)	Adds a keyframe the camera reaches over duration seconds from the previous keyframe, looking in an explicit direction.
CameraSequenceBuilder	keyframeLookingAt(org.joml.Vector3d position, org.joml.Vector3d lookAtPoint, float duration, EasingType easing)	Adds a keyframe that looks toward a fixed world point rather than holding an explicit direction.
CameraSequenceBuilder	onComplete(Consumer<PlayerRef> onComplete)
void	sendTo(PlayerRef playerRef)

Methods inherited from class Object

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

Constructor Details

CameraSequenceBuilder

public CameraSequenceBuilder()

Method Details

addFlag

public CameraSequenceBuilder addFlag(byte flag)

baseFov

public CameraSequenceBuilder baseFov(@Nullable
 Float baseFov)

onComplete

public CameraSequenceBuilder onComplete(@Nullable
 Consumer<PlayerRef> onComplete)

keyframe

public CameraSequenceBuilder keyframe(@Nonnull
 org.joml.Vector3d position,
 @Nonnull
 Rotation3f look,
 float duration,
 @Nonnull
 EasingType easing)

Adds a keyframe the camera reaches over duration seconds from the previous keyframe, looking in an explicit direction.

keyframe

public CameraSequenceBuilder keyframe(@Nonnull
 CameraKeyframeBuilder keyframe)

Adds a keyframe assembled with a CameraKeyframeBuilder, for the channels the positional overloads do not carry (FOV, depth of field, inherited position or look).

keyframeLookingAt

public CameraSequenceBuilder keyframeLookingAt(@Nonnull
 org.joml.Vector3d position,
 @Nonnull
 org.joml.Vector3d lookAtPoint,
 float duration,
 @Nonnull
 EasingType easing)

Adds a keyframe that looks toward a fixed world point rather than holding an explicit direction.

build

@Nonnull
public CameraSequenceSource build()

Snapshots the current keyframes into an immutable CameraSequenceSource. Keyframes added to this builder after this call do not affect the returned source.

sendTo

public void sendTo(@Nonnull
 PlayerRef playerRef)