「バッチリスト」リファレンス - SpriteStudio/SS6PlayerForUnity GitHub Wiki

SS6Player for UNity（以降「SS6PU」）のインポータ「Batch Import」モードで使用する「バッチリスト」ファイルの記述ルールは下記になります。

Unity上のSS6PUの
Assets/SpriteStudio6/Documents/BatchImporter/List_BatchImporter.txt
に、英語テキスト版が入っています（基本的に本内容の英訳となりますが、こちらで記載が追い付いていないものについても、英語版の記載は存在しています）。

また、バッチリストの最小限の典型的例はこちらを参照してください。

※注意:
「SS5Player for Unity」のバッチリストとは一切の互換性がありません（コマンドが一新されています）。

基本ルール（文字コード等・原則）

「バッチリスト」のファイルは、下記のルールに則っている必要があります。

  • 全角文字での記載は基本的に禁止とします。
    本ファイルはできる限り半角英数字のみで記載してください。
    コマンドや空白・区切子などは全角で記載すると正常動作しません。
    フォルダ名などは全角文字を使用している場合もあるかとは思いますが、あまり推奨できません。
    バッチインポータの処理上「System.Text.Encoding.Default」（OSのデフォルト文字コード）でテキストを読み込んでいます（エディット時のヒューマンエラーを軽減する目的です）。

    半角英数字を使っている限り、気にする必要はありませんが、全角文字を使用する場合には環境依存を起こしやすいため、できるだけ避けることを推奨します（バッチリストの作成環境によって「Shift-JIS」「Unicode系（UTF-8/UTF-16/UTF-32）」「EUC」など様々な状況をとりえますので、特にバッチリスト作成者と実行者が違う場合や・実行マシン等が違ったりする際にトラブルが発生する可能性があります）。
    ※（トラブルが多いようでしたら）将来的に、文字コードを強制（例えばUTF-8（BOMなし）等）するかもしれません。

  • 改行コードは「CR」「LF」「CR+LF」どれでも構いません。
    恐らく「CR+LF (Windowsなどがこれです)」にしておけば、ほぼ間違いがないと思われます。

  • バッチリストは必ず「上から下」に実行されます。
    バッチリストに記載された全ての行の実行順序は上から下を保証します。
    並列実行や順序を並び替えた最適化処理等は行いません。

  • バッチリストや設定ファイルはネスティングできません。
    バッチリストからは「SettingFile」コマンドを使用して設定ファイルを呼び出すことができますが、設定ファイルやバッチリスト自体はネスティングできません。
    ※バッチリストや設定ファイルがネスティングできてしまうと、（ファイルの連携が複雑になりすぎて）インポートミスなどの温床になるため、ネスティングを可能にする予定はありません。

記載フォーマット（文法）

バッチリストは、基本的に下記の規則で記載します。

  • 空行は無視されます。

  • 行頭・行末などのタブやスペースなどは無視されます。
    コマンドの区切り部などに見易さのために空白やタブをはさむことも可能です（下記の「特殊行」などのインデントも可能です）。
    ただし、コマンド名などの途中に空白やタブが入っていた場合はエラーになりますので、注意してください。
    また、全角空白文字は空白として認識しませんので注意してください。

  • 行の先頭が特定の文字で開始されている場合は特別な意味を持ちます。
    以下の文字で開始されている行は、特別な意味を持っています（これを「特殊行」と呼称します）。

    • * : 注釈行。この行は無視されますので、メモなどに使用してください。
    • ? : 設定変更。コマンド群を使用してインポート設定を変更します。

  • 特殊行以外の行は、インポートするsspj名として認識されます。

  • 全ての行は複数行に分けないでください。
    sspjファイル行や特殊行を、間に改行を挟んで複数行にまたぐことはできません（またぐための記法はありません）。
    必ず、1行で記載してください。

ファイル・フォルダの記載について

インポートするsspjファイルや、フォルダ設定系コマンドなどでは、現在設定されているパスから相対パスで指定することも可能ですが、パスの記載には下記の制限が存在します。

  • フォルダ区切子は「/」を使用してください。
    「\」（円マークも同じ）も使用可能ですが、OSでの差異などが出づらいことも考慮して「/」での統一記載を推奨します。

  • ひとつ上のフォルダに遡るには「../」を使用します。

  • 相対パスを指定する際に「/」でパスを開始しないでください。
    先頭に「/」が存在する場合、絶対パス（ルート指定）とみなします。
    カレントディレクトリを指定する際に「/」で開始する記法がありますが（例:「/sample.sspj」）、使用できませんので注意してください。

  • ドライブ指定を含んだ相対パスを指定しないでください。
    例えば「C:sample.sspj」（Cドライブのカレントパスにあるsample.sspj）というようなドライブを切り替えた相対パス指定は禁止です（誤動作します）。
    ドライブ指定を含む場合、必ず絶対パス指定をしてください。

  • アセットフォルダを絶対パスで指定する場合「/」（ルート）は「Assets/」です。
    アセットフォルダの絶対パス指定する場合「Assets/」で開始しないでください（「Assets/」と指定すると「カレントフォルダ/Assets/」と解釈します）。
    例えば「Assets/SubFolder/」を絶対パスで指定する場合、「/SubFolder/」になります。

  • フォルダ指定の場合、末尾を「/」で終らせなくても構いません。
    原則、フォルダ名指定は末尾が「/」で終了する記載を推奨しますが、付いていない場合でも勝手にバッチインポータの内部処理が補完します。

  • ファイルを指定する場合、拡張子を省略しないでください。
    インポートするsspjファイルやインポート設定ファイルの指定では、ファイルの拡張子を省略しないでください。

