PvpUnknownReason
A type alias: another name for the type it stands for.
Fields
| Field | Type | Description |
|---|---|---|
LOCAL_PLAYER | PvpUnknownReason | The local player could not be read. |
WORLD_TYPE | PvpUnknownReason | The world's type is not known yet. |
AREA_STATE | PvpUnknownReason | The wilderness/PvP area state could not be read. |
COMBAT_RANGE | PvpUnknownReason | The combat range could not be worked out. |
COORDINATES | PvpUnknownReason | The player's position could not be read. |
Returned by
| Method | Returns | Description |
|---|---|---|
WorldPvp.state | { kind: "safe" | "active" | "unknown", combatRange: { min: number, max: number }?, reason: PvpUnknownReason? } | Whether the local player is somewhere they can be attacked, and how. |
WorldPvp.threats | { kind: "safe" | "active" | "unknown", reason: PvpUnknownReason?, combatRange: { min: number, max: number }?, unreadableCandidates: number?, players: { Player }? } | Who can attack the local player right now. |