v1.1 から v1.2 への移行マニュアル - SpriteStudioArchive/SS5PlayerForUnity_v1_2_1 GitHub Wiki

v1.1 から v1.2 への移行マニュアル

v.1.2.0が正式リリース（「Alpha」「Beta」などの仮リリース表記が消える）までの間、v.1.1.18からの変更点については、本ページで解説いたします。

仕様変更点概要

（v1.2.0 Alpha-2 現在）

  • アニメーションデータ本体を別アセットに分離しました。
  • この改変で、同じアニメーションデータをシーンに複数個登場させた場合の使用メモリが削減されています（今まではシーン内の各アニメーションオブジェクトがデータを保持していたために使用体数分メモリを消費していましたが、本バージョンからアニメーションデータの実体は1つになるので、同アニメーションデータを複数使用した場合の使用メモリが大幅に削減されています）。
  • インポート時のオプションが追加されています。

留意点概略

（V1.2.0 Alpha-2 現在）

  • アニメーションデータ本体が別アセットに分離されたため、v1.1.18までのようにインスタンスの持つアニメーションデータを直接改変して、特定のインスタンスのみ異なるアニメーションデータの内容に変更するような実装が通常の方法ではできなくなっています。
  • インポータの新機能として「上書き対象のインポート済み既存プレハブ」で使用している各種アセットの格納位置を追跡して、上書きする機能がつきました。この機能の設定等の運用については、後述の変更点をご参照の上、（v.1.2.0への移行の再インポート時に）プロジェクトに意図しない影響を及ぼさないよう、ご検討の上設定してください。

V1.1から変更された各種名称・定義など

（V1.2.0 Alpha-2 現在）

  • アニメーションデータ本体をアセット格納するための「Script_SpriteStudio_AnimationReferenced.cs」というスクリプトファイルが増えています（ScriptableObject用の内容定義ファイルです）

インポート時オプションの変更点について

（V1.2.0 Alpha-2 現在）

  • インポート時のオプションの羅列順序が変わっているので注意してください。大きく分けて下記の分類に再編されています。
  • Options for basic（基本的なオプション群）
  • Options for Collision-Detection（コリジョン関係のオプション群）
  • Options for getting path of assets from existing Prefab data（既存データの追跡オプション群）

上記の内、「Options for Basic」「Options for Collision-Detection」の区分に格納されているオプションは、v1.1.18までの各同名のオプションと同機能です。
一方、「Options for getting path of assets from existing Prefab data」の区分はv1.2.0(Alpha-2)以降で追加されたオプションです。

  • Fixed-Animation Data
    　インポートされた際に既存している上書き対象のPrefabが持っている「固定アニメーションデータ（最初にインポートした際は「Animation」というフォルダ内に格納されているScriptableObjectのアセット）」を、上書き対象のプレハブが参照している当該データを追跡して上書きします。
    　このオプションをチェックしないと、（V1.1.18までのMaterialやTextureのインポートと同様に）Prefabのインポート先の「Animation」サブフォルダ内にデータを作成します。

  • Material
    　インポートされた際に既存している上書き対象のPrefabが持っている「Based-Material Table」で格納されている各マテリアルの格納位置を追跡して上書きします。
    　このオプションをチェックしないと、V1.1.18までのインポートと同様にPrefabのインポート先の「Material」サブフォルダ内にデータを作成します。
    　このオプションがチェックされている場合でも、使用マテリアル数（sspjデータ内に定義されているセルマップ数）が既存データと異なる場合、（完全な追跡が不可能なため、安全をとって）チェックされていない時と同じ動作をしますので、注意してください。

  • Texture (from Material)
    　インポートされた際に既存している上書き対象のPrefabが持っている「Based-Material Table」で格納されている各マテリアルが参照しているテクスチャを追跡して上書きします。
    　このオプションをチェックしないと、V1.1.18までのインポートと同様にPrefabのインポート先の「Texture」サブフォルダ内にデータを作成します。
    　このオプションがチェックされている場合でも、使用セルマップ数が既存データと異なる場合やマテリアルに割り当たっているテクスチャが特殊な設定がされていた場合（例えば「～_MIX」「～_ADD」「～_SUB」「～_MUL」で異なるテクスチャが割り当たっていた場合など）については、（安全をとって）チェックされていない時と同じ動作をしますので、注意してください。

※上記、3つの新オプションについては、特に「他のアニメーションデータなどとMaterial/Textureアセットを（インポート後に手動で）共有化させた」場合などには、細心の注意を払って設定するようにしてください（使用しているアセットの格納位置を追跡して上書きしますので、対象の上書きデータが複数アセットの共有データであったりした場合、共有しているアセット全てに影響が出てしまいます）。

バッチインポータサンプルの追加命令について

（v1.2.0 Alpha-2 現在）
上記、インポータのオプション追加に伴い、バッチインポータサンプルの「?」で行が始まる命令に追加があります。

  • FlagGetAnimationReferencedPartsRoot
    　インポータの設定ダイアログ中の「Fixed-Animation Data」と同じ機能の命令です。
    　trueでチェック状態と同じ・falseで非チェック状態と同じ動作をします。
    　デフォルト値は「true」です。

  • 使用例
    ? FlagGetAnimationReferencedPartsRoot > false

  • FlagGetMaterialPartsRoot
    　インポータの設定ダイアログ中の「Material」と同じ機能の命令です。
    　trueでチェック状態と同じ・falseで非チェック状態と同じ動作をします。
    　デフォルト値は「true」です。

  • 使用例
    ? FlagGetMaterialPartsRoot > true

  • FlagGetTextureMaterial
    　インポータの設定ダイアログ中の「Texture (from Material)」と同じ機能の命令です。
    　trueでチェック状態と同じ・falseで非チェック状態と同じ動作をします。
    　デフォルト値は「true」です。

  • 使用例
    ? FlagGetTextureMaterial > true

その他注意点

  • v1.2.0はv1.1.18からアニメーションファイルの形式が大きく変わっているため、プレイヤーを更新した場合アニメーションの再コンバートが必要となります。
  • v1.1.xからv1.2.0への以降をする際の再コンバート時には、プロジェクト全体への影響を考慮して、追加された3つのインポートオプションのチェック・非チェックを吟味して設定するようにしてください。