Master Data Reference of GS2-Formation
Master Data Format
{
"version": "2019-09-09",
"moldModels": [
{
"name": "[string]Form storage area model name",
"metadata": "[string?]Metadata",
"initialMaxCapacity": "[int]Initial capacity to store forms",
"maxCapacity": "[int]Maximum capacity to store forms",
"formModel": {
"formModelId": "[string]Form model GRN",
"name": "[string]Form model name",
"metadata": "[string?]Metadata",
"slots": [
{
"name": "[string]Slot model name",
"propertyRegex": "[string]Regular expressions for values that can be set as properties",
"metadata": "[string?]Metadata"
}
]
}
}
],
"propertyFormModels": [
{
"name": "[string]Property form model name",
"metadata": "[string?]Metadata",
"slots": [
{
"name": "[string]Slot model name",
"propertyRegex": "[string]Regular expressions for values that can be set as properties",
"metadata": "[string?]Metadata"
}
]
}
]
}| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| version | string | ✓ | 2019-09-09 | Format version of master data | ||
| moldModels | List<MoldModel> | ~ 100 items | Form storage area model If it is a party composition, it is intended to be saved in the form of “fire attribute party” or “water attribute party”. The number of areas that can be saved can be limited or expanded individually. | |||
| propertyFormModels | List<PropertyFormModel> | ~ 100 items | Property Form Model An entity that represents the composition status. The difference between Mold / Form is that Mold / Form defines the number of slots and records the composition in each slot, and Property Form is used to represent compositions that are difficult to determine the number of slots in advance, such as setting skills for owned equipment. |
Model
FormModel
Form Model
Form Model is an entity representing the configuration status.
You can define slots as areas that can be formed.
For weapons and armor, parts such as “right hand”, “left hand”, “body”, and “arm” can be used as slots, and for parties, positions such as “vanguard”, “midfield”, and “rear guard” can be expressed as slots.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| formModelId | string | ✓* | ~ 1024 chars | Form model GRN * Automatically configured on the server | ||
| name | string | ✓ | ~ 128 chars | Form model name Form model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| metadata | string | ~ 2048 chars | Metadata Arbitrary 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. | |||
| slots | List<SlotModel> | ✓ | 1 ~ 10 items | List of Slot Model |
SlotModel
Slot Model
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| name | string | ✓ | ~ 128 chars | Slot model name | ||
| propertyRegex | string | ✓ | “.*” | ~ 512 chars | Regular expressions for values that can be set as properties | |
| metadata | string | ~ 512 chars | Metadata Arbitrary 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. |
MoldModel
Form storage area model
If it is a party composition, it is intended to be saved in the form of “fire attribute party” or “water attribute party”. The number of areas that can be saved can be limited or expanded individually.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| moldModelId | string | ✓* | ~ 1024 chars | Form storage area GRN * Automatically configured on the server | ||
| name | string | ✓ | ~ 128 chars | Form storage area model name Form storage area model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| metadata | string | ~ 2048 chars | Metadata Arbitrary 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. | |||
| initialMaxCapacity | int | ✓ | 1 ~ 2147483646 | Initial capacity to store forms | ||
| maxCapacity | int | ✓ | 1 ~ 2147483646 | Maximum capacity to store forms | ||
| formModel | FormModel | ✓ | Form Model |
PropertyFormModel
Property Form Model
An entity that represents the composition status. The difference between Mold / Form is that Mold / Form defines the number of slots and records the composition in each slot, and Property Form is used to represent compositions that are difficult to determine the number of slots in advance, such as setting skills for owned equipment.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| propertyFormModelId | string | ✓* | ~ 1024 chars | Property form model GRN * Automatically configured on the server | ||
| name | string | ✓ | ~ 128 chars | Property form model name Property form model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| metadata | string | ~ 2048 chars | Metadata Arbitrary 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. | |||
| slots | List<SlotModel> | ✓ | 1 ~ 10 items | List of Slot Model |