Class Spectating

java.lang.Object

com.hypixel.hytale.server.core.modules.entity.component.Spectating

All Implemented Interfaces:

Component<EntityStore>, Cloneable

public class Spectating
extends Object
implements Component<EntityStore>

Marks a player entity as spectating, and which entity it is watching through the follow camera. Session-only and never persisted.

Spectator behavior (visibility, NPC detection, item pickup, camera) keys on this component. Entering a gamemode type with Spectator: true composes the full spectator state.

Immutable: watching a target or returning to free-fly means putting a new instance, and the spectator systems compose the camera from the change.

Field Summary

Fields inherited from interface Component

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor	Description
Spectating()	Creates a free-flying spectating state with no watched target.
Spectating(Ref<EntityStore> targetRef)	Creates a spectating state watching the given target through the follow camera.

Method Summary

Modifier and Type	Method	Description
Component<EntityStore>	clone()
static ComponentType<EntityStore, Spectating>	getComponentType()
Ref<EntityStore>	getTargetRef()
static boolean	isSpectating(Ref<EntityStore> ref, ComponentAccessor<EntityStore> componentAccessor)	Whether the entity is currently spectating.

Methods inherited from class Object

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

Methods inherited from interface Component

cloneSerializable

Constructor Details

Spectating

public Spectating()

Creates a free-flying spectating state with no watched target.

Spectating

public Spectating(@Nullable
 Ref<EntityStore> targetRef)

Creates a spectating state watching the given target through the follow camera.

Parameters:

targetRef - The entity reference to watch, or null for free-fly.

Method Details

getComponentType

public static ComponentType<EntityStore, Spectating> getComponentType()

Returns:

the registered ComponentType of this component.

isSpectating

public static boolean isSpectating(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 ComponentAccessor<EntityStore> componentAccessor)

Whether the entity is currently spectating.

Parameters:

ref - The entity reference.

componentAccessor - The ComponentAccessor for component access.

Returns:

true if the entity has the Spectating component.

getTargetRef

@Nullable
public Ref<EntityStore> getTargetRef()

Returns:

the entity reference of the watched target, or null when free-flying.

clone

@Nonnull
public Component<EntityStore> clone()

Specified by:

clone in interface Component<EntityStore>

Returns:

a clone instance of the original component instance.