GS2-Formation API Reference

This service is designed to realize equipment and partying functions.

There are two types of forms: Forms, which record formation information, and Molded forms, which save the forms that have been formed. For example, to organize a party, you can set the characters in a form and organize the party. If you want to record multiple party information, you can use Form Storage Area.

The number of Form Storage Area can be set to a certain capacity, and the capacity value can be increased.

The properties organized in a form are specified by property IDs, but the values can be restricted by property regular expressions. When setting up GS2-Inventory resources, you can also specify the organization target using a signed itemset issued by GS2-Inventory. A signed itemset is property information with a signature that guarantees ownership of the item, and allows organization directly from the client.

This assurance of ownership is a guarantee at the time of composition, and there is no follow-up if the property is relinquished after composition. If a property is to be consumed or sold in GS2-Inventory, the determination of whether or not it has been used for organization in GS2-Formation must be implemented in the client or in a script beforehand.

When using Standard Inventory (GS2-Inventory), you can prevent accidental deletion of items that are currently in formation by using the referenceOf field on ItemSet. Set the formation slot identifier (e.g., a GRN or any string that identifies the formation slot) in ItemSet.referenceOf when placing an item into a formation slot. Standard Inventory also has an option in the Inventory Model settings to “prohibit consumption when referenceOf is set”. When this option is enabled, any item whose ItemSet.referenceOf is non-empty cannot be consumed or sold, effectively locking the item while it is in use in a formation.