Documentation / @debuffjp/dev / ExplainedError

Interface: ExplainedError

Defined in: dev/src/explain.ts:22

A runtime error explained for humans and agents. JSON-serialisable.

Properties

count

count: number

Defined in: dev/src/explain.ts:35

How many times this same error happened.

---

hint

hint: string

Defined in: dev/src/explain.ts:29

A plain-words next step.

---

kind

kind: ErrorKind

Defined in: dev/src/explain.ts:23

---

message

message: string

Defined in: dev/src/explain.ts:25

---

name

name: string

Defined in: dev/src/explain.ts:24

---

phase?

optional phase?: string

Defined in: dev/src/explain.ts:31

Loop phase and tick, when the game loop caught it.

---

reportUrl?

optional reportUrl?: string

Defined in: dev/src/explain.ts:38

For debuff-bug: a prefilled GitHub issue.

---

scene?

optional scene?: string

Defined in: dev/src/explain.ts:32

---

stack

stack: string

Defined in: dev/src/explain.ts:36

---

tick?

optional tick?: number

Defined in: dev/src/explain.ts:33

---

where?

optional where?: SourceLocation

Defined in: dev/src/explain.ts:27

Where in the game's code to look: the throwing frame, or the call into debuff that failed.