NAV
Unity

GS2 UIKit for Unity

GS2 UIKit for Unity Reference

GS2-Account

Prefab

Gs2AccountAutoLogin

Execute login.

If the account can be obtained, login with the account.
If the account cannot be obtained, or if the user is a new user who has not yet created an account, create a new account, save it in the repository, and execute login.

Components
PlayerPrefsAccountRepository
Gs2GameSessionHolder
Nested prefab
Gs2AccountRepositoryLoadAction
Gs2AccountAccountCreateAction
Gs2AccountRepositorySaveAction
Gs2ProfileLoginAction

Gs2AccountRepositoryLoadAction

Retrieve the account where the repository is stored

Components
Gs2AccountRepositoryLoadAction

Gs2AccountAccountCreateAction

Create a new account to identify the game player

Components
Gs2AccountAccountCreateAction

Gs2AccountRepositorySaveAction

Save account in repository

Components
Gs2AccountSignOutGoogleAccount

Gs2AccountAccountAuthenticationAction

Perform account authentication.

Components
Gs2AccountAccountAuthenticationAction

Gs2ProfileLoginAction

Performs account authentication and login with utility class Profile.

Components
Gs2ProfileLoginAction

Gs2AccountTakeOverListPrefab

Retrieves and displays a list of transfer information.

Components
Gs2AccountTakeOverListFetcher
Gs2AccountTakeOverListPrefab

Gs2AccountLoadAppleId

Run the Sign in with Apple native plugin.

Components
Gs2AccountLoadAppleId

Gs2AccountLoadGoogleAccount

Run the Sign in with Google native plugin.

Component
Gs2AccountLoadGoogleAccount

Gs2AccountRepositoryDeleteAction

Delete account information stored in the repository.

Component
Gs2AccountRepositoryDeleteAction

Gs2AccountSignOutGoogleAccount

Log out of Sign in with Google.

Component
Gs2AccountTakeOverAddAction

Gs2AccountTakeOverAddAction

Add takeover settings.

Components
Gs2AccountTakeOverAddAction

Gs2AccountTakeOverDeleteAction

Delete takeover settings.

Component
Gs2AccountTakeOverDeleteAction

Gs2AccountTakeOverDoAction

Execute takeover.

Component
Gs2AccountTakeOverDoAction

Fetcher Component

Gs2AccountTakeOverFetcher

Obtains transfer information.

Field Description
Take Over Specify a TakeOver ScriptableObject.
Event Description
OnError(Gs2Exception error) Called when an error occurs.

Gs2AccountTakeOverListFetcher

Gets a list of takeover information.

Field Description
Namespace Specify a Account Namespace ScriptableObject.
Event Description
OnError(Gs2Exception error) Called when an error occurs.

View component

Gs2AccountAccountLabel

Generates a string from the account in the specified format and passes it to the target GameObject.

Field Name Description
format Specify the format.
Format Description
{shortUserId} shortenedUserId

Gs2AccountLoggedInEnabler

This component automatically enables or disables the associated GameObject based on login status.

The conditions for switching between display and non-display include the following

Field Name Condition
Guest Not logged in
LoggedIn Logged In
Field Name Description
Target Target GameObject

Gs2AccountTakeOverEnabler

This component automatically enables or disables the associated GameObject depending on the acquisition status of transfer information.

The conditions for switching between display and non-display include the following.

Field Name Condition
Loading Getting takeover information
Not Found No transfer information found
Loaded Transfer information has been obtained
Field Name Description
Target Target GameObject

Gs2AccountTakeOverTypeEnabler

This component enables or disables the associated GameObject depending on whether the slot number in the takeover information matches.

The following conditions are used to switch between display and non-display.

Field Name Type Condition
EnableTypes List Specify slot number

Action component

Gs2AccountAuthenticationAction

Account Authentication

Gs2AccountAccountCreateAction

Create a new account to identify the game player

Gs2ProfileLoginAction

Performs account authentication and login with utility class Profile.

Gs2AccountLoadAppleId

Execute Sign in with Apple

Gs2AccountLoadGoogleAccount

Sign in with Google

Gs2AccountRepositoryDeleteAction

Delete accounts stored in the repository

Gs2AccountRepositoryLoadAction

Retrieve accounts stored in the repository

Gs2AccountRepositorySaveAction

Save the account in the repository

Gs2AccountSignOutGoogleAccount

Log out of Sign in with Google

Gs2AccountTakeOverAddAction

Add takeover settings

Gs2AccountTakeOverDeleteAction

Delete takeover setting

Gs2AccountTakeOverDoAction

Execute takeover

ScriptableObject

GS2-Account Namespace

ScriptableObject that holds the Namespace.
Sets the namespace name for the GS2-Account.

Create > Game Server Services > Gs2Account > Namespace

Field Description
NamespaceName NamespaceName

TakeOver

ScriptableObject that holds a reference to the GS2-Account Namespace ScriptableObject and specifies the slot number where the takeover information is stored.

Create > Game Server Services > Gs2Account > TakeOver

Field Description
Namespace Specify a Namespace ScriptableObject.
type Specifies the slot number where the takeover information is stored.

GS2-Auth

Prefab

Gs2AuthLoginAction

Perform login.

Component
Gs2AuthLoginAction

Action component

Gs2AuthLoginAction

Login to GS2 with the specified user ID.

Field Description
Key Specify a Key ScriptableObject.
Events Description
OnError(Gs2Exception error) It is called when an error occurs.

ScriptableObject

Key

GS2-Key Namespace ScriptableObject that holds a reference to a ScriptableObject, the cryptographic key name.

Create > Game Server Services > Gs2Key > Key

Field Description
Namespace Specify a Namespace ScriptableObject..
keyName Cryptographic key name

GS2-Key Namespace

This is a ScriptableObject that holds a Namespace.
Sets the GS2-Key namespace name.

