/tags/game-engine/ Recent content in Game Engine on Game Server Services | Docs Hugo en /get_start/tutorial/coding/all/ Mon, 01 Jan 0001 00:00:00 +0000 /get_start/tutorial/coding/all/ Game Engine: Unity Unreal Engine using System.Collections; using Gs2.Core.Model; using Gs2.Unity.Core; using Gs2.Unity.Gs2Account.Model; using Gs2.Unity.Util; using UnityEngine; public class Tutorial : MonoBehaviour { IEnumerator Start() { // Setup variables var clientId = "YourClientId"; var clientSecret = "YourClientSecret"; var accountNamespaceName = "game-0001"; // Initialize GS2 SDK Gs2Domain gs2; { var future = Gs2Client.CreateFuture( new BasicGs2Credential( clientId, clientSecret ), Region.ApNortheast1 ); yield return future; if (future.Error != null) { throw future.Error; } gs2 = future. /api_reference/transaction/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/transaction/game_engine/ What is Transaction Processing? Transaction processing in GS2 refers to the mass execution of exchanging resources defined as “consume action” and “get action”. APIs that issue transactions are such as GS2-Exchange’s exchange execution function (Exchange), GS2-Showcase’s product purchase function (Buy), and GS2-Quest’s quest start function (Start). Consumption actions" are user data operations that are disadvantageous to the player, while “acquisition actions” are user data operations that are beneficial to the player. /get_start/ Mon, 01 Jan 0001 00:00:00 +0000 /get_start/ SDK Game Engine Game Server Services provides SDKs for all major game engines. The SDK for game engines is provided in a higher level API format than the regular SDK, with a focus on use from within the game. Language: Unity Unreal Engine 5 GS2 SDK for Unity This SDK is distributed under the Apache License 2.0. You must clearly indicate somewhere in your program that you are using libraries provided under the Apache License 2. /api_reference/account/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/account/game_engine/ Models EzAccount Game Player Account An entity of identity information that identifies a game player. Game player accounts are anonymous accounts and consist of a user ID (UUID) and password (a random 32-character string), so game players do not need to enter their email address or other information. The issued Game Player Account is stored in the device’s local storage and is used for future logins. Type Condition Required Default Value Limits Description userId string ✓ UUID ~ 128 chars User ID password string ✓ ~ 128 chars PasswordStores the password for securing the account. /api_reference/ad_reward/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/ad_reward/game_engine/ Models EzPoint Ad Viewing Points Records the total number of points earned by the player by viewing ads. Each time a player views an ad, they earn points, which can be used to exchange rewards or purchase in-game benefits. Type Condition Required Default Value Limits Description point long 0 0 ~ 9223372036854775805 Number of points heldIndicates the number of points held by the user.This value increases as the user views ads and decreases as they exchange rewards and benefits. /api_reference/auth/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/auth/game_engine/ Models EzAccessToken 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. 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/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/buff/game_engine/ Models EzBuffEntryModel Buff Entry Model The amount of buff is managed by BuffEntryModels, and multiple Buff Entry Models can be associated with the same target. The application order of BuffEntryModel is managed by the priority of BuffEntryModel, and the smaller the value of priority, the higher the priority. Three buff application methods exist: “Rate Add”, “Mul”, and “Value Add”. Rate Add is an instruction that adds to the buff application rate. /api_reference/chat/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/chat/game_engine/ Models EzRoom Room A room represents the scope within which chat messages can be delivered. GS2-Chat rooms do not have the concept of participation. Therefore, to receive messages, it is sufficient to know the room name, and there is no need to join the room or register as a member. If you wish to limit the number of game players who can view the messages in a room, there are two options. /api_reference/datastore/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/datastore/game_engine/ Models EzDataObject Data Object Data objects are data uploaded by game players. Data is generation managed, with 30 days of historical data stored. Access permissions can be set for the data. There are three types of scopes: public: Accessible to anyone protected: Accessible only to game players with specified user IDs private: Accessible only to yourself Type Condition Required Default Value Limits Description dataObjectId string * ~ 1024 chars Data object GRN * Set automatically by the server name string ✓ UUID ~ 128 chars Data Object NameA unique name identifying the data object. /api_reference/dictionary/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/dictionary/game_engine/ Models EzEntry Entry acquired by game player Represents a single dictionary entry that a game player has collected. Each entry corresponds to an EntryModel and records the acquisition timestamp. The possession state is binary—either the entry exists (collected) or it does not—with no concept of quantity. Type Condition Required Default Value Limits Description entryId string * ~ 1024 chars Entry GRN * Set automatically by the server userId string ~ 128 chars User ID name string ✓ ~ 128 chars Entry Model nameEntry Model-specific name. /api_reference/distributor/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/distributor/game_engine/ Models EzStampSheetResult Transaction execution result (Legacy) Records the execution results of a transaction processed via server-side auto-execution. Contains the request payloads and response results for each phase: verify actions (precondition checks), consume actions (that deduct resources), and the acquire action (that grants resources). Also tracks HTTP status codes for error detection and retry logic. Type Condition Required Default Value Limits Description transactionId string ✓ 36 ~ 36 chars Transaction IDA UUID that uniquely identifies this transaction. /api_reference/enchant/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/enchant/game_engine/ Models EzBalanceParameterStatus Balance Parameter Status Represents the actual parameter values drawn for a specific resource owned by a user. Each status is associated with a Balance Parameter Model and contains the concrete values assigned to each parameter slot after the drawing process. Type Condition Required Default Value Limits Description parameterName string ✓ ~ 128 chars Balance Parameter Model nameThe name of the Balance Parameter Model that defines the drawing conditions for this status. /api_reference/enhance/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/enhance/game_engine/ Models EzProgress Enhance Progress It is created at the beginning of the enhance and deleted at the end. When you exit the application in the middle of an enhance, this data will remain. It is possible to resume the game from the ongoing enhance information maintained by the entity. Type Condition Required Default Value Limits Description name string ✓ UUID ~ 36 chars Progress IDMaintains a unique name for each enhance progress. /api_reference/exchange/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/exchange/game_engine/ Models EzAwait Exchange Await Represents the execution state of an exchange that requires real-time to elapse before rewards can be claimed. Created when a player initiates an exchange with await timing type, and tracks the waiting period until the rewards become available. Supports skip functionality to shorten or eliminate the waiting time, and stores default configuration values for reward acquisition. Type Condition Required Default Value Limits Description userId string ✓ ~ 128 chars User ID rateName string ✓ ~ 128 chars Exchange Rate Model nameExchange Rate Model-specific name. /api_reference/experience/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/experience/game_engine/ Models EzStatus Status Status is an entity that exists for each property ID. Holds the current experience and rank cap values. Property ID is a status-specific ID and can be set to any value by the developer. For GS2, it is recommended to use a value as the property ID that adds an experience point model suffix to the end of the Item Set GRN in GS2-Inventory or the Entry GRN in GS2-Dictionary that possesses experience points. /api_reference/formation/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/formation/game_engine/ Models EzMold Form Storage Area An entity that holds information organized by the game player. Form information can be stored multiple times per Form Storage Area, and the capacity—how many can be stored—can be set individually for each game player × Form Storage Area. Type Condition Required Default Value Limits Description name string ✓ ~ 128 chars Form Storage Area Model nameForm Storage Area Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (. /api_reference/friend/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/friend/game_engine/ Models EzProfile Profile The profile stores information about the game player. There are three types of profiles that can be set for each public range. friend The information that can be viewed by those with whom a friend relationship has been established. follow Content that can be viewed by followers. public Content that can be viewed by anyone Type Condition Required Default Value Limits Description userId string ✓ ~ 128 chars User ID publicProfile string ~ 1024 chars Public profileProfile information visible to all players regardless of relationship. /api_reference/gateway/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/gateway/game_engine/ Models EzWebSocketSession WebSocketSession A WebSocket session is a persistent connection between a GS2 server and a client for real-time bidirectional communication. The client registers a user ID as an identifier to the server. Type Condition Required Default Value Limits Description connectionId string ✓ ~ 128 chars Connection IDThe unique identifier assigned to this WebSocket connection. Used to identify the specific client connection when sending notifications. namespaceName string ✓ ~ 128 chars Namespace name userId string ✓ ~ 128 chars User ID Related methods: setUserId - Register the player's connection to receive server push notifications Methods setUserId Register the player’s connection to receive server push notifications /api_reference/grade/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/grade/game_engine/ Models EzStatus Status A status is an entity that exists for each property ID and holds the value of the current grade. The property ID is a status-specific ID and can be set to any value by the developer. It is strongly recommended that the value be the same as the property ID of the GS2-Experience. Type Condition Required Default Value Limits Description gradeName string ✓ ~ 128 chars Grade Model NameThe name of the grade model that this status belongs to. /api_reference/guild/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/guild/game_engine/ Models EzGuild Guild A guild can have up to 5 attributes, which can be used when searching for guilds and displaying guild lists. A guild can set a participation policy, allowing for either open participation or approval-based participation. If open participation is selected, a user who requests to join the guild will immediately become a guild member. If approval-based participation is selected, a user who requests to join the guild will not become a guild member until approved by the guild master or a guild member. /api_reference/idle/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/idle/game_engine/ Models EzStatus Status Created when GetIdleStatus is called for the first time, and the idle time count starts from that time. The idle time count is reset when you receive a reward. If GS2-Schedule events are associated, you cannot access Category before the event is held, and you cannot create a status. If an event is associated, the status holds the number of repetitions of the event. If the current event ID and the event ID at the time of status creation do not match, if the number of repetitions of the current event and the number of repetitions held by the status do not match, or if the status is created before the start time of the event, the waiting time is reset. /api_reference/inbox/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/inbox/game_engine/ Models EzMessage Message Message data delivered to a message box prepared for each game player. Messages have an open state, and you can set an Acquire Action to be executed when opened. Messages can be set to expire, and messages that expire are automatically deleted regardless of whether they are unread or read after opening. Messages will be deleted even if you have not received the attached reward. Type Condition Required Default Value Limits Description messageId string * ~ 1024 chars Message GRN * Set automatically by the server name string ✓ UUID ~ 36 chars Message NameMaintains a unique name for each message. /api_reference/inventory/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/inventory/game_engine/ Models EzInventory Inventory Inventory is like a bag that stores items owned by game players. The bag has a capacity, and the capacity can be expanded by each player. Type Condition Required Default Value Limits Description inventoryId string * ~ 1024 chars Inventory GRN * Set automatically by the server inventoryName string ✓ ~ 128 chars Inventory Model NameThe name of the inventory model that defines the structure and capacity settings for this inventory. /api_reference/job_queue/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/job_queue/game_engine/ Models EzJob Job A job queue is a mechanism for delaying the execution of a process rather than completing it immediately. For example, when a character is acquired, the process that must be executed immediately is to store the character in the inventory. On the other hand, a process that does not have to be executed immediately is the process of registering the character to the dictionary. By processing tasks that do not need to be executed immediately through a job queue, the system can be made more fault-tolerant. /api_reference/limit/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/limit/game_engine/ Models EzCounter Current Counter Value Tracks the current usage count for a specific counter under a limit model for each user. Multiple counters can exist under a single limit model (e.g., one counter per quest for one-time rewards). The count is compared against a maximum value specified at the time of the count-up operation, and is automatically reset to zero based on the limit model’s reset schedule. Type Condition Required Default Value Limits Description counterId string * ~ 1024 chars Counter GRN * Set automatically by the server limitName string ✓ ~ 128 chars Usage Limit Model NameThe name of the limit model that this counter belongs to. /api_reference/lock/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/lock/game_engine/ Models EzMutex Mutex The mutex provided by GS2 is a type of re-entrant lock. When acquiring a lock, a transaction ID is specified, and the lock can be acquired again only if the same transaction ID is specified. Since it has a reference counter, the same number of unlock operations are required when releasing it. Type Condition Required Default Value Limits Description mutexId string * ~ 1024 chars Mutex GRN * Set automatically by the server propertyId string ✓ ~ 1024 chars Property IDAn identifier for the resource to be locked, determining which resource the lock is protecting. /api_reference/log/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/log/game_engine/ Models EzInGameLog In-game Log A custom log entry sent from the game client or server-side scripts. Unlike access logs which are automatically generated by GS2 API calls, in-game logs are explicitly sent by game developers to record game-specific events such as player actions, game state changes, or business metrics. Type Condition Required Default Value Limits Description timestamp long ✓ TimestampThe date and time when the in-game log was sent. userId string ~ 128 chars User ID tags List<EzInGameLogTag> [] 0 ~ 20 items TagsKey-value pairs attached to the log entry for filtering and categorization. /api_reference/login_reward/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/login_reward/game_engine/ Models EzReceiveStatus Receive Status Tracks the login bonus receive status for each user per bonus model. Maintains a boolean array (receivedSteps) where each entry indicates whether the user has received the corresponding day’s reward. Also records the last time a bonus was received (lastReceivedAt) to determine daily eligibility. The receivedSteps can be reset when the bonus cycle restarts (e.g., in Streaming Mode with repeat enabled). Type Condition Required Default Value Limits Description bonusModelName string ✓ ~ 128 chars Bonus Model NameThe name of the Login Bonus Model that this receive status is associated with. /api_reference/lottery/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/lottery/game_engine/ Models EzProbability Draw Probability Represents the calculated draw probability for a specific prize. The rate is computed from the prize’s weight relative to the total weight of all prizes in the Prize Table. For box gacha, the probability changes dynamically as prizes are drawn from the box. Type Condition Required Default Value Limits Description prize EzDrawnPrize ✓ PrizeThe prize that this probability corresponds to, including its ID and acquire actions. rate float ✓ 0 ~ 1. /api_reference/matchmaking/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/matchmaking/game_engine/ Models EzGathering Gathering An entity representing a group of game players brought together by matchmaking. It has multiple parameters for matchmaking, and the players are grouped based on the totality of the parameters. Players join a Gathering by specifying their role, attributes, and optionally a blacklist of users they do not wish to play with. Joining is validated against attribute range requirements, role capacity limits, and whitelist restrictions (allowUserIds). When all role slots are filled to capacity, the Gathering is considered complete and matchmaking finishes. /api_reference/mega_field/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/mega_field/game_engine/ Models EzSpatial Spatial Type Condition Required Default Value Limits Description userId string ✓ ~ 128 chars User ID areaModelName string ✓ ~ 128 chars Area name layerModelName string ✓ ~ 128 chars Layer name position EzPosition ✓ Position vector EzVector ✓ Vector Related methods: update - Send position EzAreaModel Area divides space, and different areas can be treated as different spaces even if they have the same coordinates. Type Condition Required Default Value Limits Description name string ✓ ~ 128 chars Area Model name metadata string ~ 2048 chars MetadataArbitrary values can be set in the metadata. /api_reference/mission/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/mission/game_engine/ Models EzComplete Mission Completion Status Tracks a user’s mission completion and reward receipt status for a specific mission group. Maintains separate lists for accomplished task names and reward-received task names, distinguishing between tasks that have been completed and those whose rewards have actually been claimed. Type Condition Required Default Value Limits Description missionGroupName string ✓ ~ 128 chars Mission Group NameThe name of the mission group that this completion record belongs to. /api_reference/money/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/money/game_engine/ Models EzWallet Wallet Currency in the wallet is managed separately for currency purchased for a fee and currency obtained for free. Currency purchased for a fee is further managed by the unit price at the time of purchase, allowing for refunds in the event of service termination, or to determine if the balance is sufficient to meet the requirements of the Funds Settlement Act. The wallet has slots and each slot has a different balance. /api_reference/money2/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/money2/game_engine/ Models EzWallet Wallet Currency in the wallet is managed separately for currency purchased for a fee and currency obtained for free. Currency purchased for a fee is further managed by the unit price at the time of purchase, allowing for refunds in the event of service termination, or to determine if the balance is sufficient to meet the requirements of the Funds Settlement Act. The wallet has slots and each slot has a different balance. /api_reference/news/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/news/game_engine/ Models EzNews News Article Represents a single news article generated from Hugo site data. Each article belongs to a section and content path, and has a title, timestamp, and front matter metadata. Articles can optionally be linked to a GS2-Schedule event to control their display period. The front matter contains additional metadata in JSON format, including an optional weight field for controlling display order. Type Condition Required Default Value Limits Description section string ✓ ~ 1024 chars Section NameThe section (category) to which this article belongs, corresponding to the Hugo content directory structure. /api_reference/quest/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/quest/game_engine/ Models EzProgress Quest Progress It is created at the beginning of the quest and deleted at the end. When you exit the application in the middle of an in-game, this data will remain. It is possible to resume the game from the ongoing quest information maintained by the entity. Type Condition Required Default Value Limits Description progressId string * ~ 1024 chars Quest Progress GRN * Set automatically by the server transactionId string ✓ UUID ~ 36 chars Transaction IDUnique identifier for the quest transaction. /api_reference/ranking/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/ranking/game_engine/ Models EzScore Score Holds the registered scores for each game player per category. Each score entry is identified by a unique ID and associated with a category and scorer user. In sum mode, new scores are added to the existing total via the AddScore operation rather than creating separate entries. Scores outside the category’s minimum/maximum range are rejected at registration. Type Condition Required Default Value Limits Description categoryName string ✓ ~ 128 chars Category Name userId string ✓ ~ 128 chars User ID uniqueId string ✓ UUID ~ 36 chars Unique IDA UUID that uniquely identifies this score entry. /api_reference/ranking2/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/ranking2/game_engine/ Models EzGlobalRankingData Global Ranking Represents a ranked entry in the global ranking for a specific season. Contains the user’s score, 0-based index (sorted position), and 1-based rank (which accounts for ties). The rank is calculated as index + 1. Type Condition Required Default Value Limits Description rankingName string ✓ ~ 128 chars Global Ranking Model nameGlobal Ranking Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). season long ✓ 0 ~ 9223372036854775805 SeasonThe season number corresponding to the GS2-Schedule event repeat count. /api_reference/realtime/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/realtime/game_engine/ Models EzRoom Room Represents a dedicated game server instance for handling real-time communication in multiplayer matches. Room creation is asynchronous: after the request, the system provisions a server and assigns an IP address, port, and encryption key once the instance is ready. Clients should wait for the create notification (or poll) before attempting to connect. The encryption key is used to establish a secure communication channel between the game clients and the relay server. /api_reference/schedule/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/schedule/game_engine/ Models EzTrigger Trigger Defines the starting point for relative event scheduling, enabling per-player event periods. When a trigger is activated for a player, it records the activation time (triggeredAt) and an expiration time (expiresAt). Events configured with “relative” schedule type reference a trigger by name; the event period for that player starts from the trigger’s activation time and ends at its expiration. Triggers can be renewed (resetting createdAt and updating expiresAt) and are automatically cleaned up via TTL after expiration. /api_reference/season_rating/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/season_rating/game_engine/ Models EzBallot Ballot A voting ticket issued to each player for a specific match session. Contains the match context (season, session, number of players) and the player’s user ID. The ballot is signed by the server and returned to the player, who then fills in game results and submits it back as part of a WrittenBallot. During vote aggregation, ballots from all participants are compared via majority consensus to prevent result manipulation. /api_reference/serial_key/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/serial_key/game_engine/ Models EzSerialKey Serial Code The serial code issued can be used only once. Serial codes are issued in the format “RPCLP-FP7N-NCDMJ-FLVA-IRI4” and the data length cannot be changed. Information on the type of campaign is also included within the serial code. When using the serial code, simply specify the namespace in which the serial code is to be used. Type Condition Required Default Value Limits Description campaignModelName string ✓ ~ 128 chars Campaign nameThe name of the campaign model this serial code belongs to. /api_reference/showcase/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/showcase/game_engine/ Models EzShowcase Showcase A Showcase can define items for display. Additionally, the sales period for items on Showcase can be set. Type Condition Required Default Value Limits Description name string ✓ ~ 128 chars Showcase nameShowcase-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). metadata string ~ 2048 chars MetadataArbitrary values can be set in the metadata.Since they do not affect GS2’s behavior, they can be used to store information used in the game. /api_reference/skill_tree/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/skill_tree/game_engine/ Models EzStatus Status Tracks the skill tree release state for a specific player and property. Maintains a list of released (unlocked) node names. Nodes can be released (added to the list), restrained (removed from the list), or reset (all cleared). Attempting to release an already-released node or restrain a non-released node results in an error. Auto-created when first accessed for a user. Type Condition Required Default Value Limits Description statusId string * ~ 1024 chars Status GRN * Set automatically by the server userId string ✓ ~ 128 chars User ID releasedNodeNames List<string> [] 0 ~ 1000 items Released Node NamesList of node model names that the player has unlocked in this skill tree. /api_reference/stamina/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/stamina/game_engine/ Models EzStamina Stamina Stamina is a point that is recovered over time in real time. Generally, this stamina is used to limit the number of times a player can play a game per day and to allow the game provider to control the speed of game progression by allowing players to consume stamina to play the game. Type Condition Required Default Value Limits Description staminaName string ✓ ~ 128 chars Stamina Model NameThe name of the StaminaModel that defines the recovery parameters, capacity, and table references for this stamina instance. /api_reference/state_machine/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/state_machine/game_engine/ Models EzStatus State Machine Status Represents a running instance of a state machine for a specific user. Tracks the current execution state including variables, call stack for sub-state machines, transition count, and random number state. The status transitions through Running, Wait, Pass (success), and Error states. Type Condition Required Default Value Limits Description statusId string * ~ 1024 chars Status of State Machine GRN * Set automatically by the server name string ✓ UUID ~ 36 chars Status nameMaintains a unique name for each status of state machine. /api_reference/version/game_engine/ Mon, 01 Jan 0001 00:00:00 +0000 /api_reference/version/game_engine/ Models EzAcceptVersion Approved Version Not a version tied to data, such as an app version or asset version. Used for entities that require version control on a per-user basis, such as a version of an agreed upon Terms of Use. Type Condition Required Default Value Limits Description versionName string ✓ ~ 128 chars Version NameThe name of the version model that this approval record is associated with. Links the user’s approval to a specific version model definition. /get_start/uikit/ Mon, 01 Jan 0001 00:00:00 +0000 /get_start/uikit/ The procedure is the same as the general tutorial until the middle of the tutorial. Setup GS2 SDK setup Create credentials (API keys) Prepare resources for login process Initialize client Create environment information First, create a ScriptableObject that defines the environment information. Open the context menu in Project and create Create > Game Server Services > Core > Environment. Create the ScriptableObject you created with create credential (API key) to the ScriptableObject you created. /get_start/uikit/chat/ Mon, 01 Jan 0001 00:00:00 +0000 /get_start/uikit/chat/ UI Configuration First, let me show you an overview of the scene. The message list is placed at the top of the screen, and the text input field and send button are placed at the bottom. Context This section describes the placement of Context. A is the room context for GS2-Chat. B is the message list context of GS2-Chat. C is the message context for GS2-Chat. Explanation of implementation Obtaining a message list The room context is set to the information of the room created by GS2-Chat in advance. /get_start/tutorial/setup_sdk/ Mon, 01 Jan 0001 00:00:00 +0000 /get_start/tutorial/setup_sdk/ This section details the installation process for the SDK for Game Engine, GS2 SDK for Unity or GS2 SDK for Unreal Engine 5. GS2 SDK for Unity Install Instructions GS2 SDK for Unity Installer Version 2024.4.1 Download the installer in UnityPackege format from the link above. Create a new Unity project or prepare an existing Unity project and open it in the Unity Editor. Gs2-unity-installer is available from the menu “Assets > Import Package > Custum Packages…”. /get_start/blueprint/ Mon, 01 Jan 0001 00:00:00 +0000 /get_start/blueprint/ The procedure is the same as in the general tutorial up to the halfway point. GS2 setup SDK setup Create credentials (API keys) Prepare resources for login process Initialize client Create a GS2::Core::Action::Initialize node and set clientId / clientSecret / region to connect to. Set clientId / clientSecret to the values you created in Create Credential (API Key). OnSuccess is called if initialization succeeds, and OnError is called if it fails. /get_start/uikit/inventory/ Mon, 01 Jan 0001 00:00:00 +0000 /get_start/uikit/inventory/ UI Configuration First, let me show you the scene as a whole. The upper part of the screen shows the inventory capacity usage, the list of possessed items is in the center, and the buttons to obtain items are at the bottom. Context This section describes the placement of Context. A is the inventory context for GS2-Inventory. B is the item list context for GS2-Inventory. C is the item context in GS2-Inventory. /get_start/tutorial/coding/ Mon, 01 Jan 0001 00:00:00 +0000 /get_start/tutorial/coding/ This section explains the minimum implementation for creating an account and logging in using the GS2 SDK. For complete code for each platform, please check the Full Sample Code. About Implementation in Unity The Unity SDK uses Coroutines for asynchronous processing. The following code examples are intended to be executed within a Coroutine (a method that returns IEnumerator). Initialize GS2 SDK Game Engine: Unity Unreal Engine // Setup variables var clientId = "