Package net.neoforged.neoforge.event.entity.player

Enum Class PlayerSpawnPhantomsEvent.Result

java.lang.Object

java.lang.Enum<PlayerSpawnPhantomsEvent.Result>

net.neoforged.neoforge.event.entity.player.PlayerSpawnPhantomsEvent.Result

All Implemented Interfaces:

Serializable, Comparable<PlayerSpawnPhantomsEvent.Result>, Constable

Enclosing class:

PlayerSpawnPhantomsEvent

public static enum PlayerSpawnPhantomsEvent.Result
extends Enum<PlayerSpawnPhantomsEvent.Result>

Controls if the spawn attempt for the group of phantoms will occur.

This does not guarantee the spawn attempt will be successful, since this only controls pre-checks before the spawn position is selected and NaturalSpawner.isValidEmptySpawnBlock(net.minecraft.world.level.BlockGetter, net.minecraft.core.BlockPos, net.minecraft.world.level.block.state.BlockState, net.minecraft.world.level.material.FluidState, net.minecraft.world.entity.EntityType<?>) is checked.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALLOW	A spawn attempt will always be made, bypassing all rules described in DEFAULT.
DEFAULT	A spawn attempt will only be made if the dimension does not have skylight or the player's Y-level is above sea level and they can see the sky.
DENY	A spawn attempt will never be made.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Result()

Method Summary

Modifier and Type	Method	Description
static PlayerSpawnPhantomsEvent.Result	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PlayerSpawnPhantomsEvent.Result[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ALLOW

public static final PlayerSpawnPhantomsEvent.Result ALLOW

A spawn attempt will always be made, bypassing all rules described in DEFAULT.

DEFAULT

public static final PlayerSpawnPhantomsEvent.Result DEFAULT

A spawn attempt will only be made if the dimension does not have skylight or the player's Y-level is above sea level and they can see the sky.

Additionally, the local difficulty must be higher than a random threshold in [0, 3) and a random number check based on the player's Stats.TIME_SINCE_REST must succeed.

DENY

public static final PlayerSpawnPhantomsEvent.Result DENY

A spawn attempt will never be made.

Constructor Details

Result

private Result()

Method Details

values

public static PlayerSpawnPhantomsEvent.Result[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static PlayerSpawnPhantomsEvent.Result valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null