メインコンテンツまでスキップ
バージョン: v2.0

LevelRoles

このクラスは、レベルに基づくロール設定を管理します。レベルロールの追加、削除、一覧取得、検索をサポートし、共有 db API を通じて MongoDB と SQLite の両方で動作します。

Methods

LevelRoles.add()

レベルにロールを追加します。対象レベルが既に存在する場合は、指定したロールが統合され、重複は除去されます。

パラメーター

ParameterTypeRequiredDescription
guildIdstringギルド ID。
optionsLevelRole追加するレベルとロール。

戻り値

  • Promise<boolean> - 操作が成功した場合は true

例外

  • XpFatal - 無効なパラメーターが渡された場合。

LevelRoles.delete()

レベルから一部またはすべてのロールを削除します。options.roles を省略すると、そのレベルのロール全体が削除されます。

パラメーター

ParameterTypeRequiredDescription
guildIdstringギルド ID。
optionsLevelRole削除するレベルとロール。

戻り値

  • Promise<boolean> - 操作が成功した場合は true

LevelRoles.deleteAll()

ギルドに紐づくすべてのレベルロールエントリを削除します。

パラメーター

ParameterTypeRequiredDescription
guildIdstringギルド ID。

戻り値

  • Promise<boolean> - 操作が成功した場合は true

LevelRoles.getGuildRoles()

ギルドに設定されたすべてのレベルロールエントリを取得します。

パラメーター

ParameterTypeRequiredDescription
guildIdstringギルド ID。

戻り値

  • Promise<LevelRoleResult[]> - レベルロールオブジェクトの配列。

LevelRoles.getUserRoles()

ユーザーのレベルに適用されるロール ID を返します。オプションにより、現在レベル、次レベル、前レベルのロールを含めるかを制御できます。既定では現在レベルのみが含まれます。

パラメーター

ParameterTypeRequiredDescription
userIdstringユーザー ID。
guildIdstringギルド ID。
optionsGetRolesOptions次/前レベルを含めるためのオプション。

戻り値

  • Promise<string[]> - ロール ID の配列。該当しない場合は空配列。

LevelRoles.set()

特定レベルのロールを設定し、既存値を上書きします。

パラメーター

ParameterTypeRequiredDescription
guildIdstringギルド ID。
optionsLevelRole設定するレベルとロール。

戻り値

  • Promise<boolean> - 操作が成功した場合は true