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文字 | メタデータ メタデータには任意の値を設定できます。 これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 | |||
| defaultMaximumMemberCount | int | ✓ | 1 ~ 2147483646 | デフォルト最大メンバー数 新しいギルドが作成される際に許可されるメンバーの初期最大数です。この値は新規ギルドの currentMaximumMemberCount の初期値として使用されます。ギルド操作や入手アクションを通じて、後から maximumMemberCount の上限まで増加させることができます。 | ||
| maximumMemberCount | int | ✓ | 1 ~ 2147483646 | 最大メンバー数上限 ギルドが持つことができるメンバー数の絶対的な上限です。ギルドの currentMaximumMemberCount はこの値を超えることができません。ギルドが意図されたサイズを超えて成長するのを防ぐハードキャップとして機能します。 | ||
| inactivityPeriodDays | int | 7 | 1 ~ 365 | 無活動期間(日数) ギルドマスターの無活動がこの日数を超えた場合に、残りのギルドメンバーから新しいギルドマスターが自動的に選出されます。ギルドマスターがプレイを停止した際にギルドが管理不能になるのを防ぎます。 | ||
| roles | List<RoleModel> | ✓ | 1 ~ 10 items | ロールモデルリスト このタイプのギルド内で利用可能なロール定義のリストです。guildMasterRole および guildMemberDefaultRole で参照されるロールを少なくとも含む必要があります。各ロールはポリシードキュメントを介して固有の権限セットを定義します。最大10個のロールを定義できます。 | ||
| guildMasterRole | string | ✓ | ~ 128文字 | ギルドマスターロール名 ギルドマスターに割り当てられるロールの名前です。roles リストで定義されたロールを参照する必要があります。ギルドマスターは通常、参加リクエストの承認、メンバー追放、ロール変更、ギルド設定の更新など、ギルドを管理する全権限を持ちます。 | ||
| guildMemberDefaultRole | string | ✓ | ~ 128文字 | デフォルトメンバーロール名 新しいギルドメンバーが参加した際に自動的に割り当てられるロールの名前です。roles リストで定義されたロールを参照する必要があります。これはギルドマスターによるロール変更前の一般メンバーの基本権限セットです。 | ||
| rejoinCoolTimeMinutes | int | 0 | 0 ~ 2147483646 | 再参加クールタイム(分) ユーザーがギルドを離脱した後、再度ギルドに参加できるようになるまでのクールダウン期間(分)です。0 に設定すると即時再参加が可能になります。ユーザーが繰り返しギルドに参加・離脱する悪用パターンを防止します。 | ||
| maxConcurrentJoinGuilds | int | 1 ~ 10 | 同時参加可能ギルド最大数 ユーザーがこのタイプのギルドに同時にメンバーとして参加できる最大数です。プレイヤーが複数のギルドに同時に所属できるデザイン(例: 戦闘ギルドとソーシャルギルド)を可能にします。値は 1 から 10 の範囲です。 | |||
| maxConcurrentGuildMasterCount | int | 1 ~ 100 | 同時存在可能ギルドマスター最大数 1つのギルドに同時に存在できるギルドマスターの最大人数です。複数のプレイヤーがギルドマスターの責任と権限を共有する共同リーダーシップのデザインを可能にします。値は 1 から 100 の範囲です。 |
RoleModel
ロールモデル
ロールモデルはギルド内での役割を定義し、その役割ごと実行できる処理に関する権限を設定します。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| name | string | ✓ | ~ 128文字 | ロールモデル名 ロールモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | ||
| metadata | string | ~ 2048文字 | メタデータ メタデータには任意の値を設定できます。 これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 | |||
| policyDocument | string | ✓ | ~ 10240文字 | ポリシードキュメント このロールの権限を定義する JSON 形式のポリシードキュメントです。このロールに割り当てられたメンバーに対して、どのギルド操作(参加リクエストの承認/拒否、メンバー追放、ギルド情報の更新、メンバーロールの変更など)が許可または拒否されるかを指定します。 |