GS2-Script GS2-Deploy/CDK リファレンス
エンティティ
Namespace
ネームスペース
ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。
GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。
そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| name | string | ✓ | ~ 128文字 | ネームスペース名 | ||
| description | string | ~ 1024文字 | 説明文 | |||
| transactionSetting | TransactionSetting | トランザクション設定 | ||||
| logSetting | LogSetting | ログの出力設定 |
GetAttr
!GetAttrタグで取得可能なリソースの生成結果
| 型 | 説明 | |
|---|---|---|
| Item | Namespace | 作成したネームスペース |
実装例
Type: GS2::Script::Namespace
Properties:
Name: namespace-0001
Description: null
TransactionSetting: null
LogSetting:
LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001import (
"github.com/gs2io/gs2-golang-cdk/core"
"github.com/gs2io/gs2-golang-cdk/script"
"github.com/openlyinc/pointy"
)
SampleStack := core.NewStack()
script.NewNamespace(
&SampleStack,
"namespace-0001",
script.NamespaceOptions{
LogSetting: &core.LogSetting{
LoggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001",
},
},
)
println(SampleStack.Yaml()) // Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
new \Gs2Cdk\Script\Model\Namespace_(
stack: $this,
name: "namespace-0001",
options: new \Gs2Cdk\Script\Model\Options\NamespaceOptions(
logSetting: new \Gs2Cdk\Core\Model\LogSetting(
loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
)
)
);
}
}
print((new SampleStack())->yaml()); // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
public SampleStack() {
super();
new io.gs2.cdk.script.model.Namespace(
this,
"namespace-0001",
new io.gs2.cdk.script.model.options.NamespaceOptions()
.withLogSetting(new io.gs2.cdk.core.model.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
))
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Templatepublic class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Script.Model.Namespace(
stack: this,
name: "namespace-0001",
options: new Gs2Cdk.Gs2Script.Model.Options.NamespaceOptions
{
logSetting = new Gs2Cdk.Core.Model.LogSetting(
loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
)
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Templateimport core from "@/gs2cdk/core";
import script from "@/gs2cdk/script";
class SampleStack extends core.Stack
{
public constructor() {
super();
new script.model.Namespace(
this,
"namespace-0001",
{
logSetting: new core.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
)
}
);
}
}
console.log(new SampleStack().yaml()); // Generate Template
from gs2_cdk import Stack, core, script
class SampleStack(Stack):
def __init__(self):
super().__init__()
script.Namespace(
stack=self,
name='namespace-0001',
options=script.NamespaceOptions(
log_setting=core.LogSetting(
logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
),
),
)
print(SampleStack().yaml()) # Generate TemplateScript
スクリプト
GS2 では標準の機能だけで機能を実現できない時のためにスクリプトで機能を拡張できるようになっています。
スクリプトは Lua 言語で記述することができます。
スクリプト内から GS2 のサービスのデータを取得することもできますので、柔軟な処理を記述できます。
詳細はドキュメントを参照してください。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128文字 | ネームスペース名 | ||
| name | string | ✓ | ~ 128文字 | スクリプト名 | ||
| description | string | ~ 1024文字 | 説明文 | |||
| script | string | ✓ | ~ 5242880文字 | Luaスクリプト | ||
| disableStringNumberToNumber | bool | ✓ | false | 数値のみで構成された文字列を数値に変換しない |
GetAttr
!GetAttrタグで取得可能なリソースの生成結果
| 型 | 説明 | |
|---|---|---|
| Item | Script | 作成したスクリプト |
実装例
Type: GS2::Script::Script
Properties:
NamespaceName: namespace-0001
Name: script-0001
Description: null
Script: result = {permit=true}
DisableStringNumberToNumber: nullimport (
"github.com/gs2io/gs2-golang-cdk/core"
"github.com/gs2io/gs2-golang-cdk/script"
"github.com/openlyinc/pointy"
)
SampleStack := core.NewStack()
script.NewScript(
&SampleStack,
"namespace-0001",
"script-0001",
"result = {permit=true}",
script.ScriptOptions{},
)
println(SampleStack.Yaml()) // Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
new \Gs2Cdk\Script\Model\Script(
stack: $this,
namespaceName: "namespace-0001",
name: "script-0001",
script: "result = {permit=true}"
);
}
}
print((new SampleStack())->yaml()); // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
public SampleStack() {
super();
new io.gs2.cdk.script.model.Script(
this,
"namespace-0001",
"script-0001",
"result = {permit=true}"
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Templatepublic class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Script.Model.Script(
stack: this,
namespaceName: "namespace-0001",
name: "script-0001",
script: "result = {permit=true}"
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Templateimport core from "@/gs2cdk/core";
import script from "@/gs2cdk/script";
class SampleStack extends core.Stack
{
public constructor() {
super();
new script.model.Script(
this,
"namespace-0001",
"script-0001",
"result = {permit=true}"
);
}
}
console.log(new SampleStack().yaml()); // Generate Template
from gs2_cdk import Stack, core, script
class SampleStack(Stack):
def __init__(self):
super().__init__()
script.Script(
stack=self,
namespace_name='namespace-0001',
name='script-0001',
script='result = {permit=true}',
)
print(SampleStack().yaml()) # Generate TemplateRandomStatus
乱数の状態
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| seed | long | ✓ | 0 ~ 4294967294 | 乱数シード | ||
| used | List<RandomUsed> | 0 ~ 1000 items | 使用済み乱数リスト |
RandomUsed
使用済み乱数
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| category | long | ✓ | 0 ~ 4294967294 | カテゴリ | ||
| used | long | ✓ | 0 ~ 4294967294 | 使用済み乱数 |
AcquireAction
入手アクション
ConsumeAction
消費アクション
VerifyAction
検証アクション
Transaction
トランザクション
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| transactionId | string | ~ 128文字 | トランザクションID | |||
| verifyActions | List<VerifyAction> | 0 ~ 100 items | 検証アクションのリスト | |||
| consumeActions | List<ConsumeAction> | [] | 0 ~ 100 items | 消費アクションのリスト | ||
| acquireActions | List<AcquireAction> | [] | 0 ~ 100 items | 入手アクションのリスト |
VerifyActionResult
検証アクションの実行結果
ConsumeActionResult
消費アクションの実行結果
AcquireActionResult
入手アクションの実行結果
TransactionResult
トランザクション実行結果
サーバーサイドでのトランザクションの自動実行機能を利用して実行されたトランザクションの実行結果
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| transactionId | string | ✓ | 36 ~ 36文字 | トランザクションID | ||
| verifyResults | List<VerifyActionResult> | 0 ~ 10 items | 検証アクションの実行結果リスト | |||
| consumeResults | List<ConsumeActionResult> | [] | 0 ~ 10 items | 消費アクションの実行結果リスト | ||
| acquireResults | List<AcquireActionResult> | [] | 0 ~ 100 items | 入手アクションの実行結果リスト | ||
| hasError | bool | ✓ | false | トランザクション実行中にエラーが発生したかどうか |
TransactionSetting
トランザクション設定
トランザクション設定は、トランザクションの実行方法・整合性・非同期処理・競合回避の仕組みを制御する設定です。
自動実行(AutoRun)、アトミック実行(AtomicCommit)、非同期実行(Distributor)、スクリプト結果の一括適用、JobQueue による入手アクションの非同期化などを組み合わせ、ゲームロジックに応じた堅牢なトランザクション管理を可能にします。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| enableAutoRun | bool | ✓ | false | 発行したトランザクションをサーバーサイドで自動的に実行するか | ||
| enableAtomicCommit | bool | {enableAutoRun} == true | ✓* | false | トランザクションの実行をアトミックにコミットするか ※ enableAutoRun が true であれば必須 | |
| transactionUseDistributor | bool | {enableAtomicCommit} == true | ✓* | false | トランザクションを非同期処理で実行する ※ enableAtomicCommit が true であれば必須 | |
| commitScriptResultInUseDistributor | bool | {transactionUseDistributor} == true | ✓* | false | スクリプトの結果コミット処理を非同期処理で実行するか ※ transactionUseDistributor が true であれば必須 | |
| acquireActionUseJobQueue | bool | {enableAtomicCommit} == true | ✓* | false | 入手アクションを実行する際に GS2-JobQueue を使用するか ※ enableAtomicCommit が true であれば必須 | |
| distributorNamespaceId | string | ✓ | “grn:gs2:{region}:{ownerId}:distributor:default” | ~ 1024文字 | トランザクションの実行に使用する GS2-Distributor ネームスペース | |
| queueNamespaceId | string | ✓ | “grn:gs2:{region}:{ownerId}:queue:default” | ~ 1024文字 | トランザクションの実行に使用する GS2-JobQueue のネームスペース |
LogSetting
ログの書き出し設定
ログデータの書き出し設定を管理します。この型は、ログデータを書き出すために使用される GS2-Log 名前空間の識別子(Namespace ID)を保持します。
ログ名前空間ID(loggingNamespaceId)には、ログデータを収集し保存する GS2-Log の名前空間を、GRNの形式で指定します。
この設定をすることで、設定された名前空間内で発生したAPIリクエスト・レスポンスのログデータが、対象の GS2-Log 名前空間側へ出力されるようになります。
GS2-Log ではリアルタイムでログが提供され、システムの監視や分析、デバッグなどに利用できます。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| loggingNamespaceId | string | ✓ | ~ 1024文字 | ログを出力する GS2-Log のネームスペースGRN |
GitHubCheckoutSetting
GitHubからマスターデータをチェックアウトする設定
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| apiKeyId | string | ✓ | ~ 1024文字 | GitHub APIキーのGRN | ||||||||||
| repositoryName | string | ✓ | ~ 1024文字 | リポジトリ名 | ||||||||||
| sourcePath | string | ✓ | ~ 1024文字 | マスターデータ(JSON)ファイルのパス | ||||||||||
| referenceType | 文字列列挙型 enum { “commit_hash”, “branch”, “tag” } | ✓ | ~ 128文字 | コードの取得元
| ||||||||||
| commitHash | string | {referenceType} == “commit_hash” | ✓* | ~ 1024文字 | コミットハッシュ ※ referenceType が “commit_hash” であれば必須 | |||||||||
| branchName | string | {referenceType} == “branch” | ✓* | ~ 1024文字 | ブランチ名 ※ referenceType が “branch” であれば必須 | |||||||||
| tagName | string | {referenceType} == “tag” | ✓* | ~ 1024文字 | タグ名 ※ referenceType が “tag” であれば必須 |