GS2-Guild マスターデータリファレンス
マスターデータのフォーマットと インポートする各種モデルのリファレンス
マスターデータのフォーマット
{
"version": "2024-04-25",
"guildModels": [
{
"name": "[string]ギルドモデル名",
"metadata": "[string?]メタデータ",
"defaultMaximumMemberCount": "[int]ギルド作成時に適用されるギルドメンバーの最大数",
"maximumMemberCount": "[int]ギルドメンバー数の上限として設定可能な最大数",
"inactivityPeriodDays": "[int]ギルドメンバーから新しいギルドマスターを選出するためのギルドマスターの無活動期間(日)",
"roles": [
{
"name": "[string]ロールモデル名",
"metadata": "[string?]メタデータ",
"policyDocument": "[string]ロールに適用する権限のポリシードキュメント"
}
],
"guildMasterRole": "[string]ギルドマスターが持つ権限",
"guildMemberDefaultRole": "[string]ギルドメンバーが初期状態に持つロール",
"rejoinCoolTimeMinutes": "[int]ギルド離脱後に再度参加できるまでのクールタイム(分)",
"maxConcurrentJoinGuilds": "[int?]同時に参加可能なギルドの最大数",
"maxConcurrentGuildMasterCount": "[int?]同時に存在可能なギルドマスターの最大人数"
}
]
}| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| version | string | ✓ | 2024-04-25 | マスターデータのフォーマットバージョン | ||
| guildModels | List<GuildModel> | ~ 100 items | ギルドモデル ギルドモデルとは、ギルドの加入可能最大人数の設定や、ギルド内での役職ごとの権限設定を持つエンティティです。 |
モデル
GuildModel
ギルドモデル
ギルドモデルとは、ギルドの加入可能最大人数の設定や、ギルド内での役職ごとの権限設定を持つエンティティです。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| guildModelId | string | ✓* | ~ 1024文字 | ギルドモデル
GRN ※ サーバー側で自動的に設定 | ||
| name | string | ✓ | ~ 128文字 | ギルドモデル名 | ||
| metadata | string | ~ 2048文字 | メタデータ | |||
| defaultMaximumMemberCount | int | ✓ | 1 ~ 2147483646 | ギルド作成時に適用されるギルドメンバーの最大数 | ||
| maximumMemberCount | int | ✓ | 1 ~ 2147483646 | ギルドメンバー数の上限として設定可能な最大数 | ||
| inactivityPeriodDays | int | ✓ | 7 | 1 ~ 365 | ギルドメンバーから新しいギルドマスターを選出するためのギルドマスターの無活動期間(日) | |
| roles | List<RoleModel> | ✓ | 1 ~ 10 items | ギルド内の各役職ごとの権限設定リスト | ||
| guildMasterRole | string | ✓ | ~ 128文字 | ギルドマスターが持つ権限 | ||
| guildMemberDefaultRole | string | ✓ | ~ 128文字 | ギルドメンバーが初期状態に持つロール | ||
| rejoinCoolTimeMinutes | int | ✓ | 0 | 0 ~ 2147483646 | ギルド離脱後に再度参加できるまでのクールタイム(分) | |
| maxConcurrentJoinGuilds | int | 1 ~ 10 | 同時に参加可能なギルドの最大数 | |||
| maxConcurrentGuildMasterCount | int | 1 ~ 100 | 同時に存在可能なギルドマスターの最大人数 |
RoleModel
ロールモデル
ロールモデルはギルド内での役割を定義し、その役割ごと実行できる処理に関する権限を設定します。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| name | string | ✓ | ~ 128文字 | ロールモデル名 | ||
| metadata | string | ~ 2048文字 | メタデータ | |||
| policyDocument | string | ✓ | ~ 10240文字 | ロールに適用する権限のポリシードキュメント |