GS2-Formation API 레퍼런스

장비 기능이나 파티 편성 기능을 구현하기 위한 서비스입니다.

편성 정보를 기록하는 폼(Form)과, 편성한 폼을 저장하는 폼 저장 영역(Mold)이 있습니다.
파티 편성을 예로 들면, 캐릭터를 폼에 설정하여 파티를 편성합니다.
편성한 파티 정보를 여러 개 기록하려는 경우에는 폼 저장 영역을 사용하여 구현할 수 있습니다.

폼 저장 영역에 저장할 수 있는 수에는 용량을 설정할 수 있으며, 용량 값은 끌어올릴 수 있습니다.

폼에 편성하는 프로퍼티는 프로퍼티 ID로 지정하게 되지만, 프로퍼티의 정규 표현식으로 값을 제한할 수 있습니다.
또한 GS2-Inventory의 리소스를 설정하는 경우에는, GS2-Inventory가 발행하는 서명된 아이템 세트를 사용하여 편성 대상으로 지정할 수 있습니다.
서명된 아이템 세트란 해당 아이템을 소유하고 있음을 보증하는 서명이 포함된 프로퍼티 정보로, 이를 사용하는 경우에는 클라이언트에서 직접 편성하는 것을 허용합니다.

이 소유하고 있음을 보증하는 것은 편성 시점에서의 보증이며, 편성 후 프로퍼티를 처분한 경우에 대한 추적은 이루어지지 않습니다.
GS2-Inventory에서 프로퍼티를 소비하거나 매각하는 경우에는, 사전에 GS2-Formation에서 편성에 사용되고 있지 않은지에 대한 판정을 클라이언트 또는 스크립트에서 구현해야 합니다.

스탠다드 인벤토리(GS2-Inventory)를 사용하는 경우에는, ItemSet의 referenceOf 필드를 이용함으로써 편성 중인 아이템이 실수로 삭제되는 것을 방지할 수 있습니다.
폼의 슬롯에 아이템을 설정할 때, 해당 슬롯을 식별하는 문자열(GRN 등)을 ItemSet.referenceOf에 설정합니다.
스탠다드 인벤토리의 인벤토리 모델 설정에는 「referenceOf에 값이 존재하는 경우 소비를 금지한다」옵션이 있습니다.
이 옵션을 활성화하면 ItemSet.referenceOf가 비어 있지 않은 아이템은 소비·매각할 수 없게 되므로, 편성 중인 아이템에 대해 삭제 제한을 걸 수 있습니다.