Skip to content

Courier

The Courier class extends NPC with courier-specific state APIs.

NOTE

This page documents members declared directly on Courier. Inherited members are available from NPC.


Methods

IsFlyingCourier()boolean

Checks whether it is flying courier.

Returned:

  • boolean - True if the condition is met, false otherwise.

GetRespawnTime()number

Retrieves the respawn time.

Returned:

  • number - The requested respawn time.

GetCourierState()Enum.CourierState

Retrieves the courier state.

Returned:


GetCourierStateEntityIndex()number

Retrieves the courier state entity index.

Returned:

  • number - The requested courier state entity index.

GetCourierStateEntity()Hero | null

Retrieves the courier state entity.

Returned:

  • Hero | null - The matching object, or null if it is not available.