コマンド解説

コマンドはインポートの設定を変更したりするために使用されます。
コマンドを使用する行は、先頭が「?」で開始されている必要があります。

また、コマンドと引数（パラメータ）との間の区切りは「>」を使用します。
※複数の引数をとるコマンドの場合、第n引数と第(n+1)引数の間は「>」ないし「,」で記述可能ですが、現在複数引数をとるコマンドは存在しません（「,」については予備仕様であることと・パスに使用可能な文字のため、後日文字を変更する可能性があります）。

コマンドはかなりの数存在しますが、3種類に大分できます。

フォルダ設定系 コマンド

インポート元やインポート先のフォルダを設定するコマンド群です。

NameBaseFolderAsset

  • 用法:
    NameBaseFolderAsset > アセットフォルダ名
  • 解説:
    インポート先のアセットフォルダのカレントフォルダを設定します。
    単独のファイルをインポートする時にProjectウインドウでインポート先を指定するのと同じ動作になります。
    前に指定されているカレントフォルダから相対パスで指定することも可能です。
    バッチリストの開始時点でのカレントフォルダは「/」（ルートアセットフォルダ: Assets/）です。
    無効なパスを指定した場合、誤動作や想定外の動作をする可能性があるので注意してください（本コマンド自体はアセットフォルの既存チェックをしていません）。
    ※一応無効なパスが指定された場合には、sspjファイルのインポート時にそのフォルダを新規作成される仕様にはなっています。

NameBaseFolderData

  • 用法:
    NameBaseFolderData > フォルダ名
  • 解説:
    インポートするsspjファイルのカレントフォルダを設定します。
    このコマンドの後に記述されるsspjファイルを相対指定した場合の基準フォルダになります。
    前に指定されているカレントフォルダから相対パスで指定することも可能です。
    パスがUnityのプロジェクト内を指す必要はありません（インポータと同様に、Unityのプロジェクト外のsspjファイルも扱えます）。
    バッチリストの開始時点でのカレントフォルダは、バッチリストが格納されているフォルダです。
    無効なパスを指定した場合、誤動作や想定外の動作をする可能性があるので注意してください（本コマンド自体はフォルダの既存チェックをしていません）。
    ※一応、実際にファイルアクセスが発生した段階で、フォルダやファイルの存在チェックはしています。

NameBaseFolderSetting

  • 用法:
    NameBaseFolderSetting > フォルダ名
  • 解説:
    インポータの設定ファイルのカレントフォルダを設定します。
    「SettingFile」コマンドで設定ファイルを相対指定した場合の基準フォルダになります。
    前に指定されているカレントフォルダから相対パスで指定することも可能です。
    パスがUnityのプロジェクト内を指す必要はありません（インポータの設定のセーブ・ロードと同様に、Unityのプロジェクト外のインポート設定ファイルも扱えます）。
    バッチリストの開始時点でのカレントフォルダは、バッチリストが格納されているフォルダです。
    無効なパスを指定した場合、誤動作や想定外の動作をする可能性があるので注意してください（本コマンド自体はフォルダの既存チェックをしていません）。
    ※一応、実際にファイルアクセスが発生した段階で、フォルダやファイルの存在チェックはしています。

インポート操作系 コマンド

インポートの動作を操作するためのコマンドです。
設定ファイルを読み込んだり、インポートのモードを変更したりするコマンドです。

SettingFile

  • 用法:
    SettingFile > インポート設定ファイル名
  • 解説:
    インポータの設定ファイルを読み込みます。
    インポータの「Save to Text-File」から保存した設定ファイルを読み込むことができます（設定ファイルを自力で書くことは不可能ではありませんが、コマンド数の多さや今後の追加なども加味すると、正直現実的ではありません）。
    ただし、設定ファイルの中の「インポートモード（Common_Mode）」とバッチインポートの設定で指定された無視設定については、設定ファイル内の記述を無視します（正確には、本コマンドで設定を読み込んだ後に、無視設定で上書きします）。
    バッチファイルの中からバッチインポートの設定を上書きする場合は、本コマンドの後の行に直接所定のコマンドを記載して上書きするようにしてください。