Create > Game Server Services > Gs2Key > Namespace

Field Description
NamespaceName Namespace Name

GS2-Chat

Prefab

Gs2ChatMessageListPrefab

Retrieves and displays a list of messages in the room.

Component
Gs2ChatMessageListFetcher
Gs2ChatMessageListPrefab

Gs2ChatMessagePrefab

Retrieve and display messages.

Components
Gs2ChatMessageFetcher
Gs2ChatMessagePrefab
Gs2ChatMessageEnabler

Gs2ChatRoomPrefab

Show room.

Component
Gs2ChatRoomFetcher
Gs2ChatRoomPrefab

Gs2ChatMessageLabel

Displays the message string.

Component
Gs2ChatMessageLabel

Gs2ChatMessageStamp

Displays the stamp of the message.

Component
Gs2ChatMessageStamp

Gs2ChatMessagePostAction

Perform message posting.

Component
Gs2ChatMessagePostAction

Gs2ChatRoomCreateAction

Perform room creation.

Components
Gs2ChatRoomCreateAction

Gs2ChatRoomSubscribeAction

Set up room subscriptions.

Component
Gs2ChatRoomSubscribeAction

Gs2ChatRoomUnsubscribeAction

Unsubscribe from the room.

Component
Gs2ChatRoomUnsubscribeAction

Fetcher component

Gs2ChatMessageFetcher

Obtains a message.

Field Description
Room Specify a Room ScriptableObject.

Gs2ChatMessageListFetcher

Obtains a list of messages in a room.

Field Description
Room Specify a Room ScriptableObject.

Gs2ChatRoomFetcher

Obtains room information.

Field Description
Room Specify a Room ScriptableObject.

View component

Gs2ChatMessageCategoryEnabler

This component automatically enables or disables the associated GameObject depending on whether it is in the specified category or not.

The following conditions are used to switch between display and non-display.

Field Name Condition
EnableCategories Category

Gs2ChatMessageEnabler

This component automatically enables or disables the associated GameObject depending on the message acquisition status.

The following conditions are used to switch between display and non-display.

Field Name Condition
Loading Getting message
Loaded Message has been retrieved

Gs2ChatMessageLabel

Generates a string from the message in the specified format and passes it to the target GameObject.

Field Name Type Description
Format string Specify the format.
Format Description
{metadata} message body
{yyyy} Date and time when the message was created (year)
Last two digits of message creation date and time (year)
{MM} Date and time of message creation (month) prefix zero padding
{MMMM} Date and time when message was created (month) Abbreviated name of month
{dd} Date message was created (day) prefix zero padding
{hh} Date and time of message creation (hour) 12-hour format prefix zero padding
{HH} Date and time of message creation (hour) 24-hour format prefix zero padding
{tt} Date and time the message was created (AM/PM)
{mm} Date and time of message creation (minutes) Prefix Zero Padding
{ss} Date and time of message creation (seconds) prefix zero padding

Gs2ChatMessageStamp

Gets the Sprite of the stamp from the message and passes it to the callback function.

Field Name Type Description
Collection Gs2ChatMessageStampElementCollection List of elements where name and StampSprite are paired

Action component

Gs2ChatMessagePostAction

Performs a message posting.

Gs2ChatRoomCreateAction

Creates a room.

Gs2ChatRoomSubscribeAction

Sets up a subscription to a room.

Gs2ChatRoomUnsubscribeAction

Unsubscribes from a room.

ScriptableObject

Room

Namespace ScriptableObject that holds a reference to the ScriptableObject and the name of the stamina model.

Create > Game Server Services > Gs2Chat > Room

Field Description
Namespace Specifies a Namespace ScriptableObject.
roomName RoomName
password password required to access the room

GS2-Chat Namespace

This is a ScriptableObject that holds the Namespace.
Sets the name of the GS2-Chat namespace.

Create > Game Server Services > Gs2Chat > Namespace

Field Description
NamespaceName Namespace Name

GS2-Dictionary

Prefab

Gs2DictionaryEntryListPrefab

Display a list of entries

Component
Gs2DictionaryEntryListFetcher
Gs2DictionaryEntryListPrefab

Gs2DictionaryEntryPrefab

Display entries

Component
Gs2DictionaryEntryFetcher
Gs2DictionaryEntryPrefab

Gs2DictonaryEntryLabel

Generate entry string

Component
Gs2DictionaryEntryLabel

Fetcher component

Gs2DictionaryEntryListFetcher

Retrieves a list of entries.

Field Description
Namespace Specify a Dictionary Namespace ScriptableObject.
Event Description
OnError(Gs2Exception error) Called when an error occurs.

Gs2DictionaryEntryFetcher

Retrieve an entry.

Event Description
OnError(Gs2Exception error) Called when an error occurs.

View component

Gs2DictionaryEntryEnabler

This component automatically enables or disables the associated GameObject depending on the status of entry acquisition.

The following conditions are used to switch between display and non-display.

Field Name Condition
Loading Retrieving entries
Loaded Entry already retrieved
Have Owned

Gs2DictionaryEntryLabel

Generates a string from the entry in the specified format and passes it to the target GameObject.

FieldName Type Description
Format string Specify the format.
Format Description
{yyyy} Date of acquisition (year)
{yy} last two digits of date and time of acquisition (year)
{MM} Date of acquisition (month) prefix zero padding
{MMMM} date/time of receipt (month) abbreviated name of month
{dd} Date of acquisition (day) prefix zero padding
{hh} Date and time of receipt (hour) 12-hour format Prefix Zero Padding
{HH} Date and time of acquisition (hour) 24-hour format prefix zero padding
{tt} Date and time of acquisition (AM/PM)
{mm} Date and time of availability (minutes) Prefix Zero Padding
{ss} Date and time of availability (seconds) Prefix Zero Padding

ScriptableObject

