/tags/script/ Recent content in Script on Game Server Services | Docs Hugo en /articles/script/ Mon, 01 Jan 0001 00:00:00 +0000 /articles/script/ Extension methods available in GS2-Script extension scripts (Lua language). The Lua standard library is restricted inside the GS2-Script sandbox. Functions that load external resources or that catch errors internally — such as load, require, dofile, and pcall — are not available. The os library is also restricted for safety; only os.time() can be used. The table, string, and math libraries are available almost as-is. util.table_to_json Convert a Lua table type (array) to a JSON format string. /api_reference/account/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/account/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space. Therefore, you must create a namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/ad_reward/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/ad_reward/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space. Therefore, you must create a namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/auth/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/auth/sdk/ Models AccessToken Access token A model that manages access tokens issued after user authentication. Access tokens are used to identify a session while a user is logged in to the service. Tokens have an expiration time, and when they expire, re-authentication is required. Details Type Condition Required Default Value Limits Description token string ✓ ~ 1024 chars Access tokenA token used to authenticate access.This token is automatically generated by the system and identifies the user’s session. /api_reference/buff/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/buff/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the Namespace differs, the data is treated as a completely independent data space. Therefore, you must create a Namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/chat/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/chat/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the Namespace differs, the data is treated as a completely independent data space. Therefore, you must create a Namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/datastore/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/datastore/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space. Therefore, you must create a namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/deploy/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/deploy/sdk/ Models GitHubCheckoutSetting Setting for checking out master data from GitHub Configuration for fetching template or master data files directly from a GitHub repository. Supports referencing by commit hash, branch name, or tag name, and requires a GS2-Key GitHub API key for authentication. Details Type Condition Required Default Value Limits Description apiKeyId string ✓ ~ 1024 chars GitHub API Key GRN repositoryName string ✓ ~ 1024 chars Repository NameThe GitHub repository name in “owner/repo” format from which to fetch the file. /api_reference/dictionary/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/dictionary/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space. Therefore, you must create a namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/distributor/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/distributor/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space. Therefore, you must create a namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/enchant/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/enchant/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space. Therefore, you must create a namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/enhance/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/enhance/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space. Therefore, you must create a namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/exchange/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/exchange/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space. Therefore, you must create a namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/experience/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/experience/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space. Therefore, you must create a namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/formation/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/formation/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space. Therefore, you must create a namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/freeze/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/freeze/sdk/ Models Output Output of stage update progress Represents a log entry generated during a stage version update operation. Each output captures a step or event in the update process. Outputs are automatically cleaned up after 30 days. Details Type Condition Required Default Value Limits Description outputId string * ~ 1024 chars Stage update progress output GRN * Set automatically by the server name string ✓ UUID ~ 36 chars Output NameMaintains a unique name for each output of stage update progress. /api_reference/friend/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/friend/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space. Therefore, you must create a namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/gateway/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/gateway/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space. Therefore, you must create a namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/grade/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/grade/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space. Therefore, you must create a namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/guard/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/guard/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space. Therefore, you must create a namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/guild/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/guild/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space. Therefore, you must create a namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/identifier/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/identifier/sdk/ Models Identifier Credential Credentials used to access the GS2 API. A credential consists of a client ID and a client secret, and access using the credential is restricted based on the privileges of the user who owns the credential. Details Type Condition Required Default Value Limits Description clientId string ✓ UUID ~ 256 chars Client ID userName string ✓ ~ 128 chars User NameThe name of the GS2-Identifier user who owns this credential. /api_reference/idle/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/idle/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the Namespace differs, the data is treated as a completely independent data space. Therefore, you must create a Namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/inbox/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/inbox/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space. Therefore, you must create a namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/inventory/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/inventory/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space. Therefore, you must create a namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/job_queue/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/job_queue/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space. Therefore, you must create a namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/key/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/key/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the Namespace differs, the data is treated as a completely independent data space. Therefore, you must create a Namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/limit/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/limit/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space. Therefore, you must create a namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/lock/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/lock/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the Namespace differs, the data is treated as a completely independent data space. Therefore, you must create a Namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/log/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/log/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the Namespace differs, the data is treated as a completely independent data space. Therefore, you must create a Namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/login_reward/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/login_reward/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space. Therefore, you must create a namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/lottery/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/lottery/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space. Therefore, you must create a namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/matchmaking/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/matchmaking/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space. Therefore, you must create a namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/mega_field/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/mega_field/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space. Therefore, you must create a namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/mission/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/mission/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space. Therefore, you must create a namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/money/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/money/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space. Therefore, you must create a namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/money2/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/money2/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space. Therefore, you must create a namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/news/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/news/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space. Therefore, you must create a namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/quest/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/quest/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space. Therefore, you must create a namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/ranking/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/ranking/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space. Therefore, you must create a namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/ranking2/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/ranking2/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space. Therefore, you must create a namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/realtime/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/realtime/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space. Therefore, you must create a namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/schedule/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/schedule/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space. Therefore, you must create a namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/script/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/script/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space. Therefore, you must create a namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/season_rating/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/season_rating/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space. Therefore, you must create a namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/serial_key/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/serial_key/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space. Therefore, you must create a namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/showcase/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/showcase/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space. Therefore, you must create a namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/skill_tree/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/skill_tree/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space. Therefore, you must create a namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/stamina/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/stamina/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space. Therefore, you must create a namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/state_machine/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/state_machine/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space. Therefore, you must create a namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/version/sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/version/sdk/ Models Namespace Namespace A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space. Therefore, you must create a namespace before you can start using each service. Details Type Condition Required Default Value Limits Description namespaceId string * ~ 1024 chars Namespace GRN * Set automatically by the server name string ✓ ~ 128 chars Namespace nameNamespace-specific name. /api_reference/account/script/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/account/script/ Trigger createAccount Account creation Synchronous Execution Script The script is executed synchronously before the account creation process. Request Type Description namespace Namespace Namespace account Account Game Player Account Result Type Required Default Value Limits Description permit bool ✓ Whether to allow account creation Implementation Example Lua -- Request local namespace = args.namespace local account = args.account -- Business logic: local permit = true -- Result result = { permit=permit } Asynchronous Execution Script The script is executed asynchronously after the account creation process. /api_reference/ad_reward/script/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/ad_reward/script/ Trigger acquirePoint Point acquisition Synchronous Execution Script The script is executed synchronously before the point acquisition process. Request Type Description namespace Namespace Namespace point Point Point before acquisition processing acquirePointValue long Amount of points to be acquired Result Type Required Default Value Limits Description permit bool ✓ Whether to allow point acquisition overridePointValue long 0 ~ 2147483645 Amount of points to override the acquisition value Implementation Example Lua -- Request local namespace = args. /api_reference/buff/script/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/buff/script/ Trigger apply Buff application Synchronous Execution Script The script is executed synchronously before the buff application process. Request Type Description namespace Namespace Namespace buffEntryModel BuffEntryModel Buff Entry Model userId string User ID Result Type Required Default Value Limits Description permit bool ✓ Whether to allow the buff to be applied overrideBuffRate float ✓ 0 ~ 100 Override rate applied to the buff (multiplier) Implementation Example Lua -- Request local namespace = args. /api_reference/chat/script/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/chat/script/ Trigger createRoom Room creation Synchronous Execution Script The script is executed synchronously before the room creation process. Request Type Description namespace Namespace Namespace room Room Room Result Type Required Default Value Limits Description permit bool ✓ Whether to allow room creation Implementation Example Lua -- Request local namespace = args.namespace local room = args.room -- Business logic: local permit = true -- Result result = { permit=permit } Asynchronous Execution Script The script is executed asynchronously after the room creation process. /api_reference/datastore/script/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/datastore/script/ Trigger doneUpload Report completion of data object upload Synchronous Execution Script The script is executed synchronously before the report completion of data object upload process. Request Type Description namespace Namespace Namespace dataObject DataObject Data object objectUrl string URL of the uploaded object Result Type Required Default Value Limits Description permit bool ✓ Whether to allow report completion of data object upload Implementation Example Lua -- Request local namespace = args.namespace local dataObject = args. /api_reference/dictionary/script/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/dictionary/script/ Trigger entry entry registration Synchronous Execution Script The script is executed synchronously before the entry registration process. Request Type Description namespace Namespace Namespace entryModels EntryModel[] List of Entry Models userId string User ID Result Type Required Default Value Limits Description permit bool ✓ Whether to allow entry registration Implementation Example Lua -- Request local namespace = args.namespace local entryModels = args.entryModels local userId = args.userId -- Business logic: local permit = true -- Result result = { permit=permit } Asynchronous Execution Script The script is executed asynchronously after the entry registration process. /api_reference/enhance/script/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/enhance/script/ Trigger enhance enhancement execution Synchronous Execution Script The script is executed synchronously before the enhancement execution process. Request Type Description namespace Namespace Namespace rateModel RateModel Enhanced Rate Model targetItemSetId string GRN for the enhanced Item Set bonusRate float Experience bonus multiplier (1.0 = no bonus) experienceValue long Amount of experience gained Result Type Required Default Value Limits Description permit bool ✓ Whether to allow enhancement execution overrideExperienceValue long 0 ~ 2147483645 Amount of gained experience to override Implementation Example Lua -- Request local namespace = args. /api_reference/exchange/script/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/exchange/script/ Trigger exchange Exchange Synchronous Execution Script The script is executed synchronously before the exchange process. Request Type Description namespace Namespace Namespace rateModel RateModel Exchange Rate Model userId string User ID performing the exchange count int Exchanging volume config Config[] Configuration values applied to transaction variables Result Type Required Default Value Limits Description permit bool ✓ Whether to allow exchange rateMode string ✓ “float” Rate mode rate float 1.0 0 ~ 1000 Acquisition quantity rate logRate LogRate Logarithmic acquisition correction Implementation Example Lua -- Request local namespace = args. /api_reference/experience/script/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/experience/script/ Trigger rankCapScript obtaining rank caps Synchronous Execution Script The script is executed synchronously before the obtaining rank caps process. Request Type Description namespace Namespace Namespace experienceModel ExperienceModel Experience Model userId string User ID propertyId string Property IDA developer-defined identifier that uniquely identifies this status within the user’s scope. It is recommended to use a value that appends an experience model suffix to the GS2-Inventory Item Set GRN or GS2-Dictionary Entry GRN that possesses the experience. /api_reference/formation/script/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/formation/script/ Trigger updateMold Form Storage Area capacity update Synchronous Execution Script The script is executed synchronously before the form storage area capacity update process. Request Type Description namespace Namespace Namespace mold Mold Form Storage Area before update afterMold Mold Form Storage Area after update Result Type Required Default Value Limits Description permit bool ✓ Whether to allow Form Storage Area capacity update Implementation Example Lua -- Request local namespace = args.namespace local mold = args. /api_reference/friend/script/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/friend/script/ Trigger updateProfile Update profile Synchronous Execution Script The script is executed synchronously before the update profile process. Request Type Description namespace Namespace Namespace profile Profile Profile oldProfile Profile Old profile publicProfile string New Public profile followerProfile string New profile for followers friendProfile string New profile for friends Result Type Required Default Value Limits Description permit bool ✓ Whether to allow update profile Implementation Example Lua -- Request local namespace = args. /api_reference/grade/script/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/grade/script/ Trigger changeGrade grade changes Synchronous Execution Script The script is executed synchronously before the grade changes process. Request Type Description namespace Namespace Namespace gradeModel GradeModel Grade Model status Status Status before change afterStatus Status Status after change Result Type Required Default Value Limits Description permit bool ✓ Whether to allow grade changes overrideGradeValue long ✓ 0 ~ 2147483645 Overriding grade value Implementation Example Lua -- Request local namespace = args.namespace local gradeModel = args. /api_reference/guild/script/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/guild/script/ Trigger createGuild Creating guild Synchronous Execution Script The script is executed synchronously before the creating guild process. Request Type Description namespace Namespace Namespace guildModel GuildModel Guild Model guild Guild Guild Result Type Required Default Value Limits Description permit bool ✓ Whether to allow creating guild Implementation Example Lua -- Request local namespace = args.namespace local guildModel = args.guildModel local guild = args.guild -- Business logic: local permit = true -- Result result = { permit=permit } Asynchronous Execution Script The script is executed asynchronously after the creating guild process. /api_reference/idle/script/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/idle/script/ Trigger receive Receiving rewards Synchronous Execution Script The script is executed synchronously before the receiving rewards process. Request Type Description namespace Namespace Namespace category CategoryModel Category Model userId string User ID executing reward receive status Status Status acquireActions AcquireAction[] Rewards config Config[] Configuration values applied to transaction variables Result Type Required Default Value Limits Description permit bool ✓ Whether to allow receiving rewards rate float 1.0 0 ~ 1000 Acquisition quantity rate Implementation Example Lua -- Request local namespace = args. /api_reference/inbox/script/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/inbox/script/ Trigger receiveMessage Message reception Synchronous Execution Script The script is executed synchronously before the message reception process. Request Type Description namespace Namespace Namespace message Message Message Result Type Required Default Value Limits Description permit bool ✓ Whether to allow message reception overrideMetadata string 0 ~ 4096 chars Overwritten metadata Implementation Example Lua -- Request local namespace = args.namespace local message = args.message -- Business logic: local permit = true local overrideMetadata = " /api_reference/inventory/script/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/inventory/script/ Trigger acquire Item acquisition Synchronous Execution Script The script is executed synchronously before the item acquisition process. Request Type Description namespace Namespace Namespace inventory Inventory Inventory itemSets ItemSet[] List of Item Sets acquireItemName string Name of Item Model acquired userId string User ID acquireCount long Quantity acquired expiresAt long Expiration timeUnix time, milliseconds Result Type Required Default Value Limits Description permit bool ✓ Whether to allow item acquisition overrideAcquireCount int 0 ~ 2147483645 Actual amount obtained to be applied Implementation Example Lua -- Request local namespace = args. /api_reference/limit/script/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/limit/script/ Trigger countUp Count up Synchronous Execution Script The script is executed synchronously before the count up process. Request Type Description namespace Namespace Namespace limitModel LimitModel Usage Limit Model counter Counter Counter userId string User ID countUpValue int Amount to count up maxValue int Maximum value allowed to count up Result Type Required Default Value Limits Description permit bool ✓ Whether to allow count up Implementation Example Lua -- Request local namespace = args. /api_reference/login_reward/script/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/login_reward/script/ Trigger receive Receive Synchronous Execution Script The script is executed synchronously before the receive process. Request Type Description namespace Namespace Namespace bonusModel BonusModel Login Bonus Model userId string User ID performing the loginReward receiveStep int Received step config Config[] Configuration values applied to transaction variables Result Type Required Default Value Limits Description permit bool ✓ Whether to allow the purchase Implementation Example Lua -- Request local namespace = args.namespace local bonusModel = args. /api_reference/lottery/script/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/lottery/script/ Trigger lottery Lottery Synchronous Execution Script The script is executed synchronously before the lottery process. Request Type Description namespace Namespace Namespace lotteryModel LotteryModel Lottery Model name drawnPrizes DrawnPrize[] List of Drawn Prizes boxItems BoxItems Box state including prizes and their remaining/initial quantities Result Type Required Default Value Limits Description permit bool ✓ Whether to allow lottery overrideDrawnPrizes DrawnPrize[] 0 ~ 1000 items List of Drawn Prizes to override the result Implementation Example Lua -- Request local namespace = args. /api_reference/matchmaking/script/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/matchmaking/script/ Trigger createGathering creating a new gathering Synchronous Execution Script The script is executed synchronously before the creating a new gathering process. Request Type Description namespace Namespace Namespace gathering Gathering Gathering Implementation Example Lua -- Request local namespace = args.namespace local gathering = args.gathering -- Business logic: -- Result result = { } completeMatchmaking matchmaking is complete Synchronous Execution Script The script is executed synchronously before the matchmaking is complete process. /api_reference/mission/script/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/mission/script/ Trigger missionComplete Mission accomplishment Synchronous Execution Script The script is executed synchronously before the mission accomplishment process. Request Type Description namespace Namespace Namespace missionGroupModel MissionGroupModel Mission Group oldComplete Complete Completion Status before completion newComplete Complete Completion Status after completion completeTaskNames [] List of completed task names Result Type Required Default Value Limits Description permit bool ✓ Whether to allow mission accomplishment Implementation Example Lua -- Request local namespace = args.namespace local missionGroupModel = args. /api_reference/money/script/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/money/script/ Trigger createWallet wallet creation Synchronous Execution Script The script is executed synchronously before the wallet creation process. Request Type Description namespace Namespace Namespace wallet Wallet Wallet Result Type Required Default Value Limits Description permit bool ✓ Whether to allow wallet creation initialAmount int ✓ 0 ~ 2147483645 Initial Wallet balance - will be credited as a free grant Implementation Example Lua -- Request local namespace = args.namespace local wallet = args. /api_reference/money2/script/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/money2/script/ Trigger deposit Wallet balance addition Synchronous Execution Script The script is executed synchronously before the wallet balance addition process. Request Type Description namespace Namespace Namespace oldWallet Wallet Wallet before deposit newWallet Wallet Wallet after deposit transactions DepositTransaction[] List of occurred transactions count int Amount of balance to be added Result Type Required Default Value Limits Description permit bool ✓ Whether to allow wallet balance addition Implementation Example Lua -- Request local namespace = args. /api_reference/quest/script/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/quest/script/ Trigger startQuest Quest start Synchronous Execution Script The script is executed synchronously before the quest start process. Request Type Description namespace Namespace Namespace questGroupModel QuestGroupModel Quest Group Model questModel QuestModel Quest Model randomSeed long random number seed rewards Reward[] List of rewards earned from quests userId string User ID config Config[] Configuration values applied to transaction variables Result Type Required Default Value Limits Description permit bool ✓ Whether to allow the quest to begin overrideRandomSeed long 0 ~ 9223372036854775805 Random number seed overrideRewards Reward[] 0 ~ 1000 items List of rewards earned from quests Implementation Example Lua -- Request local namespace = args. /api_reference/showcase/script/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/showcase/script/ Trigger buy Buy Synchronous Execution Script The script is executed synchronously before the buy process. Request Type Description namespace Namespace Namespace showcase Showcase Showcase model displayItem DisplayItem DisplayItem model userId string User ID of the user executing the purchase quantity int Purchase quantity config Config[] Configuration values applied to transaction variables Result Type Required Default Value Limits Description permit bool ✓ Whether to allow the purchase Implementation Example Lua -- Request local namespace = args. /api_reference/skill_tree/script/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/skill_tree/script/ Trigger release Release node Synchronous Execution Script The script is executed synchronously before the release node process. Request Type Description namespace Namespace Namespace oldStatus Status Status before update newStatus Status Status after update userId string User ID nodeModelNames [] List of node model names Result Type Required Default Value Limits Description permit bool ✓ Whether to allow release node Implementation Example Lua -- Request local namespace = args.namespace local oldStatus = args. /api_reference/stamina/script/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/stamina/script/ Trigger overflow Stamina maximum value overflow Synchronous Execution Script The script is executed synchronously before the stamina maximum value overflow process. Request Type Description namespace Namespace Namespace staminaModel StaminaModel Stamina Model stamina Stamina Stamina overflowValue long Overflow value Implementation Example Lua -- Request local namespace = args.namespace local staminaModel = args.staminaModel local stamina = args.stamina local overflowValue = args.overflowValue -- Business logic: -- Result result = { } /api_reference/state_machine/script/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/state_machine/script/ Trigger start Start state machine Synchronous Execution Script The script is executed synchronously before the start state machine process. Request Type Description namespace Namespace Namespace stateMachineMaster StateMachineMaster State machine master data status Status Status userId string User ID parameters string Arguments to be passed to the state machine Result Type Required Default Value Limits Description permit bool ✓ Whether to allow start Implementation Example Lua -- Request local namespace = args. /api_reference/version/script/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/version/script/ Trigger acceptVersion Version approval Synchronous Execution Script The script is executed synchronously before the version approval process. Request Type Description namespace Namespace Namespace versionModel VersionModel Version Model acceptVersion AcceptVersion Agreed Version currentAcceptVersion AcceptVersion Current Agreed Version Result Type Required Default Value Limits Description permit bool ✓ Whether to allow version approval Implementation Example Lua -- Request local namespace = args.namespace local versionModel = args.versionModel local acceptVersion = args.acceptVersion local currentAcceptVersion = args.