Home Commands Examples Getting Started With Scripts Global Keywords 1.21 Migration Guide
ChorusFruitTeleportEvent EnderEntityTeleportEvent EnderPearlTeleportEvent EntityCommandTeleportEvent EntitySpreadPlayersCommandTeleportEvent EntityTeleportEvent
EntityEvent EntityJoinLevelEvent EntityLeaveLevelEvent EntityMobGriefingEvent EntityMountEvent EntityStruckByLightningEvent EntityTravelToDimensionEvent ProjectileImpactEvent
DetonateExplosionEvent DifficultyChangeEvent Event ExplosionEvent FurnaceFuelBurnTimeEvent ICancellableEvent StartExplosionEvent
NeoForgeBracketDumpers NeoForgeBracketHandlers NeoForgeBracketValidators
Previous
EntityCommandTeleportEvent EntityTeleportEvent
Next

EntitySpreadPlayersCommandTeleportEvent

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.teleport.EntitySpreadPlayersCommandTeleportEvent;

Extends

EntitySpreadPlayersCommandTeleportEvent extends EntityTeleportEvent.

Implements

EntitySpreadPlayersCommandTeleportEvent 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.teleport.EntitySpreadPlayersCommandTeleportEvent>(event => {
    println("EntitySpreadPlayersCommandTeleportEvent ran!");
});

Members

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

Return Type: bool

Getter
script.zs
// SpreadPlayersCommand.canceled as bool
event.canceled

Return Type: bool

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

Parameters:

cancel Type: bool
Setter
script.zs
// SpreadPlayersCommand.canceled = (cancel as bool);
event.canceled = myBool;

Parameters:

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

Return Type: bool

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

Parameters:

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

Return Type: bool

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

Parameters:

cancel Type: bool
entity
Getter
script.zs
// SpreadPlayersCommand.entity as Entity
event.entity

Return Type: Entity

prev
Getter
script.zs
// SpreadPlayersCommand.prev as Vec3
event.prev

Return Type: Vec3

prevX
Getter
script.zs
// SpreadPlayersCommand.prevX as double
event.prevX

Return Type: double

prevY
Getter
script.zs
// SpreadPlayersCommand.prevY as double
event.prevY

Return Type: double

prevZ
Getter
script.zs
// SpreadPlayersCommand.prevZ as double
event.prevZ

Return Type: double

target
Getter
script.zs
// SpreadPlayersCommand.target as Vec3
event.target

Return Type: Vec3

targetX
Getter
script.zs
// SpreadPlayersCommand.targetX as double
event.targetX

Return Type: double

Setter
script.zs
// SpreadPlayersCommand.targetX = (targetX as double);
event.targetX = myDouble;

Parameters:

targetX Type: double
targetY
Getter
script.zs
// SpreadPlayersCommand.targetY as double
event.targetY

Return Type: double

Setter
script.zs
// SpreadPlayersCommand.targetY = (targetY as double);
event.targetY = myDouble;

Parameters:

targetY Type: double
targetZ
Getter
script.zs
// SpreadPlayersCommand.targetZ as double
event.targetZ

Return Type: double

Setter
script.zs
// SpreadPlayersCommand.targetZ = (targetZ as double);
event.targetZ = myDouble;

Parameters:

targetZ Type: double
Previous
EntityCommandTeleportEvent EntityTeleportEvent
Next