Common_Mode

  • 用法:
    Common_Mode > インポートモード名
  • 解説:
    インポートのモードを切り替えます。
    「SettingFile」コマンドで読み込んだ設定ファイルにモード設定が記載してあっても、無視されますので注意してください（インポート設定ファイルの中の本コマンドは、あくまでインポータのUI設定保存のためだけにしか動作しません）。
    モード指定（インポートモード名）の指定は下記の文字列で行います（初期状態は「SS6PU」です）。
    • SS6PU : 「SpriteStudio6 Player」モード
    • UNITY_NATIVE: 「Convert To Unity-Native」モード
    • UNITY_UI: 「Convert To Unity-UI」モード

インポート設定系 コマンド

インポートの設定を操作するコマンドです。
基本、このコマンド群はインポータの「Save to Text-File」で保存する設定（SettingFileコマンドで読み込むことができる）ファイルと内容が同じになります。
※つまり、本コマンド群の用例は、インポータ設定を保存してそのテキストファイルの内容を見ることで可能とも言いかえることができます。

個別のインポート設定を変更することができ、「SettingFile」コマンドの後にこのコマンド群を記載すると、読み込んだ設定の内容を上書きすることができます（設定ファイルを上書きするわけではありません）。

このコマンド群は使用に際して特殊な動作があり、インポート設定ファイルの中に記載された「ConfirmOverWrite_～」「CheckVersion_～」のコマンド群はバッチインポート設定の「Options」の設定で効果と無視を指定できますが、バッチリスト内にこれらのコマンドを直接記載するとバッチインポートの設定を上書する（直接コマンド記載が優先する）ことができます。

ただ、本コマンド群を直接バッチリストに記載することは極力控えて、インポート設定ファイルを使用することを推奨します。
あくまで、「設定を上書きしたい」場合に最小限で使用されるべきであると想定しています（バッチインポート設定やインポート設定ファイルを更新したにも関わらず、インポート結果が想定外になるなどの事故が起こりやすくなります）。
※バッチリストが長くなったり・開発段階でのトラブルで正常にインポートできなくなった時のチェックや、どうしても回避すべき設定状況が存在してしまった時のパッチ充てのために使用することを主目的にしています。

Basic_FlagCreateControlGameObject

  • 用法:
    Basic_FlagCreateControlGameObject > true/false
  • 解説:
    インポート設定の「（Basicオプション）Create Control-Prefab」と同じ動作です。
    trueがチェック、falseが非チェックになります。
  • 対象インポートモード:
    • SpriteStudio6 Player
    • Convrt to Unity-Native

Basic_FlagNestedPrefabUseScript（Ver.2.1以降）

Basic_FlagCreateProjectFolder

  • 用法:
    Basic_FlagCreateProjectFolder > true/false
  • 解説:
    インポート設定の「（Basicオプション）Create Project Folder」と同じ動作です。
    trueがチェック、falseが非チェックになります。
  • 対象インポートモード:
    • SpriteStudio6 Player
    • Convrt to Unity-Native
    • Convrt to Unity-UI

Basic_FlagCreateHolderAsset

Basic_FlagInvisibleToHideAll

Basic_FlagTextureReadable

Basic_FlagTrackAssets

  • 用法:
    Basic_FlagTrackAssets > true/false
  • 解説:
    インポート設定の「（Basicオプション）Tracking Assets」と同じ動作です。
    trueがチェック、falseが非チェックになります。
  • 対象インポートモード:
    • SpriteStudio6 Player

Basic_FlagDeleteMaterialUnreferenced（Ver.1.x系のみ）

Basic_FlagInvisibleToHideAll

Basic_FlagTakeOverLightRenderer

Basic_FlagConvertSignal

Basic_FlagIgnoreSetup

PreCalculation_FlagTrimTransparentPixelsCell

  • 用法:
    PreCalculation_FlagTrimTransparentPixelsCell > true/false
  • 解説:
    インポート設定の「（PreCalculationオプション）Trim transparent-pixels」と同じ動作です。
    trueがチェック、falseが非チェックになります。
  • 対象インポートモード:
    • SpriteStudio6 Player
    • Convrt to Unity-Native

