Home Commands Examples Getting Started With Scripts Global Keywords 1.21 Migration Guide
AttackEntityEvent BonemealEvent CanContinueSleepingEvent CanPlayerSleepEvent CriticalHitEvent PlayerBreakSpeedEvent PlayerChangeGameModeEvent PlayerChangedDimensionEvent PlayerCloneEvent PlayerEvent PlayerFlyableFallEvent PlayerHarvestCheckEvent PlayerLoggedInEvent PlayerLoggedOutEvent PlayerNameFormatEvent PlayerRespawnEvent PlayerSetSpawnEvent PlayerWakeUpEvent TabListNameFormat TradeWithVillagerEvent
EntityEvent EntityJoinLevelEvent EntityLeaveLevelEvent EntityMobGriefingEvent EntityMountEvent EntityStruckByLightningEvent EntityTravelToDimensionEvent ProjectileImpactEvent
DetonateExplosionEvent DifficultyChangeEvent Event ExplosionEvent FurnaceFuelBurnTimeEvent ICancellableEvent StartExplosionEvent
NeoForgeBracketDumpers NeoForgeBracketHandlers NeoForgeBracketValidators
Previous
PlayerRespawnEvent PlayerWakeUpEvent
Next

PlayerSetSpawnEvent

Importing the class

If you need to reference this type directly, like when casting an Array, or as a parameter, you will need to import it. Simply add the import at the top of the file.

script.zs
import crafttweaker.neoforge.api.event.entity.player.PlayerSetSpawnEvent;

Extends

PlayerSetSpawnEvent extends PlayerEvent.

Implements

PlayerSetSpawnEvent implements the following interfaces:

ICancellableEvent

Listening to the event

This event can be listened to like so:

script.zs
events.register<crafttweaker.neoforge.api.event.entity.player.PlayerSetSpawnEvent>(event => {
    println("PlayerSetSpawnEvent ran!");
});

Members

cancel
cancel()
Cancels the event. Same as setCanceled(true)
script.zs
// PlayerSetSpawnEvent.cancel();
event.cancel();
canceled
Getter
script.zs
// PlayerSetSpawnEvent.canceled as bool
event.canceled

Return Type: bool

Setter
script.zs
// PlayerSetSpawnEvent.canceled = (cancel as bool);
event.canceled = myBool;

Parameters:

cancel Type: bool
canceled() as bool
script.zs
// PlayerSetSpawnEvent.canceled() as bool;
event.canceled();

Return Type: bool

canceled(cancel as bool)
script.zs
// PlayerSetSpawnEvent.canceled(cancel as bool);
event.canceled(myBool);

Parameters:

cancel Type: bool
entity
Getter
script.zs
// PlayerSetSpawnEvent.entity as Player
event.entity

Return Type: Player

Getter
script.zs
// PlayerSetSpawnEvent.entity as LivingEntity
event.entity

Return Type: LivingEntity

Getter
script.zs
// PlayerSetSpawnEvent.entity as Entity
event.entity

Return Type: Entity

isForced
Getter
script.zs
// PlayerSetSpawnEvent.isForced as bool
event.isForced

Return Type: bool

newSpawn
Getter
script.zs
// PlayerSetSpawnEvent.newSpawn as BlockPos
event.newSpawn

Return Type: BlockPos

spawnLevel
Getter
script.zs
// PlayerSetSpawnEvent.spawnLevel as ResourceLocation
event.spawnLevel

Return Type: ResourceLocation

Previous
PlayerRespawnEvent PlayerWakeUpEvent
Next