共有スクリプトの例

• スクリプト コードの共有と再利用

この例の目的では、共有スクリプトの名前は My Shared Script です。

public string GetExtension(string path)
{
var tokens = path.Split('.');
if (tokens.Length > 1)
{
return "." + tokens[tokens.Length - 1];
}
return null;
}

1. これは、提供されたファイル名の拡張子を取得するために使用されるパブリック メソッドです。

   public string GetExtension(string path)
   {
   var tokens = path.Split('.');
   if (tokens.Length > 1)
   {
   return "." + tokens[tokens.Length - 1];
   }
   return null;
   }

以下の例は、アクション スクリプトの例 (事前コミット フェーズ) から部分的に派生したものですが、アプローチは他のスクリプト タイプでも同じです。

#load "My Shared Script.csx"

var entity = Context.Target as IEntity;

// Make sure the following members are loaded
await entity.LoadMembersAsync(new PropertyLoadOption("FileName"), new RelationLoadOption("AssetTypeToAsset"));

var fileName = entity.GetPropertyValue<string>("FileName");
var extension = GetExtension(fileName);

// ...

1. 共有スクリプトをその名前で参照します。複数の #load "<Script Name>" ステートメントを追加することにより、複数の共有スクリプトを参照できます。

   #load "My Shared Script.csx"

   注意

   CLI によって提供される IntelliSense サポートを使用している場合、スクリプト名に .csx 拡張子を追加できます。これにより、ローカル ファイル システムでスクリプトを操作するときにファイルを解決できます。

2. Context から Target オブジェクトを取得し、IEntity にキャストします。Target は、作成または変更イベントに関与するアセットです。

   var entity = Context.Target as IEntity;

3. ファイル名プロパティとアセット タイプ リレーションが読み込まれていることを確認します。まだ読み込まれていない場合、それらは遅延読み込みされます。

   await entity.LoadMembersAsync(new PropertyLoadOption("FileName"), new RelationLoadOption("AssetTypeToAsset"));

4. GetPropertyValue を使用して、Target オブジェクトから FileName プロパティを取得します。

   var filename = entity.GetPropertyValue<string>("FileName");

5. 共有スクリプトを介して使用可能になる GetExtension(string path) メソッドを呼び出します。

   var extension = GetExtension(fileName);

スコープ

スクリプトのグローバル スコープにメンバー (メンバー、プロパティなど) を追加することは問題ありませんが、分離を改善し、メンテナンスを容易にするために、メンバーをクラスにグループ化することをお勧めします。上記の例は、次のように変換できます。

public static class FileHelper
{
public static string GetExtension(string path)
{
var tokens = path.Split('.');
if (tokens.Length > 1)
{
return "." + tokens[tokens.Length - 1];
}
return null;
}
}

メソッドの呼び出しは次のようになります。

var extension = FileHelper.GetExtension(fileName);