ConfirmOverWrite_～

  • 用法:
    ConfirmOverWrite_～ > true/false
  • 解説:
    インポート設定の「Overwrite Confirm」の設定群と同じ動作です。
    trueがチェック、falseが非チェックになります。
  • 対応
    各設定に対応したコマンドは下記になります。
    • ConfirmOverWrite_FlagPrefabAnimation
      「Prefab-Animation」に対応しています。
    • ConfirmOverWrite_FlagPrefabEffect
      「Prefab-Effect」に対応しています。
    • ConfirmOverWrite_FlagDataProject （Ver.2.0以降）
      「Data-Project」に対応しています。
    • ConfirmOverWrite_FlagDataCellMap
      「Data-CellMap」に対応しています。
    • ConfirmOverWrite_FlagDataAnimation
      「Data-Animation」に対応しています。
    • ConfirmOverWrite_FlagDataEffect
      「Data-Effect」に対応しています。
    • ConfirmOverWrite_FlagDataSequence （Ver.2.0以降）
      「Data-Sequence」に対応しています。
    • ConfirmOverWrite_FlagMaterialAnimation （Ver.1.x系）
      「Material for Animation」に対応しています。
    • ConfirmOverWrite_FlagMaterialEffect （Ver.1.x系）
      「Material for Effect」に対応しています。
    • ConfirmOverWrite_FlagTexture
      「Texture」に対応しています。
  • 対象インポートモード:
    • SpriteStudio6 Player
    • Convrt to Unity-Native
    • Convrt to Unity-UI

Collider_FlagAttachCollider

  • 用法:
    Collider_FlagAttachCollider > true/false
  • 解説:
    インポート設定の「（Colliderオプション）Attach Collider」と同じ動作です。
    trueがチェック、falseが非チェックになります。
  • 対象インポートモード:
    • SpriteStudio6 Player

Collider_FlagCollider2D （Ver.2.0以降）

  • 用法:
    Collider_FlagCollider2D > true/false
  • 解説:
    インポート設定の「（Colliderオプション）Attach Collider」と同じ動作です。
    trueがチェック、falseが非チェックになります。
  • 対象インポートモード:
    • SpriteStudio6 Player

Collider_FlagAttachRigidBody

  • 用法:
    Collider_FlagAttachRigidBody > true/false
  • 解説:
    インポート設定の「（Colliderオプション）Attach Rigid-Body」と同じ動作です。
    trueがチェック、falseが非チェックになります。
  • 対象インポートモード:
    • SpriteStudio6 Player

Collider_FlagIsTrigger

  • 用法:
    Collider_FlagIsTrigger > true/false
  • 解説:
    インポート設定の「（Colliderオプション）Attach Rigid-Body」と同じ動作です。
    trueがチェック、falseが非チェックになります。
  • 対象インポートモード:
    • SpriteStudio6 Player

Collider_SizeZ

  • 用法:
    Collider_SizeZ > 数値
  • 解説:
    インポート設定の「（Colliderオプション）Collider Size-Z」と同じ動作です。
    数値は小数で指定可能ですが、0.0以下の値（0を含んだ負数）を指定しないでください。
  • 対象インポートモード:
    • SpriteStudio6 Player

CheckVersion_～

  • 用法:
    CheckVersion_～ > true/false
  • 解説:
    インポート設定の「Checking SSxx Version」の設定群と同じ動作です。
    trueがチェック、falseが非チェックになります。
    インポートモードが「SpriteStudio6 Player」「Convrt to Unity-Native」のどちらの時も共通です。
  • 対応
    各設定に対応したコマンドは下記になります。
    • CheckVersion_FlagInvalidSSPJ
      「SSPJ (Project)」に対応しています。
    • CheckVersion_FlagInvalidSSCE
      「SSCE (CellMap)」に対応しています。
    • CheckVersion_FlagInvalidSSAE
      「SSAE (Animation)」に対応しています。
    • CheckVersion_FlagInvalidSSEE
      「SSEE (Effect)」に対応しています。
  • 対象インポートモード:
    • SpriteStudio6 Player
    • Convrt to Unity-Native
    • Convrt to Unity-UI

RuleNameAsset_FlagAttachSpecificNameSSPJ