Entry

GS2-Dictionary Namespace ScriptableObject that holds the reference to the ScriptableObject and the name of the entry for the illustrated data.

Create > Game Server Services > Gs2Dictionary > Entry

Field Description
Namespace Specifies a Namespace ScriptableObject.
entryName Specifies the entry name.

GS2-Dictionary Namespace

ScriptableObject that holds the Namespace.
Sets the namespace name for GS2-Dictionary.

Create > Game Server Services > Gs2Dictionary > Namespace

Field Description
namespaceName Namespace Name

GS2-Exchange

Prefab

Gs2ExchangeAwaitListPrefab

Display a list of exchange waits

Component
Gs2ExchangeAwaitListFetcher
Gs2ExchangeAwaitListPrefab
Nested Prefab
Gs2ExchangeAwaitPrefab

Gs2ExchangeAwaitPrefab

Display exchange standby

Component
Gs2ExchangeAwaitFetcher
Gs2ExchangeAwaitPrefab
Gs2ExchangeAwaitEnabler
Nested Prefab
Gs2ExchangeAwaitLabel
Gs2ExchangeAwaitAcquireAction

Gs2ExchangeAwaitLabel

Generate exchange waiting string

Nested Prefab
Gs2ExchangeAwaitLabel

Gs2ExchangeAwaitAcquireAction

Get reward for waiting for exchange

Component
Gs2ExchangeAwaitAcquireAction

Gs2ExchangeAwaitSkipAction

Skip exchange wait at a price.

Component
Gs2ExchangeAwaitSkipAction

Gs2ExchangeExchangeAction

Perform exchange

Component
Gs2ExchangeExchangeAction

Fetcher component

Gs2ExchangeAwaitListFetcher

Obtains a list of exchange waits.

Field Description
Rate Rate Specify a ScriptableObject.
Event Description
OnError(Gs2Exception error) Called when an error occurs.

Gs2ExchangeAwaitFetcher

Obtains information on exchange standby.

Event Description
OnError(Gs2Exception error) Called when an error occurs.

Gs2ExchangeRateListFetcher

Gets a list of exchange rate information.

Event Description
OnError(Gs2Exception error) Called when an error occurs.

Gs2ExchangeRateFetcher

Gets exchange rate information.

Event Description
OnError(Gs2Exception error) Called when an error occurs.

View component

Gs2ExchangeAwaitEnabler

This component automatically enables or disables the associated GameObject depending on the acquisition status of the exchange standby.

The following conditions are used to switch between display and non-display.

Field Name Condition
Loading Waiting for exchange is being acquired
Waiting Waiting for exchange
Complete Exchange is complete

Gs2ExchangeAwaitLabel

Generates a string in the specified format from the exchange standby and passes it to the target GameObject.

