GS2-Experience
GS2-Deploy のテンプレートで使用できるリソース定義のリファレンス
GS2-Deploy リファレンス
エンティティ
Namespace
Namespace
Type: GS2::Experience::Namespace
Properties:
Name: namespace1
Description: null
ExperienceCapScriptId: null
ChangeExperienceScript: null
ChangeRankScript: null
ChangeRankCapScript: null
OverflowExperienceScript: null
LogSetting:
LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1
ネームスペース
ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。
GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。
そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| name | string | ✓ | ~ 32文字 | ネームスペース名 | |
| description | string | ~ 1024文字 | 説明文 | ||
| experienceCapScriptId | string | ~ 1024文字 | ランクキャップを動的に決定するスクリプト | ||
| changeExperienceScript | ScriptSetting | 経験値変化したときに実行するスクリプト | |||
| changeRankScript | ScriptSetting | ランク変化したときに実行するスクリプト | |||
| changeRankCapScript | ScriptSetting | ランクキャップ変化したときに実行するスクリプト | |||
| overflowExperienceScript | ScriptSetting | 経験値あふれしたときに実行するスクリプト | |||
| logSetting | LogSetting | ログの出力設定 |
ExperienceModelMaster
ExperienceModelMaster
Type: GS2::Experience::ExperienceModelMaster
Properties:
NamespaceName: namespace1
Name: experience-model-0001
Description: null
Metadata: null
DefaultExperience: null
DefaultRankCap: 50
MaxRankCap: 50
RankThresholdName: $threshold1.name
経験値モデルマスター
経験値モデルとは、ランクアップに必要な経験値の閾値や、デフォルトのランクキャップ・最大ランクキャップ毎に設定するエンティティです。
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 32文字 | ネームスペース名 | |
| name | string | ✓ | ~ 128文字 | 経験値モデル名 | |
| description | string | ~ 1024文字 | 説明文 | ||
| metadata | string | ~ 2048文字 | メタデータ | ||
| defaultExperience | long | ✓ | 0 | ~ 9223372036854775806 | 経験値の初期値 |
| defaultRankCap | long | ✓ | ~ 9223372036854775806 | ランクキャップの初期値 | |
| maxRankCap | long | ✓ | ~ 9223372036854775806 | ランクキャップの最大値 | |
| rankThresholdName | string | ✓ | ~ 128文字 | ランクアップ閾値 |
ThresholdMaster
ThresholdMaster
Type: GS2::Experience::ThresholdMaster
Properties:
NamespaceName: namespace1
Name: threshold-0001
Description: null
Metadata: null
Values:
- 100
- 200
- 300
ランクアップ閾値マスター
ランクアップ閾値は経験値からランク（レベル）を決定するために必要な数列です。 [10, 20] という値を設定した場合、経験値の値が 1~9 の間はランク1 10~19 の間はランク2 経験値の値が 20 でランク3 となりそれ以上経験値を入手することが出来なくなります。
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 32文字 | ネームスペース名 | |
| name | string | ✓ | ~ 128文字 | ランクアップ閾値名 | |
| description | string | ~ 1024文字 | 説明文 | ||
| metadata | string | ~ 2048文字 | メタデータ | ||
| values | long[] | ✓ | ランクアップ経験値閾値リスト |
CurrentExperienceMaster
CurrentExperienceMaster
Type: GS2::Experience::CurrentExperienceMaster
Properties:
NamespaceName: namespace1
Settings: {
"version": "2019-01-11",
"experienceModels": [
{
"name": "character_ssr",
"metadata": "SSR",
"defaultExperience": 0,
"defaultRankCap": 50,
"maxRankCap": 80,
"rankThreshold": {
"metadata": "CHARACTER",
"values": [
100,
200,
300,
400,
500,
600,
700,
800,
900,
1000,
1100,
1200,
1300,
1400,
1500,
1600,
1700,
1800,
1900,
2000,
2100,
2200,
2300,
2400,
2500,
2600,
2700,
2800,
2900,
3000,
3100,
3200,
3300,
3400,
3500,
3600,
3700,
3800,
3900,
4000,
4100,
4200,
4300,
4400,
4500,
4600,
4700,
4800,
4900,
5000,
5100,
5200,
5300,
5400,
5500,
5600,
5700,
5800,
5900,
6000,
6100,
6200,
6300,
6400,
6500,
6600,
6700,
6800,
6900,
7000,
7100,
7200,
7300,
7400,
7500,
7600,
7700,
7800,
7900
]
}
},
{
"name": "character_sr",
"metadata": "SR",
"defaultExperience": 0,
"defaultRankCap": 40,
"maxRankCap": 70,
"rankThreshold": {
"metadata": "CHARACTER",
"values": [
100,
200,
300,
400,
500,
600,
700,
800,
900,
1000,
1100,
1200,
1300,
1400,
1500,
1600,
1700,
1800,
1900,
2000,
2100,
2200,
2300,
2400,
2500,
2600,
2700,
2800,
2900,
3000,
3100,
3200,
3300,
3400,
3500,
3600,
3700,
3800,
3900,
4000,
4100,
4200,
4300,
4400,
4500,
4600,
4700,
4800,
4900,
5000,
5100,
5200,
5300,
5400,
5500,
5600,
5700,
5800,
5900,
6000,
6100,
6200,
6300,
6400,
6500,
6600,
6700,
6800,
6900,
7000,
7100,
7200,
7300,
7400,
7500,
7600,
7700,
7800,
7900
]
}
},
{
"name": "character_r",
"metadata": "R",
"defaultExperience": 0,
"defaultRankCap": 30,
"maxRankCap": 60,
"rankThreshold": {
"metadata": "CHARACTER",
"values": [
100,
200,
300,
400,
500,
600,
700,
800,
900,
1000,
1100,
1200,
1300,
1400,
1500,
1600,
1700,
1800,
1900,
2000,
2100,
2200,
2300,
2400,
2500,
2600,
2700,
2800,
2900,
3000,
3100,
3200,
3300,
3400,
3500,
3600,
3700,
3800,
3900,
4000,
4100,
4200,
4300,
4400,
4500,
4600,
4700,
4800,
4900,
5000,
5100,
5200,
5300,
5400,
5500,
5600,
5700,
5800,
5900,
6000,
6100,
6200,
6300,
6400,
6500,
6600,
6700,
6800,
6900,
7000,
7100,
7200,
7300,
7400,
7500,
7600,
7700,
7800,
7900
]
}
},
{
"name": "equipment",
"metadata": "EQUIPMENT",
"defaultExperience": 0,
"defaultRankCap": 30,
"maxRankCap": 50,
"rankThreshold": {
"metadata": "EQUIPMENT",
"values": [
200,
400,
600,
800,
1000,
1200,
1400,
1600,
1800,
2000,
2200,
2400,
2600,
2800,
3000,
3200,
3400,
3600,
3800,
4000,
4200,
4400,
4600,
4800,
5000,
5200,
5400,
5600,
5800,
6000,
6200,
6400,
6600,
6800,
7000,
7200,
7400,
7600,
7800,
8000,
8200,
8400,
8600,
8800,
9000,
9200,
9400,
9600,
9800
]
}
},
{
"name": "skill",
"metadata": "SKILL",
"defaultExperience": 0,
"defaultRankCap": 10,
"maxRankCap": 20,
"rankThreshold": {
"metadata": "SKILL",
"values": [
300,
600,
900,
1200,
1500,
1800,
2100,
2400,
2700,
3000,
3300,
3600,
3900,
4200,
4500,
4800,
5100,
5400,
5700
]
}
}
]
}
現在有効なマスターデータ
GS2ではマスターデータの管理にJSON形式のファイルを使用します。
ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。
JSONファイルを作成する方法として、マネージメントコンソール上でのマスターデータエディタを提供していますが
よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。
JSONファイルの形式についてはドキュメントを参照ください。
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 32文字 | ネームスペース名 | |
| settings | string | ✓ | ~ 5242880文字 | マスターデータ |