RuleNameAsset_～

  • 用法:
    RuleNameAsset_～ > 接頭文字列
  • 解説:
    インポート設定の「（Advancedオプション内「Naming Assets」オプション）各種別ファイル用接頭文字列」と同じ動作です。
    何も付与しない場合、空文字を指定します（その場合の書式は「RuleNameAsset_～ >」です）。
  • 対応
    各設定に対応したコマンドは下記になります。
    • RuleNameAsset_NamePrefixTexture
      「Texture」に対応しています。
      インポートモードが「SpriteStudio6 Player」「Convrt to Unity-Native」「Convert To Unity-UI」のいずれの時も共通です。
    • RuleNameAsset_NamePrefixPrefabAnimationSS6PU
      「Prefab-Animation」（SS6PU用のアニメーション用プレハブ）に対応しています。
    • RuleNameAsset_NamePrefixPrefabEffectSS6PU
      「Prefab-Effect」（SS6PU用のエフェクト用プレハブ）に対応しています。
    • RuleNameAsset_NamePrefixDataProjectSS6PU （Ver.2.0以降）
      「Data-Project」（SS6PU用のプロジェクト静的データ）に対応しています。
    • RuleNameAsset_NamePrefixDataCellMapSS6PU
      「Data-CellMap」（SS6PU用のセルマップ静的データ）に対応しています。
    • RuleNameAsset_NamePrefixDataAnimationSS6PU
      「Data-Animation」（SS6PU用のアニメーション静的データ）に対応しています。
    • RuleNameAsset_NamePrefixDataEffectSS6PU
      「Data-Effect」（SS6PU用のエフェクト静的データ）に対応しています。
    • RuleNameAsset_NamePrefixDataSequenceSS6PU （Ver.2.0以降）
      「Data-Sequence」（SS6PU用のシーケンス静的データ）に対応しています。
    • RuleNameAsset_NamePrefixMaterialAnimationSS6PU （Ver.1.x系） 「Material-Animation」（SS6PU用のアニメーション用マテリアル）に対応しています。
    • RuleNameAsset_NamePrefixMaterialEffectSS6PU （Ver.1.x系）
      「Material-Effect」（SS6PU用のエフェクト用マテリアル）に対応しています。
    • RuleNameAsset_NamePrefixPrefabAnimatorUnityNative
      「Prefab-Sprite2D」（UNITY_NATIVE用のアニメーション用プレハブ）に対応しています。
    • RuleNameAsset_NamePrefixPrefabParticleUnityNative （Ver.1.x系）
      「Prefab-Effect」（UNITY_NATIVE用のエフェクト用プレハブ）に対応しています。
      ※本機能は将来対応用の予約として確保されていましたが、Ver.2.0で廃止されました。
    • RuleNameAsset_NamePrefixAnimationClipUnityNative
      「Animation Clip」（UNITY_NATIVE用のアニメーション静的データ）に対応しています。
    • RuleNameAsset_NamePrefixMaterialAnimatorUnityNative （Ver.1.x系）
      「Material-Sprite2D」（UNITY_NATIVE用のアニメーション用マテリアル）に対応しています。
    • RuleNameAsset_NamePrefixMaterialParticleUnityNative （Ver.1.x系）
      「Material-Particle」（UNITY_NATIVE用のエフェクト用マテリアル）に対応しています。
      ※本機能は将来対応用の予約として確保されていましたが、Ver.2.0で廃止されました。
    • RuleNameAsset_NamePrefixPrefabAnimationUnityUI （Ver.2.1以降）
      「Prefab」（UNITY_UI用のUI.Image互換オブジェクトのプレハブ）に対応しています。
    • RuleNameAsset_NamePrefixAnimationClipUnityUI （Ver.2.1以降）
      「Animation Clip」（UNITY_UI用のアニメーション静的データ）に対応しています。
  • 対象インポートモード:
    • SpriteStudio6 Player
    • Convrt to Unity-Native
    • Convrt to Unity-UI

RuleNameAssetFolder_～

  • 用法:
    RuleNameAsset_～ > サブフォルダ名
  • 解説:
    インポート設定の「（Advancedオプション内「Naming Asset-Folders」オプション）各種別ファイル用サブフォルダ名」と同じ動作です。
  • 対応
    各設定に対応したコマンドは下記になります。
    • RuleNameAssetFolder_NamePrefixTexture
      「Texture」に対応しています。
      インポートモードが「SpriteStudio6 Player」「Convrt to Unity-Native」「Convert To Unity-UI」のいずれの時も共通です。
    • RuleNameAssetFolder_NamePrefixPrefabAnimationSS6PU
      「Prefab-Animation」（SS6PU用のアニメーション用プレハブ）に対応しています。
    • RuleNameAssetFolder_NamePrefixPrefabEffectSS6PU
      「Prefab-Effect」（SS6PU用のエフェクト用プレハブ）に対応しています。
    • RuleNameAssetFolder_NamePrefixDataProjectSS6PU （Ver.2.0以降）
      「Data-Project」（SS6PU用のプロジェクト静的データ）に対応しています。
    • RuleNameAssetFolder_NamePrefixDataCellMapSS6PU
      「Data-CellMap」（SS6PU用のセルマップ静的データ）に対応しています。
    • RuleNameAssetFolder_NamePrefixDataAnimationSS6PU
      「Data-Animation」（SS6PU用のアニメーション静的データ）に対応しています。
    • RuleNameAssetFolder_NamePrefixDataEffectSS6PU
      「Data-Effect」（SS6PU用のエフェクト静的データ）に対応しています。
    • RuleNameAssetFolder_NamePrefixDataSequenceSS6PU （Ver.2.0以降）
      「Data-Sequence」（SS6PU用のシーケンス静的データ）に対応しています。
    • RuleNameAssetFolder_NamePrefixMaterialAnimationSS6PU （Ver.1.x系）
      「Material-Animation」（SS6PU用のアニメーション用マテリアル）に対応しています。
    • RuleNameAssetFolder_NamePrefixMaterialEffectSS6PU （Ver.1.x系）
      「Material-Effect」（SS6PU用のエフェクト用マテリアル）に対応しています。
    • RuleNameAssetFolder_NamePrefixPrefabAnimatorUnityNative
      「Prefab-Sprite2D」（UNITY_NATIVE用のアニメーション用プレハブ）に対応しています。
    • RuleNameAssetFolder_NamePrefixPrefabParticleUnityNative （Ver.1.x系）
      「Prefab-Effect」（UNITY_NATIVE用のエフェクト用プレハブ）に対応しています。
      ※本機能は将来対応用の予約として確保されていましたが、Ver.2.0で廃止されました。
    • RuleNameAssetFolder_NamePrefixAnimationClipUnityNative
      「Animation Clip」（UNITY_NATIVE用のアニメーション静的データ）に対応しています。
    • RuleNameAssetFolder_NamePrefixMaterialAnimatorUnityNative
      「Material-Sprite2D」（UNITY_NATIVE用のアニメーション用マテリアル）に対応しています。
    • RuleNameAssetFolder_NamePrefixMaterialParticleUnityNative （Ver.1.x系）
      「Material-Particle」（UNITY_NATIVE用のエフェクト用マテリアル）に対応しています。
      ※本機能は将来対応用の予約として確保されていましたが、Ver.2.0で廃止されました。
    • RuleNameAssetFolder_NamePrefixPrefabAnimationUnityUI （Ver.2.1以降）
      「Prefab」（UNITY_UI用のUI.Image互換オブジェクトのプレハブ）に対応しています。
    • RuleNameAssetFolder_NamePrefixAnimationClipUnityUI （Ver.2.1以降）
      「Animation Clip」（UNITY_UI用のアニメーション静的データ）に対応しています。
  • 対象インポートモード:
    • SpriteStudio6 Player
    • Convrt to Unity-Native
    • Convrt to Unity-UI