Field Name Description
format Specify the format.
Format Description
{mm} Waiting time from the execution of the exchange until the reward is actually received (minutes) Prefix Zero Padding
{ss} Waiting time from exchange execution to actual receipt of reward (seconds) Prefix Zero Padding
{h} Waiting time from the execution of the exchange until the reward is actually received ((hour)
{m} Waiting time from exchange execution to actual receipt of reward (minutes)
{s} Waiting time from exchange execution to actual receipt of reward (seconds)

Action component

Gs2ExchangeAwaitAcquireAction

Obtain reward for waiting for exchange.

Gs2ExchangeAwaitSkipAction

Skip the exchange wait for a price.

Gs2ExchangeExchangeAction

Perform exchange.

ScriptableObject

Rate

Namespace A reference to a ScriptableObject, a ScriptableObject that holds the name of the exchange rate.

Create > Game Server Services > Gs2Exchange > Rate

Field Description
Namespace Specifies a Namespace ScriptableObject.
RateName Name of the exchange rate

GS2-Exchange Namespace

ScriptableObject that holds the Namespace.
Sets the name of the GS2-Exchange namespace.

Create > Game Server Services > Gs2Exchange > Namespace

Field Description
NamespaceName Namespace Name

GS2-Experience

Prefab

Gs2ExperienceStatusPrefab

Display of experience status

Component
Gs2ExperienceStatusFetcher
Gs2ExperienceStatusPrefab
Gs2ExperienceStatusEnabler
Nested Prefab
Gs2ExperienceStatusLabel
Gs2ExperienceStatusProgress

Gs2ExperienceStatusLabel

String display of experience status

Component
Gs2ExperienceStatusLabel

Gs2ExperienceStatusProgress

Slider display of experience status

Components
Gs2ExperienceStatusProgress

Fetcher component

Gs2ExperienceStatusListFetcher

Gets a list of experience statuses.

Gs2ExperienceStatusFetcher

Gets the experience status.

Field Description
Status Specify a Status ScriptableObject.
Event Description
OnError(Gs2Exception error) Called when an error occurs.

Gs2ExperienceExperienceListFetcher

Gets a list of experience models.

Gs2ExperienceExperienceFetcher

Gets a list of experience models.

View component

Gs2ExperienceStatusEnabler

This component enables or disables the associated GameObject depending on its experience status.

The following conditions are used to switch between display and non-display.

Field Name Condition
Loading Getting experience
Active Rank limit not yet reached
Capped Rank limit reached

Gs2ExperienceStatusLabel

Generates a string from the experience status in the specified format and passes it to the target GameObject.

Field Name Type Description
Format string Specify the format.
Format Description
{currentExperience} Current experience (cumulative)
{nextRankUpExperience} Experience of the next rank (cumulative)
{currentStep} Experience gained at current rank
{nextRankStep} Experience required to move up to the next rank
{currentRank} current rank
{capRank} current rank limit
{capRankMax} maximum rank limit

Gs2ExperienceStatusProgress

This component reflects in the uGUI Slider the percentage of experience required to reach the next rank at the current rank.
It should be associated with the same GameObject as the Slider.

Event Description
OnUpdate(Single) Percentage of experience gained (0,0f to 1.0f) is passed to the callback function
OnUpdateInverse(Single) passes the inverse of the percentage of experience gained (1,0f to 0.0f) to the callback function

ScriptableObject

Status

Namespace A reference to a ScriptableObject, a ScriptableObject that holds the name of the exchange rate.

Create > Game Server Services > Gs2Experience > Status

Field Description
Experience Specifies a Namespace ScriptableObject.
PropertyId Property ID (unique ID to identify the type of experience)

Experience

Namespace ScriptableObject that holds the reference to the ScriptableObject and the name of the exchange rate.

Create > Game Server Services > Gs2Experience > Experience

Field Description
Namespace Specifies a Namespace ScriptableObject.
ExperienceName Name of the experience model

GS2-Experience Namespace

ScriptableObject that holds the Namespace.
Sets the name of the GS2-Experience namespace.

Create > Game Server Services > Gs2Experience > Namespace

Field Description
NamespaceName Namespace Name

GS2-Formation

Prefab

Gs2FormationFormListPrefab

Retrieves and displays a list of form information.

Component
Gs2FormationMoldFetcher
Gs2FormationFormListFetcher
Nested Prefab
Gs2FormationFormPrefab

Gs2FormationFormPrefab

Retrieves and displays form information.

Component
Gs2FormationFormFetcher
Gs2FormationFormPrefab

Gs2FormationMoldListPrefab

Get a list of form storage areas (Mold).

Component
Gs2FormationMoldFetcher
Gs2FormationFormListFetcher
Nested Prefab
Gs2FormationMoldPrefab

Gs2FormationMoldPrefab

Retrieves and displays the form storage area (Mold).

Component
Gs2FormationMoldFetcher
Gs2FormationMoldEnabler

Gs2FormationSlotListPrefab

Retrieves and displays a list of slots.

Component
Gs2FormationFormFetcher
Gs2FormationSlotListFetcher
Gs2FormationSlotListPrefab
Nested Prefab
Gs2FormationSlotPrefab

Gs2FormationSlotPrefab

Retrieves and displays slot information.

Component
Gs2FormationSlotFetcher
Gs2FormationSlotPrefab
Gs2FormationSlotEnabler

Gs2FormationFormLabel

A string is generated from the organization status and passed to the target GameObject.

Component
Gs2FormationFormLabel

Gs2FormationMoldLabel

Generate a string from the organization status storage area and pass it to the target GameObject.

Component
Gs2FormationMoldLabel

Gs2FormationUpdateFormAction

Update form

Components
Gs2FormationUpdateFormAction

Fetcher component

Gs2FormationFormListFetcher

Gets a list of form information.

Gs2FormationFormFetcher

gets a list of form information.

Gs2FormationMoldListFetcher

Gets list of form folders (Mold).

Gs2FormationMoldFetcher

Gets form folders (Mold) information.

Gs2FormationSlotListFetcher

Gets the list of slots.

Gs2FormationSlotFetcher

Gets the slot information.

View component

Gs2FormationFormEnabler

This component automatically enables or disables the associated GameObject depending on the form's acquisition status.

The conditions for switching between display and non-display include the following

Field Name Condition
Loading Retrieving the form
Loaded Forms have been retrieved
Field Name Description
Target Target GameObject

Gs2FormationFormLabel

Field Name Type Description
Format string Specify the format.
Format Description
{metadata} Metadata

Gs2FormationMoldEnabler

This component automatically enables or disables the associated GameObject depending on the acquisition status of the form's storage space.

The conditions for switching between display and non-display include the following

Field Name Condition
Loading Getting form's storage space
Loaded Form storage space has been retrieved
Field Name Description
Target Target GameObject

Gs2FormationMoldLabel

Field Name Type Description
Format string Specify the format.
Format Description
{metadata} metadata
{maxCapacity} Maximum capacity to store the form
{currentCapacity} Current capacity

Gs2FormationSlotEnabler

This component automatically enables or disables the associated GameObject based on the slot's acquisition status.

The conditions for switching between display and non-display include the following

Field Name Condition
Loading Retrieving the form
Loaded Forms have been retrieved
Field Name Description
Target Target GameObject

Gs2FormationSlotNameEnabler

This component automatically enables or disables the associated GameObject according to the name of the slot.

The conditions for switching between display and non-display include the following

Field Name Condition
EnableSlotNames Does it contain the specified slot names?
Field Name Description
Target Target GameObject

Action component

Gs2FormationUpdateFormAction

Update form information.

ScriptableObject

Form

Mold ScriptableObject that holds the reference to the ScriptableObject and the index of the storage area.

Create > Game Server Services > Gs2Formation > Form

Field Description
Mold Specifies a Mold ScriptableObject.
Index Index of the storage area

Mold

Namespace ScriptableObject that holds the reference to the ScriptableObject and the name of the exchange rate.

Create > Game Server Services > Gs2Formation > Mold

Field Description
Namespace Specifies a Namespace ScriptableObject.
moldName formation-model-name

Slot

Namespace ScriptableObject that holds the reference to the ScriptableObject and the name of the exchange rate.

Create > Game Server Services > Gs2Formation > Slot

Field Description
Form Specifies a Form ScriptableObject.
slotName Name of the experience model

GS2-Formation Namespace

.

ScriptableObject that holds the Namespace.
Sets the name of the GS2-Formation namespace.

Create > Game Server Services > Gs2Formation > Namespace

Field Description
NamespaceName Namespace Name

GS2-Friend

Prefab

Gs2FriendFollowListPrefab

Retrieves and displays a list of followers.

Component
Gs2FriendFollowListFetcher
Gs2FriendFollowListPrefab

Gs2FriendFollowPrefab

Retrieve and display follow-up information.

Component
Gs2FriendFollowFetcher
Gs2FriendFollowPrefab

Gs2FriendFriendListPrefab

Retrieves and displays a list of friends.

Component
Gs2FriendFriendListFetcher
Gs2FriendFriendListPrefab

Gs2FriendFriendPrefab

Retrieves and displays friend information.

Component
Gs2FriendFriendFetcher
Gs2FriendFriendPrefab

Gs2FriendReceiveFriendRequestListPrefab

Retrieves and displays a list of received friend requests.

Component
Gs2FriendReceiveRequestListFetcher
Gs2FriendReceiveRequestListPrefab

Gs2FriendReceiveRequestPrefab

Retrieves and displays received friend requests.

Component
Gs2FriendReceiveRequestFetcher
Gs2FriendReceiveRequestPrefab

Gs2FriendSendRequestListPrefab

Retrieves and displays a list of friend requests that have been sent.

Component
Gs2FriendSendRequestListFetcher
Gs2FriendSendRequestListPrefab

Gs2FriendSendRequestPrefab

Retrieves and displays sent friend requests.

Component
Gs2FriendSendRequestFetcher
Gs2FriendSendRequestPrefab

Gs2FriendProfileLabel

Retrieve and display the profile string.

Component
Gs2FriendProfileFetcher
Gs2FriendProfileLabel

Gs2FriendFollowFollowAction

Follow other players

Component
Gs2FriendFollowFollow

Gs2FriendFollowUnfollowAction

Unfollow the person you are following

Component
Gs2FriendFollowUnfollow

Gs2FriendFriendDeleteAction

Delete a friend.

Component
Gs2FriendFriendDelete

Gs2FriendProfileUpdateAction

Update your profile

Component
Gs2FriendProfileUpdate

Gs2FriendReceiveRequestAcceptAction

Approve friend request

Component
Gs2FriendReceiveRequestAccept

Gs2FriendReceiveRequestRejectAction

Deny friend request

Component
Gs2FriendReceiveRequestReject

Gs2FriendSendRequestDeleteAction

Delete friend request

Component
Gs2FriendSendRequestDelete

Gs2FriendSendRequestSendAction

Execute sending a friend request

Component
Gs2FriendSendRequest

Fetcher component

Gs2FriendFollowListFetcher

Retrieves a list of followers.

Gs2FriendFollowFetcher

Retrieves follow-up information.

Gs2FriendFriendListFetcher

Retrieves a list of friends.

Gs2FriendFriendFetcher

etrieves friend information.

Gs2FriendOwnProfileFetcher

Retrieves the profile information of the own player.

Gs2FriendProfileFetcher

Retrieves profile information of other players.

Gs2FriendPublicProfileFetcher

Retrieves public profile information of other players.

Gs2FriendReceiveRequestListFetcher

Retrieves a list of received friend requests.

Gs2FriendReceiveRequestFetcher

Retrieves a list of received friend requests.

Gs2FriendSendRequestListFetcher

Retrieves a list of sent friend requests.

Gs2FriendSendRequestFetcher

Retrieves sent friend requests.

View component

Gs2FriendProfileLabel

Generates a string from the profile in the specified format and passes it to the target GameObject.

Field Name Description
format Specify the format.
Format Description
{public} Public profile
{follower} Profile made public for followers
{friend} public profile for friends

Action component

Gs2FriendFollowFollow

Follow other players

Gs2FriendFollowUnfollow

Unfollow the person you are following

Gs2FriendFriendDelete

Delete Friend

Gs2FriendProfileUpdate

Update your profile

Gs2FriendReceiveRequestAccept

Approve friend request

Gs2FriendReceiveRequestReject

Deny friend request

Gs2FriendSendRequest

Sends a friend request

Gs2FriendSendRequestDelete

Delete friend request

ScriptableObject

GS2-Friend Namespace

This is a ScriptableObject that holds the Namespace.
Set the namespace name of GS2-Friend.

Field Description
NamespaceName Namespace Name

GS2-Gateway

Prefab

Gs2GatewaySetUserIdAction

Set user ID to receive push notifications from server

Component
Gs2GatewayWebSocketSetUserIdAction

Action component

Gs2GatewayWebSocketSetUserIdAction

Set user ID to receive push notifications from server

ScriptableObject

GS2-Gateway Namespace

ScriptableObject that holds the Namespace.
Set the namespace name of GS2-Gateway.

Create > Game Server Services > Gs2Gateway > Namespace

Field Description
namespaceName namespace name

GS2-Inbox

Prefab

Gs2InboxMessageDeleteAction

Perform message deletion

Component
Gs2InboxMessageDelete

Gs2InboxMessageReadAction

Read a message

Component
Gs2InboxMessageRead

Gs2InboxMessageListPrefab

Get list of messages

Components
Gs2InboxMessageListFetcher
Gs2InboxMessageListPrefab

Gs2InboxMessagePrefab

Display message

Components
Gs2InboxMessageFetcher
Gs2InboxMessagePrefab
Gs2InboxMessageEnabler

Fetcher component

Gs2InboxMessageFetcher

Retrieves a list of messages.

Field Description
Namespace Specify a Inbox Namespace ScriptableObject.
Event Description
OnError(Gs2Exception error) Called when an error occurs.

Gs2InboxMessageListFetcher

Retrieves a message.

Event Description
OnError(Gs2Exception error) Called when an error occurs.

View component

Gs2InboxMessageEnabler

Gs2InboxMessageLabel

Action component

Gs2InboxMessageDelete

Delete a message

Gs2InboxMessageRead

Make a message read

ScriptableObject

GS2-Inbox Namespace

ScriptableObject that holds the Namespace.
Sets the namespace name for GS2-Inbox.

Create > Game Server Services > Gs2Inbox > Namespace

Field Description
NamespaceName Namespace Name

GS2-Inventory

Prefab

Gs2InventoryInventoryListPrefab

Display a list of inventories

Component
Gs2InventoryInventoryListFetcher
Gs2InventoryInventoryListPrefab

Gs2InventoryInventoryPrefab

Retrieve and display inventory.

Component
Gs2InventoryInventoryFetcher
Gs2InventoryInventoryPrefab

Gs2InventoryInventoryLabelPrefab

Displays inventory information.

Component
Gs2InventoryInventoryLabel

Gs2InventoryItemSetLabelPrefab

Displays the item string.

Component
Gs2InventoryItemSetLabel

Gs2InventoryConsumeAction

Performs consumption of items.

Components
Gs2InventoryConsumeItemSet

Gs2InventoryItemSetListPrefab

Retrieves and displays a list of items.

Component
Gs2InventoryItemSetListFetcher
Gs2InventoryItemSetListPrefab

Gs2InventoryItemSetPrefab

Retrieves and displays item information.

Component
Gs2InventoryItemSetFetcher
Gs2InventoryItemSetPrefab

Fetcher Components

Gs2InventoryInventoryListFetcher

Retrieves a list of inventories.

Gs2InventoryInventoryFetcher

Retrieves inventory information.

Gs2InventoryItemFetcher

Retrieves the item model (EzItemModel).

Gs2InventoryItemListFetcher

Retrieves the list of item models (EzItemModel).

Gs2InventoryItemSetListFetcher

Retrieves a list of inventory items (EzItemSet).

Gs2InventoryItemSetFetcher

Retrieves the information of owned items (EzItemSet).

View component

Gs2InventoryInventoryEnabler

This component automatically enables or disables the associated GameObject based on the inventory acquisition status.

The conditions for switching between display and non-display include the following

Field Name Condition
Loading Taking Inventory
Loaded Inventory has been taken
Field Name Description
Target Target GameObject

Gs2InventoryInventoryLabel

Generates a string from the inventory in the specified format and passes it to the target GameObject.

Field Name Description
format Specify the format.
Format Description
{current} Capacity usage
{max} maximum capacity

Gs2InventoryItemEnabler

This component automatically enables or disables the associated GameObject depending on the item's acquisition status.

The conditions for switching between display and non-display include the following

Field Name Condition
Loading Retrieving a list of items
Loaded Item list has been retrieved
Field Name Description
Target Target GameObject

Gs2InventoryItemLabel

Generates a string from the item in the specified format and passes it to the target GameObject.

Field Name Description
format Specify the format.
Format Description
{current} Quantity in stock
{max} maximum stackable quantity

Gs2InventoryItemSetEnabler

This component automatically enables or disables the associated GameObjects depending on the acquisition status of the item set.

The conditions for switching between display and non-display include the following

Field Name Condition
Loading Retrieving an item set
Loaded Item set has been retrieved
Field Name Description
Target Target GameObject

Gs2InventoryItemSetLabel

Generates a string from the item in the specified format and passes it to the target GameObject.

Field Name Description
format Specify the format.
Format Description
{current} Quantity in stock
{max} maximum stackable quantity

Action component

Gs2InventoryConsumeItemSet

Consume item

ScriptableObject

GS2-Inventory Namespace

ScriptableObject that holds the Namespace.
Set the namespace name for GS2-Inventory.

Create > Game Server Services > Gs2Inventory > Namespace

Field Description
NamespaceName Namespace Name

GS2-Mission

Prefab

Gs2MissionMissionGroupListPrefab

Retrieves and displays a list of mission groups.

Component
Gs2MissionMissionGroupListFetcher
Gs2MissionMissionGroupList

Gs2MissionMissionGroupPrefab

Retrieves and displays mission groups.

Component
Gs2MissionMissionGroupFetcher
Gs2MissionMissionGroup
Gs2MissionMissionGroupEnabler

Gs2MissionMissionTaskListPrefab

Retrieves and displays a list of mission tasks.

Component
Gs2MissionMissionGroupFetcher
Gs2MissionMissionTaskListFetcher
Gs2MissionMissionGroupFetcher

Gs2MissionMissionTaskPrefab

Retrieve and display mission tasks.

Component
Gs2MissionCompleteFetcher
Gs2MissionMissionTaskFetcher
Gs2MissionMissionTask
Gs2MissionCounterFetcher
Gs2MissionTaskEnabler

Gs2MissionCounterLabel

Displays a counter for mission tasks

Component
Gs2MissionTaskLabel

Gs2MissionCounterProgress

Slider display of mission task counter

Components
Gs2MissionTaskProgress

Gs2MissionReceiveRewardsAction

Perform acquisition of rewards for mission accomplishment

Components
Gs2MissionReceiveRewards

Fetcher component

Gs2MissionMissionGroupListFetcher

Retrieves the list of mission groups.

Gs2MissionMissionGroupFetcher

Retrieves mission group information.

Gs2MissionCompleteFetcher

Retrieves completed missions in a mission group.

Gs2MissionCompleteListFetcher

Retrieves list of completed mission tasks.

Gs2MissionCounterListFetcher

Retrieves list of counters.

Gs2MissionCounterFetcher

Retrieves counter information.

Gs2MissionMissionGroupFetcher

Retrieves mission group information.

Gs2MissionMissionGroupListFetcher

retrieves a list of mission groups.

Gs2MissionMissionTaskFetcher

retrieves mission task information.

Gs2MissionMissionTaskListFetcher

retrieves a list of mission task information.

View component

Gs2MissionGroupEnabler

This component automatically enables or disables the associated GameObject depending on the acquisition status of the mission group.

The conditions for switching between display and non-display include the following

Field Name Condition
Loading Retrieving a mission group
Loaded Mission Groups have been retrieved
Field Name Description
Target Target GameObject

Gs2MissionTaskEnabler

This component automatically enables or disables the associated GameObject depending on the acquisition status of the mission group.

The conditions for switching between display and non-display include the following

Field Name Condition
Loading Retrieving a mission
Opened Mission Opened
Completed Mission Completed
Received Received the reward of the mission
Closed Mission not yet opened
Field Name Description
Target Target GameObject

Gs2MissionTaskLabel

Generates a string in the specified format from the mission's task and passes it to the target GameObject.

Field Name Description
format Specify the format.
Format Description
{current} count
{targetValue} target value

Gs2MissionTaskProgress

This component reflects the current count percentage against the mission's task target value on the uGUI's Slider.
Associate with the same GameObject as Slider.

Event Description
OnUpdate(Single) Percentage of the current count to the target value (0,0f to 1.0f) is passed to the callback function
OnUpdateInverse(Single) passes the inverse of the ratio of the current count to the target value (1,0f to 0.0f) to the callback function

Action component

Gs2MissionReceiveRewards

Obtain rewards for mission accomplishment

ScriptableObject

GS2-Mission Namespace

ScriptableObject that holds the Namespace.
Set the namespace name of GS2-Mission.

Create > Game Server Services > Gs2Mission > Namespace

Field Description
NamespaceName Namespace Name

GS2-Money

Prefab

Gs2MoneyWalletPrefab

Retrieves and displays wallet information.

Components
Gs2MoneyWalletFetcher
Gs2MoneyWalletEnabler
Gs2MoneyWalletLabel

Gs2MoneyWithdrawAction

Perform wallet spend

Component
Gs2MoneyWithdraw

Fetcher Components

Gs2MoneyWalletFetcher

Retrieves wallet information.

Field Description
Wallet Wallet ScriptableObject.
Event Description
OnError(Gs2Exception error) Called when an error occurs.

View component

Gs2MoneyWalletBalanceEnabler

This component compares the wallet value to a specified number and enables/disables the associated GameObject.

The following conditions are used to switch between display and non-display.

Field Name Type Condition
Balance int number to compare
Field Name Condition
Paid Only Compare to Paid Currency Value
Loading Retrieving the wallet
Shortage Wallet is short of the specified value
Satisfaction Wallet is equal to or exceeds the specified value

Gs2MoneyWalletEnabler

This component automatically enables or disables the associated GameObject depending on the wallet acquisition status.

The following conditions are used to switch between display and non-display.

Field Name Condition
Loading Retrieving the wallet
Loaded Wallet has been retrieved

Gs2MoneyWalletLabel

Generates a string in the specified format and passes it to the target GameObject.

Field Name Type Description
format string Specify the format.
Format Description
{free} value of free billing currency
{paid} Paid currency value
{total} total amount of unpaid and paid currency

Action component

Gs2MoneyWithdraw

Consumes the balance from the wallet

ScriptableObject

Wallet

ScriptableObject that holds a reference to a GS2-Money Namespace ScriptableObject and specifies the slot number.

Create > Game Server Services > Gs2Money > Wallet

Field Description
Namespace Specify a Namespace ScriptableObject.
Slot Specifies a slot number.

GS2-Money Namespace

This is a ScriptableObject that holds a Namespace.
Set the name of the GS2-Money namespace.

Create > Game Server Services > Gs2Money > Namespace

Field Description
NamespaceName Namespace Name

GS2-Quest

Prefab

Gs2QuestLoadProgressAction

Obtains information on the progress of the quest and generates events according to the progress.

Components
Gs2QuestProgressFetcher
Gs2QuestLoadProgress

Gs2QuestQuestGroupListPrefab

Retrieves and displays a list of quest groups.

Component
Gs2QuestQuestGroupListFetcher
Gs2QuestQuestGroupListPrefab

Gs2QuestQuestGroupPrefab

Retrieves and displays quest groups.

Component
Gs2QuestCompletedQuestListFetcher
Gs2QuestQuestGroupFetcher
Gs2QuestQuestGroupPrefab
Gs2QuestQuestGroupEnabler

Gs2QuestQuestListPrefab

Displays a list of quests.

Component
Gs2QuestQuestListFetcher
Gs2QuestQuestListPrefab

Gs2QuestQuestPrefab

Retrieves and displays quest information.

Component
Gs2QuestQuestFetcher
Gs2QuestCompletedQuestListFetcher
Gs2QuestQuestPrefab
Gs2QuestQuestEnabler

Gs2QuestStartQuestAction

Start (receive) a quest.

Components
Gs2QuestStartQuest

Gs2QuestCompleteQuestAction

Set the quest to a successful state (completed).

Component
Gs2QuestCompleteQuest

Gs2QuestFailedQuestAction

Sets the quest to a failed state (completed).

Components
Gs2QuestFailedQuest

Fetcher Component

Gs2QuestProgressFetcher

Retrieves Quest Progress EzProgress .

Gs2QuestCompletedQuestListFetcher

Retrieves the list of completed quest information.

Gs2QuestQuestGroupListFetcher

Retrieves list of quest groups.

Gs2QuestQuestGroupFetcher

Retrieves quest group information.

Gs2QuestQuestListFetcher

Retrieves list of quest information in a quest group.

Gs2QuestQuestFetcher

Retrieves quest information.

View component

Gs2QuestQuestEnabler

Quest Progress EzProgress.

The conditions for switching between display and non-display include the following

Field Name Condition
Loading Obtaining a quest
Opened Quest can be accepted
Completed Completed the quest
Closed Unable to accept quests
Field Name Description
Target Target GameObject

Gs2QuestQuestGroupEnabler

This component automatically enables or disables the associated GameObject depending on the quest group's acquisition status.

The conditions for switching between display and non-display include the following

Field Name Condition
Loading During the acquisition of a quest group
Opened Quest Group is ready to accept orders
Closed Unable to accept a request for a quest group
Field Name Description
Target Target GameObject

Action component

Gs2QuestStartQuest

Sets the quest to successful (complete) status.

Gs2QuestCompleteQuest

Sets the quest to successful (complete) status.

Gs2QuestFailedQuest

Sets a quest to failed (complete) status.

Gs2QuestLoadProgress

Causes an event to be fired according to the progress of a quest.

Event Description
OnLoadProgress(EzProgress) Called when quest progress is obtained.
OnNotFoundProgress() Called when quest progress could not be obtained.
OnError(Gs2Exception error) Called when an error occurs.

ScriptableObject

Quest

QuestGroup ScriptableObject that holds a reference to a ScriptableObject and specifies the name of the quest.

Create > Game Server Services > Gs2Quest > Quest

Field Description
QuestGroup Specifies a QuestGroup ScriptableObject.
QuestName Specifies the name of the quest.

QuestGroup

GS2-Quest Namespace ScriptableObject that holds a reference to the ScriptableObject and specifies the Quest Group name.

Create > Game Server Services > Gs2Quest > QuestGroup

Field Description
Namespace Specifies a Namespace ScriptableObject.
QuestGroupName Specifies the name of a quest group.

GS2-Quest Namespace

This is a ScriptableObject that holds a Namespace.
Set the namespace name of GS2-Quest.

Create > Game Server Services > Gs2Quest > Namespace

Field Description
NamespaceName Namespace Name

GS2-Showcase

Prefab

Gs2ShowcaseDisplayItemListPrefab

Retrieve and display the product list.

Component
Gs2ShowcaseDisplayItemListFetcher
Gs2ShowcaseDisplayItemListPrefab

Gs2ShowcaseDisplayItemPrefab

Retrieves and displays product information.

Components
Gs2ShowcaseDisplayItemFetcher
Gs2ShowcaseDisplayItemPrefab
Gs2ShowcaseDisplayItemEnabler

Gs2ShowcaseBuyAction

Execution of product purchase

Component
Gs2ShowcaseDisplayItemFetcher
Gs2ShowcaseBuy

Fetcher component

Gs2ShowcaseDisplayItemListFetcher

Retrieves a list of products.

Gs2ShowcaseDisplayItemFetcher

Retrieves product information.

View component

Gs2ShowcaseDisplayItemEnabler

Product List EzShowcase.

The conditions for switching between display and non-display include the following

Field Name Condition
Loading Retrieving product listings
Loaded Product listings have been retrieved
Field Name Contents
Target Target GameObject

Action component

Gs2ShowcaseBuy

Purchase an item

ScriptableObject

Showcase

A ScriptableObject that holds a reference to a GS2-Account Namespace ScriptableObject and specifies the slot number where transfer information is stored.

Create > Game Server Services > Gs2Showcase > Showcase

Field Description
Namespace Specifies a Namespace ScriptableObject.
showcaseName Specifies the product list name (display shelf name).

GS2-Showcase Namespace

This is a ScriptableObject that holds a Namespace.
Set the namespace name of GS2-Showcase.

Create > Game Server Services > Gs2Showcase > Namespace

Field Description
NamespaceName Namespace Name

GS2-Stamina

Prefab

Gs2StaminaStaminaPrefab

Retrieves and displays stamina.

Component
Gs2StaminaStaminaFetcher
Nested Prefab
Gs2StaminaLabel
Gs2StaminaProgress

Gs2StaminaLabel

Generates a string of stamina values and passes it to the target GameObject.

Component
Gs2StaminaStaminaLabel

Gs2StaminaProgress

Set the slider to a stamina value.

Component
Gs2StaminaStaminaProgress

Gs2StaminaConsumeAction

Performs actions that consume stamina.

Component
Gs2StaminaConsume

Fetcher Component

Gs2StaminaStaminaFetcher

Retrieves the stamina model and current stamina.

Field Description
Stamina Stamina ScriptableObject.
Event Description
OnError(Gs2Exception error) Called when an error occurs.

View component

Gs2StaminaStaminaEnabler

This component automatically enables or disables the associated GameObject based on stamina status.

The following conditions are used to switch between display and non-display.

Field Name Condition
Loading Getting Stamina
Recovering Stamina is recovering
Max Stamina is the maximum value
Overflow Stamina is over the maximum value

Gs2StaminaStaminaLabel

Generates a string from the stamina in the specified format and passes it to the target GameObject.

Field Name Description
format Specify the format.
Format Description
{current} current stamina value (does not include overflow)
{total} current stamina value (including overflow)
{max} maximum value of stamina
{overflow} Stamina value held beyond the maximum value
{mm} Time until next stamina recovery (minutes) prefix zero padding
{ss} Time until next stamina recovery (seconds) prefix zero padding
{h} Time until next time stamina is restored (hour)
{m} Time until next time stamina is restored (minutes)
{s} Time until next stamina recovery (seconds)

Gs2StaminaStaminaProgress

This component reflects the percentage of the current value of stamina remaining in relation to the maximum value of stamina in the uGUI's Slider.
Associate with the same GameObject as the Slider.

Event Description
OnUpdate(Single) When retrieving the current stamina, a percentage of the stamina value (0,0f to 1.0f) is passed to the callback function
OnUpdateInverse(Single) When retrieving the current stamina, the inverse of the percentage of stamina value (1,0f to 0.0f) is passed to the callback function.

Action component

Gs2StaminaConsume

Performs an action that consumes stamina.

ScriptableObject

Stamina

A reference to a Namespace ScriptableObject, a ScriptableObject that holds the name of the stamina model.

Create > Game Server Services > Gs2Stamina > Stamina

Field Description
Namespace Specifies a Namespace ScriptableObject.
staminaNamea Stamina Model Name

GS2-Stamina Namespace

ScriptableObject that holds the Namespace.
Sets the namespace name for GS2-Stamina.

Create > Game Server Services > Gs2Stamina > Namespace

Field Description
NamespaceName Namespace Name