setFlags()
この関数は、ユーザーレコードにフラグを保存します。
フラグはユーザーデータに永続化され、独自ロジックやプラグインから利用できます。すべての保存済みフラグを削除するには undefined を渡します。
パラメーター
| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | ✅ | ユーザーの ID。 |
| guildId | string | ✅ | ギルド ID。 |
| flags | Array | ❌ | 保存する文字列/数値フラグ。削除するには undefined を指定します。 |
| username | string | ❌ | auto_create が有効な場合に使うユーザー名。 |
戻り値
- Promise<
UserResult>
例外
XpFatal- 無効なパラメーターが渡された場合、またはデータベースエラーが発生した場合。
[JS] 例
const {setFlags} = require('simply-xp');
const userid = "326815959358898189";
const guildid = "867999056172052551";
const flags = ["modified", "illegal"];
const username = "Abadima";
setFlags(userid, guildid, flags, username)
.then(console.log) // Returns the user object
.catch((err) => console.log(err)); // Returns the error