PackAttributeAnimation_～

  • 用法:
    PackAttributeAnimation_～ > 格納形式名

  • 解説:
    インポート設定の「（Advancedオプション内「Attribute data Packing」オプション）各アトリビュート用設定」と同じ動作です。
    また、各格納形式の特性はこちらをご覧ください。

    格納形式名の名称は下記になります。 - StandardUncompressed : 「Standard Uncompressed」形式 - StandardCPE : 「Standard CPE」形式 - CPE_Flyweight : 「CPE & GOF Flyweight」形式 - CPE_Interpolate : 「CPE & Interpolate」形式

  • 対応
    各設定に対応したコマンドは下記になります。

    • PackAttributeAnimation_Status
      「Status」に対応しています。
    • PackAttributeAnimation_Cell
      「Cell」に対応しています。
    • PackAttributeAnimation_Position
      「Position」に対応しています。
    • PackAttributeAnimation_Rotation
      「Rotation」に対応しています。
    • PackAttributeAnimation_Scaling
      「Scaling」に対応しています。
    • PackAttributeAnimation_ScalingLocal
      「ScalingLocal」に対応しています。
    • PackAttributeAnimation_RateOpacity
      「RateOpacity」に対応しています。
    • PackAttributeAnimation_PartsColor
      「PartsColor」に対応しています。
    • PackAttributeAnimation_VertexCorrection
      「VertexCorrection」に対応しています。
    • PackAttributeAnimation_OffsetPivot
      「OffsetPivot」に対応しています。
    • PackAttributeAnimation_PositionAnchor
      「PositionAnchor」に対応しています。
    • PackAttributeAnimation_SizeForce
      「SizeForce」に対応しています。
    • PackAttributeAnimation_PositionTexture
      「PositionTexture」に対応しています。
    • PackAttributeAnimation_RotationTexture
      「RotationTexture」に対応しています。
    • PackAttributeAnimation_ScalingTexture
      「ScalingTexture」に対応しています。
    • PackAttributeAnimation_RadiusCollision
      「RadiusCollision」に対応しています。
    • PackAttributeAnimation_UserData
      「UserData」に対応しています。
    • PackAttributeAnimation_Instance
      「Instance」に対応しています。
    • PackAttributeAnimation_Effect
      「Effect」に対応しています。
    • PackAttributeAnimation_Deform
      「Deform」に対応しています。

  • 対象インポートモード:

    • SpriteStudio6 Player

  • 注意
    本コマンド群を直接記載することはできるだけ避けてください（最低でも、インポータの設定UIで設定して・ファイルに設定を保存して、そこからコピー＆ペーストするようにしてください）。
    本コマンド群で設定された場合、「本当にその格納形式が（アトリビュートに対して）使用可能か？」のチェックをしていません（インポータの設定UIで行われている適用可能かのチェックが行われていません）。
    そのため、本コマンドで間違った設定を行うと、インポート自体が正常に行われず、データが破壊される可能性があります。

