> For the complete documentation index, see [llms.txt](/llms.txt)

# GS2-Formation API リファレンス

パーティ・装備編成機能




装備機能やパーティ編成機能を実現するためのサービスです。

編成情報を記録する フォーム(Form) と、編成した フォーム を保存する フォームの保存領域(Mold) があります。<br>
パーティ編成を例にすると、キャラクターを フォーム に設定し、パーティを編成します。<br>
編成したパーティ情報を複数記録する場合は フォームの保存領域 を使って実現できます。

フォームの保存領域 に保存できる数にはキャパシティを設定でき、キャパシティの値は引き上げることができます。

フォーム に編成するプロパティはプロパティIDで指定することになりますが、プロパティの正規表現で値を限定することができます。<br>
また、GS2-Inventory のリソースを設定する場合は、GS2-Inventory が発行する 署名付きアイテムセット を使って編成対象に指定できます。<br>
署名付きアイテムセット とは、該当のアイテムを所有していることを保証する署名付きプロパティ情報で、こちらを使う場合はクライアントから直接編成することを許します。

この「所有していることを保証する」とは編成時点での保証であり、編成後にプロパティを手放した場合のフォローはありません。<br>
GS2-Inventory でプロパティを消費したり売却したりする場合は、事前に GS2-Formation で編成に使用されていないかの判定はクライアントまたはスクリプトで実装する必要があります。

スタンダードインベントリ(GS2-Inventory)を使用している場合は、ItemSet の referenceOf フィールドを利用することで、編成中のアイテムが誤って削除されることを防ぐことができます。<br>
フォームのスロットにアイテムをセットする際に、そのスロットを識別する文字列(GRN など)を ItemSet.referenceOf に設定します。<br>
スタンダードインベントリのインベントリモデル設定には「referenceOf に値が存在する場合は消費を禁止する」オプションがあります。<br>
このオプションを有効にすると、ItemSet.referenceOf が空でないアイテムは消費・売却できなくなるため、編成中のアイテムに対して削除の制限をかけることができます。

[マイクロサービス紹介 / GS2-Formation](../../microservices/formation)



- [GS2-Formation Buff リファレンス](/ja/api_reference/formation/buff/)
  
- [GS2-Formation Deploy/CDK リファレンス](/ja/api_reference/formation/deploy/)
  
- [GS2-Formation SDK API リファレンス](/ja/api_reference/formation/sdk/)
  
- [GS2-Formation SDK for Game Engine API リファレンス](/ja/api_reference/formation/game_engine/)
  
- [GS2-Formation スクリプト トリガー リファレンス](/ja/api_reference/formation/script/)
  
- [GS2-Formation トランザクションアクション](/ja/api_reference/formation/stamp_sheet/)
  
- [GS2-Formation マスターデータリファレンス](/ja/api_reference/formation/master_data/)