Record Class CameraInstruction

java.lang.Object

java.lang.Record

net.raphimc.viabedrock.protocol.model.CameraInstruction

public record CameraInstruction(CameraInstruction.SetCamera set, Boolean clear, CameraInstruction.Fade fade, CameraInstruction.Target target, Boolean removeTarget, CameraInstruction.FieldOfView fieldOfView, CameraInstruction.Spline spline, Long attachToEntity, Boolean detachFromEntity)
extends Record

Protocol 2193 camera fields. Null means absent, including optional booleans.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CameraInstruction.Action
static final record	CameraInstruction.Ease
static final record	CameraInstruction.Fade
static final record	CameraInstruction.FieldOfView
static final record	CameraInstruction.Progress
static final record	CameraInstruction.Rotation
static final record	CameraInstruction.SetCamera
static final record	CameraInstruction.Spline
static final record	CameraInstruction.Target
static final record	CameraInstruction.Times
static final record	CameraInstruction.Vec2
static final record	CameraInstruction.Vec3

Field Summary

Fields

Modifier and Type	Field	Description
static final com.viaversion.viaversion.api.type.Type<CameraInstruction>	TYPE

Constructor Summary

Constructors

Constructor	Description
CameraInstruction(CameraInstruction.SetCamera set, Boolean clear, CameraInstruction.Fade fade, CameraInstruction.Target target, Boolean removeTarget, CameraInstruction.FieldOfView fieldOfView, CameraInstruction.Spline spline, Long attachToEntity, Boolean detachFromEntity)	Creates an instance of a CameraInstruction record class.

Method Summary

Modifier and Type	Method	Description
CameraInstruction.Action	action()	Native camera actions are mutually exclusive, even when several optional fields are present.
Long	attachToEntity()	Returns the value of the attachToEntity record component.
Boolean	clear()	Returns the value of the clear record component.
Boolean	detachFromEntity()	Returns the value of the detachFromEntity record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
CameraInstruction.Fade	fade()	Returns the value of the fade record component.
CameraInstruction.FieldOfView	fieldOfView()	Returns the value of the fieldOfView record component.
final int	hashCode()	Returns a hash code value for this object.
Boolean	removeTarget()	Returns the value of the removeTarget record component.
CameraInstruction.SetCamera	set()	Returns the value of the set record component.
CameraInstruction.Spline	spline()	Returns the value of the spline record component.
CameraInstruction.Target	target()	Returns the value of the target record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

TYPE

public static final com.viaversion.viaversion.api.type.Type<CameraInstruction> TYPE

Constructor Details

CameraInstruction

public CameraInstruction(CameraInstruction.SetCamera set,
 Boolean clear,
 CameraInstruction.Fade fade,
 CameraInstruction.Target target,
 Boolean removeTarget,
 CameraInstruction.FieldOfView fieldOfView,
 CameraInstruction.Spline spline,
 Long attachToEntity,
 Boolean detachFromEntity)

Creates an instance of a CameraInstruction record class.

Parameters:

set - the value for the set record component

clear - the value for the clear record component

fade - the value for the fade record component

target - the value for the target record component

removeTarget - the value for the removeTarget record component

fieldOfView - the value for the fieldOfView record component

spline - the value for the spline record component

attachToEntity - the value for the attachToEntity record component

detachFromEntity - the value for the detachFromEntity record component

Method Details

action

public CameraInstruction.Action action()

Native camera actions are mutually exclusive, even when several optional fields are present.

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

set

public CameraInstruction.SetCamera set()

Returns the value of the set record component.

Returns:

the value of the set record component

clear

public Boolean clear()

Returns the value of the clear record component.

Returns:

the value of the clear record component

fade

public CameraInstruction.Fade fade()

Returns the value of the fade record component.

Returns:

the value of the fade record component

target

public CameraInstruction.Target target()

Returns the value of the target record component.

Returns:

the value of the target record component

removeTarget

public Boolean removeTarget()

Returns the value of the removeTarget record component.

Returns:

the value of the removeTarget record component

fieldOfView

public CameraInstruction.FieldOfView fieldOfView()

Returns the value of the fieldOfView record component.

Returns:

the value of the fieldOfView record component

spline

public CameraInstruction.Spline spline()

Returns the value of the spline record component.

Returns:

the value of the spline record component

attachToEntity

public Long attachToEntity()

Returns the value of the attachToEntity record component.

Returns:

the value of the attachToEntity record component

detachFromEntity

public Boolean detachFromEntity()

Returns the value of the detachFromEntity record component.

Returns:

the value of the detachFromEntity record component