PresetMaterial_～

  • 用法:
    PresetMaterial_～ > マテリアルのアセットパス

  • 解説:
    インポート設定の

    と同じ動作です。

    マテリアルのアセットパスは、下記の方法で指定されている必要があります。

    • アセット内絶対パス（パスの先頭が「/」で始まること）
    • 「.mat」の拡張子をつける

  • 注意
    本コマンド群を直接記載することはできるだけ避けてください（最低でも、インポータの設定UIで設定して・ファイルに設定を保存して、そこからコピー＆ペーストするようにしてください）。
    本コマンド群で設定された場合、「本当にそのパスにマテリアルが存在しているのか？」などのチェックをしていません。
    そのため、本コマンドで間違った設定を行うと、インポート後のデータにマテリアルの意図しない適用が行われる可能性があります。

  • 対応
    各設定に対応したコマンドは下記になります。

    • 「SS6Player」モード用 （Ver.1.x系）
      • PresetMaterial_AnimationSS6PUThroughStencilPreDraw
        SS6Playerモードの「for parts Not-Masked」内「[Mask]Pre-Draw」に対応しています。
      • PresetMaterial_AnimationSS6PUThroughStencilDraw
        SS6Playerモードの「for parts Not-Masked」内「[Mask]Draw」に対応しています。
      • PresetMaterial_AnimationSS6PUThroughMix
        SS6Playerモードの「for parts Not-Masked」内「[Sprite]Mix」に対応しています。
      • PresetMaterial_AnimationSS6PUThroughAdd
        SS6Playerモードの「for parts Not-Masked」内「[Sprite]Add」に対応しています。
      • PresetMaterial_AnimationSS6PUThroughSub
        SS6Playerモードの「for parts Not-Masked」内「[Sprite]Sub」に対応しています。
      • PresetMaterial_AnimationSS6PUThroughMul
        SS6Playerモードの「for parts Not-Masked」内「[Sprite]Mul」に対応しています。
      • PresetMaterial_AnimationSS6PUThroughMulNA
        SS6Playerモードの「for parts Not-Masked」内「[Sprite]MulNA」に対応しています。
      • PresetMaterial_AnimationSS6PUThroughScr
        SS6Playerモードの「for parts Not-Masked」内「[Sprite]Scr」に対応しています。
      • PresetMaterial_AnimationSS6PUThroughExc
        SS6Playerモードの「for parts Not-Masked」内「[Sprite]Enc」に対応しています。
      • PresetMaterial_AnimationSS6PUThroughInv
        SS6Playerモードの「for parts Not-Masked」内「[Sprite]Inv」に対応しています。
      • PresetMaterial_EffectSS6PUThroughMix
        SS6Playerモードの「for parts Non-Masked」内「[Effect]Mix」に対応しています。
      • PresetMaterial_EffectSS6PUThroughAdd
        SS6Playerモードの「for parts Non-Masked」内「[Effect]Add」に対応しています。
      • PresetMaterial_AnimationSS6PUMaskStencilPreDraw
        SS6Playerモードの「for parts Masked」内「[Mask]Pre-Draw」に対応しています。
      • PresetMaterial_AnimationSS6PUMaskStencilDraw
        SS6Playerモードの「for parts Masked」内「[Mask]Draw」に対応しています。
      • PresetMaterial_AnimationSS6PUMaskMix
        SS6Playerモードの「for parts Masked」内「[Sprite]Mix」に対応しています。
      • PresetMaterial_AnimationSS6PUMaskAdd
        SS6Playerモードの「for parts Masked」内「[Sprite]Add」に対応しています。
      • PresetMaterial_AnimationSS6PUMaskSub
        SS6Playerモードの「for parts Masked」内「[Sprite]Sub」に対応しています。
      • PresetMaterial_AnimationSS6PUMaskMul
        SS6Playerモードの「for parts Masked」内「[Sprite]Mul」に対応しています。
      • PresetMaterial_AnimationSS6PUMaskMulNA
        SS6Playerモードの「for parts Masked」内「[Sprite]MulNA」に対応しています。
      • PresetMaterial_AnimationSS6PUMaskScr
        SS6Playerモードの「for parts Masked」内「[Sprite]Scr」に対応しています。
      • PresetMaterial_AnimationSS6PUMaskExc
        SS6Playerモードの「for parts Masked」内「[Sprite]Exc」に対応しています。
      • PresetMaterial_AnimationSS6PUMaskInv
        SS6Playerモードの「for parts Masked」内「[Sprite]Inv」に対応しています。
      • PresetMaterial_EffectSS6PUMaskMix
        SS6Playerモードの「for parts Masked」内「[Effect]Mix」に対応しています。
      • PresetMaterial_EffectSS6PUMaskAdd
        SS6Playerモードの「for parts Masked」内「[Effect]Add」に対応しています。
    • 「Unity-Native」モード用
      • PresetMaterial_AnimationUnityNativeMix
        Unity-Nativeモードの（バッチング許可）「[Sprite]Mix」に対応しています。
      • PresetMaterial_AnimationUnityNativeAdd
        Unity-Nativeモードの（バッチング許可）「[Sprite]Add」に対応しています。
      • PresetMaterial_AnimationUnityNativeSub
        Unity-Nativeモードの（バッチング許可）「[Sprite]Sub」に対応しています。
      • PresetMaterial_AnimationUnityNativeMul
        Unity-Nativeモードの（バッチング許可）「[Sprite]Mul」に対応しています。
      • PresetMaterial_AnimationUnityNativeMulNA
        Unity-Nativeモードの（バッチング許可）「[Sprite]MulNA」に対応しています。
      • PresetMaterial_AnimationUnityNativeScr
        Unity-Nativeモードの（バッチング許可）「[Sprite]Scr」に対応しています。
      • PresetMaterial_AnimationUnityNativeExc
        Unity-Nativeモードの（バッチング許可）「[Sprite]Exc」に対応しています。
      • PresetMaterial_AnimationUnityNativeInv
        Unity-Nativeモードの（バッチング許可）「[Sprite]Inv」に対応しています。
      • PresetMaterial_AnimationUnityNativeNonBatchMix
        Unity-Nativeモードの（バッチング禁止）「[Sprite]Mix」に対応しています。
      • PresetMaterial_AnimationUnityNativeNonBatchAdd
        Unity-Nativeモードの（バッチング禁止）「[Sprite]Add」に対応しています。
      • PresetMaterial_AnimationUnityNativeNonBatchSub
        Unity-Nativeモードの（バッチング禁止）「[Sprite]Sub」に対応しています。
      • PresetMaterial_AnimationUnityNativeNonBatchMul
        Unity-Nativeモードの（バッチング禁止）「[Sprite]Mul」に対応しています。
      • PresetMaterial_AnimationUnityNativeNonBatchMulNA
        Unity-Nativeモードの（バッチング禁止）「[Sprite]MulNA」に対応しています。
      • PresetMaterial_AnimationUnityNativeNonBatchScr
        Unity-Nativeモードの（バッチング禁止）「[Sprite]Scr」に対応しています。
      • PresetMaterial_AnimationUnityNativeNonBatchExc
        Unity-Nativeモードの（バッチング禁止）「[Sprite]Exc」に対応しています。
      • PresetMaterial_AnimationUnityNativeNonBatchInv
        Unity-Nativeモードの（バッチング禁止）「[Sprite]Inv」に対応しています。
      • PresetMaterial_SkinnedMeshUnityNativeMix
        Unity-Nativeモードの「[Mesh]Mix」に対応しています。
      • PresetMaterial_SkinnedMeshUnityNativeAdd
        Unity-Nativeモードの「[Mesh]Add」に対応しています。
      • PresetMaterial_SkinnedMeshUnityNativeSub
        Unity-Nativeモードの「[Mesh]Sub」に対応しています。
      • PresetMaterial_SkinnedMeshUnityNativeMul
        Unity-Nativeモードの「[Mesh]Mul」に対応しています。
      • PresetMaterial_SkinnedMeshUnityNativeMulNA
        Unity-Nativeモードの「[Mesh]MulNA」に対応しています。
      • PresetMaterial_SkinnedMeshUnityNativeScr
        Unity-Nativeモードの「[Mesh]Scr」に対応しています。
      • PresetMaterial_SkinnedMeshUnityNativeExc
        Unity-Nativeモードの「[Mesh]Exc」に対応しています。
      • PresetMaterial_SkinnedMeshUnityNativeInv
        Unity-Nativeモードの「[Mesh]Inv」に対応しています。
    • 「Unity-UI」モード用 （Ver.2.1以降）
      • PresetMaterial_AnimationUnityUIMix Unity-UIモードの「[Sprite]」に対応しています。

  • 対象インポートモード:

    • SpriteStudio6 Player
    • Convrt to Unity-Native
    • Convrt to Unity-UI

バッチリストサンプル

バッチリストの典型的な形は下のような記述になります。
※このサンプルリストをテキストファイルに移しても、パスなどが違うためそのままでは動作できません。

実際に使用可能なバッチリストのサンプルは、sampledevelopブランチにあるアニメーション制御のサンプル群と一緒に提供されています。

* ==========================================
* Batch-Importer List-File
* ==========================================
* 
*       SpriteStudio6 Player for Unity
* 
*       Copyright(C) 1997-2021 Web Technology Corp.
*       Copyright(C) CRI Middleware Co., Ltd.
*       All rights reserved.
* 
* ------------------------------------------

* [Folder Setting]
? NameBaseFolderSetting > Data/
? NameBaseFolderData > /SpriteStudioProject/
? NameBaseFolderAsset > SettingFiles/

* [Import Setting]
? SettingFile > SS6PU_ImportSetting.txt

* [Import Mode]
? Common_Mode > SS6PU

* [Files]
Character/Sample01.sspj
UI/Sample02.sspj