XpEventCallback
このドキュメントでは、さまざまな XP イベントを処理するために使用できるコールバック関数を定義します。これらのコールバックは、simply-xp の実行中にログおよびレベル関連イベントで呼び出されます。
すべてのコールバックは任意で、void または Promise<void> を返せます。
Callbacks
custom
このコールバックは、共有コールバックオブジェクト形状を再利用したいカスタムエミッターで使用できます。
| Parameter | Type | Description |
|---|---|---|
| message | string | カスタムメッセージ本文。 |
debug
このコールバックは、debug イベントが発火したときに使われます。
| Parameter | Type | Description |
|---|---|---|
| xpFunction | string | このイベントを発火した関数。 |
| message | string | イベントメッセージ。 |
error
このコールバックは、error イベントが発火したときに使われます。
| Parameter | Type | Description |
|---|---|---|
| xpFunction | string | このイベントを発火した関数。 |
| message | string | イベントメッセージ。 |
info
このコールバックは、info イベントが発火したときに使われます。
| Parameter | Type | Description |
|---|---|---|
| xpFunction | string | このイベントを発火した関数。 |
| message | string | イベントメッセージ。 |
levelDown
このコールバックは、ユーザーのレベルが下がったときに使われます。
| Parameter | Type | Description |
|---|---|---|
| data | UserResult | ユーザーデータ。 |
| lostRoles | string[] | 失われたロール。 |
levelUp
このコールバックは、ユーザーがレベルアップしたときに使われます。
| Parameter | Type | Description |
|---|---|---|
| data | UserResult | ユーザーデータ。 |
| newRoles | string[] | 新しく付与されたロール。 |
warn
このコールバックは、warn イベントが発火したときに使われます。
| Parameter | Type | Description |
|---|---|---|
| xpFunction | string | このイベントを発火した関数。 |
| message | string | イベントメッセージ。 |