JSPrismarine

API reference / @jsprismarine/prismarine / Events / EntityPortalEnterEvent

Class: EntityPortalEnterEvent ​

Defined in: prismarine/src/events/entity/EntityPortalEnterEvent.ts:12

Fired when an entity's body first overlaps a portal block, before any contact timer starts.

Cancelable. A canceled event opens no contact, so the entity stays where it is; the world asks again on the next tick it still overlaps the portal. Players raise this too, and then PlayerChangeDimensionEvent once their timer runs out and a destination is known.

Extends ​

Constructors ​

Constructor ​

new EntityPortalEnterEvent(entity, portal): EntityPortalEnterEvent

Defined in: prismarine/src/events/entity/EntityPortalEnterEvent.ts:16

Parameters ​

entity ​

Entity

portal ​

PortalBlockRef

Returns ​

EntityPortalEnterEvent

Overrides ​

Event.constructor

Methods ​

getEntity() ​

getEntity(): Entity

Defined in: prismarine/src/events/entity/EntityPortalEnterEvent.ts:24

Who stepped into the portal.

Returns ​

Entity

getPortal() ​

getPortal(): PortalBlockRef

Defined in: prismarine/src/events/entity/EntityPortalEnterEvent.ts:29

The portal block the entity overlaps, with the world it is in.

Returns ​

PortalBlockRef

isCanceled() ​

isCanceled(): boolean

Defined in: prismarine/src/events/Event.ts:12

Is the event canceled

Returns ​

boolean

Whether the event is canceled

Inherited from ​

Event.isCanceled

preventDefault() ​

preventDefault(): void

Defined in: prismarine/src/events/Event.ts:19

Cancel the event

Returns ​

void

Inherited from ​

Event.preventDefault