HScriptでは、setコマンドを使って文字列を変数に割り当てることができます:

変数名は、アルファベットまたはアンダースコア(_)で始めて、その後はアルファベット、数字、アンダースコアで続けなければなりません。

コマンドで変数を使用するには、変数名の頭にドル記号($)を付けます:

> set foo = "bar"
> echo $foo
bar

変数名を中括弧({})で閉じることで、変数名が前後のテキストに影響を受けないようにすることができます:

> echo ${foo}baz
barbaz

さらに、中括弧によってHScriptは、その括弧の中の変数を評価する前に、その中の変数を展開します。これによって単純な配列を模倣することができます:

set foo1 = Padma
set foo2 = Mohammed
for i = 1 to 2 echo ${foo$i} end
Padma
Mohammed

HScriptでは、変数は、ローカルまたはグローバル(時々、システム変数と呼びます)のどちらかになります。

ローカル変数は、スクリプトではローカルに実行されます。スクリプトが終了すると、その変数が消えます。ローカル変数は、それを定義しているスクリプト外では使われません。ローカル変数を作成または設定するには、setを使用します。forとforeachループで作成される変数は常にローカルです。

グローバル変数は、すべてのスクリプトとHoudiniが起動したプログラムで利用可能です。グローバル変数を作成または設定するには、setenvまたはset -gを使います。

> set afile = /home/matt/bin/foo.bar
> echo $afile:e
bar
> echo ${afile:e}
bar

> echo ${afile:h}
/home/matt/bin

> echo ${afile:t}
foo.bar

> echo ${afile:e}
bar

> echo ${afile:r}
/home/matt/bin/foo

> echo ${afile:s}/foo/baz/
/home/matt/bin/baz.bar

> set str = Hello There
> echo ${str:u}
HELLO THERE

> set str = Hello There
> echo ${str:l}
hello there

set A = "foo1 foo2 foo3 foofoo4"

$A:u == "Foo1 foo2 foo3 foofoo4"
$A:u:u == "FOo1 foo2 foo3 foofoo4"
$A:gu == "Foo1 Foo2 Foo3 Foofoo4"
$A:gu:u == "FOo1 Foo2 Foo3 Foofoo4"
$A:au == "FOO1 FOO2 FOO3 FOOFOO4"

$A:s/foo/bar/ == "bar1 foo2 foo3 foofoo4"
$A:s/foo/bar/:s/foo/bar/ == "bar1 bar2 foo3 foofoo4"
$A:gs/foo/bar/ == "bar1 bar2 bar3 barfoo4"
$A:as/foo/bar/ == "bar1 bar2 bar3 barbar4"

エクスプレッション関数と違い、HScriptコマンドは関数ではないので、戻り値がありません。ただTextportにコマンドの結果を出力するだけです。コマンドの結果を変数に格納しようと

set objects = opls /obj

とタイプしても、$objects変数には文字列"opls /obj"が設定されるだけです。コマンドの結果を文字列として取り込むには、runエクスプレッション関数の中にそのコマンドを記述して、HScriptがそのエクスプレッションを評価するために、バッククォートで囲みます。以下がその例です。

set objects = `run("opsls /obj")`
echo $objects
model ambient1 light1 light2 light3 cam1

HScriptコマンドの出力をファイルにリダイレクトするには、コマンドの中で>filenameを使います。ファイルを上書きせずに追加書き込みするには、>>filenameを使います。標準出力と標準エラー出力の両方をリダイレクトするには、>&filenameを使います。

UNIXコマンドを使って外部プロセスを起動するとき、Textportの代わりに外部シェルでリダイレクトしたい場合があります。Houdiniコマンドインタプリタが外部シェルより先にリダイレクトに作用しないようにシングルクウォートで引数を囲みます。

unix myscript.pl '>output.txt'

ifとwhile構文で以下の演算子を使用することができます:

明確化するためにHScriptエクスプレッションを括弧で閉じることができますが、不要です:

for i = 1 to 10
...
end

for (i = 1 to 10)
...
end

シングルクォート(')内のテキストは展開されません。

ダブルクォート(")内のテキストは変数を展開します。

ダブルクォートで囲んだ文字列は1個の引数とみなされます。

バックスラッシュ文字(\\)は、その後の文字をエスケープします。例えば、文字列にダブルクォートを使用したい場合は、"I had a \\"great\\" time."のように記述します。

文字列の変数を展開する必要がないなら、シングルクォートを使用すれば評価速度が上がります。

スペースなしで2つのクォート文字を並べると、それらは1個の引数とみなされます。

例:

set foo = "Hello world"
echo '$foo='"$foo"
$foo=Hello world

echoコマンドは、'$foo=Hello world'として1個の引数としてみなしています。

HScriptでは、ダブルクォートよりもバッククォートの方が優先度が高いです。ダブルクォートでバッククォートの文字列を閉じていれば、バッククォートの文字列は最初のダブルクォートを完結させないでダブルクォートを含んでしまう場合があります。

例えば、以下の文字列があったとします:

foo`ch("/obj/geo1/tx")`

これは1個の引数とみなされます。

一般的な規則では、バッククォートとその中に入っている文字の間にはスペースを含めません。余分なスペースがあると、Houdiniはその文字列を評価しない場合があります。

#文字の後は、コメントになります。 文字として#を使用したいなら、その前にバックスラッシュ(\\)を付けてエスケープします。

Houdiniは入力行をスペースで単語に分割します。特殊文字; < > ( ) =を引用符のない文字列の中で使う場合には、注意してください。それらの特殊文字をHScriptの構文として動作させるには、前後に スペースを挿入します。HScriptは引数に関しては非常にゆるいです。基本的には、HScriptがコマンドやオプションとして理解しないものは、文字列として扱われます。これによって、引用符を記述する必要がなく、複数レベルの引用符を付けるのが簡単です。

一般的な規則では、HScriptに別解釈されたくない文字列には引用符を囲むべきです。

TextportではHScriptコマンドを入力して結果を確認することができます。Textportウィンドウを新規で開くには、Windows > Hscript Textportを選択します。Textportをペイン内に開くには、PaneメニューのSet Pane Tab Typeから Textport を選択します。

• クィックコピーアンドペースト: テキストを選択して、クリックすると、コマンドラインにそのテキストがペーストされます。

• クィックヘルプ: “help コマンド名”をタイプするとTextportにテキスト版のコマンドのオンラインヘルプが表示されます。

• 先行入力:Houdiniでは現在のコマンドの実行が終了する前に先立って新しいコマンドをタイプし始めることが可能です。Houdiniは、そのコマンドが終了すると、“バッファにある”コマンドを実行します。

• スクロール:PgUpと((PgDn)を押すとスクロールします。

• 継続: まだ終了していないコマンドライン(例えば、forループのブロックの途中)でEnterを押すと、コマンドラインは、オープンブロックをendで終えるまでタイプすることができます。

• コマンドヒストリー

  コマンドラインで以前のコマンドの再呼び出し

  ↑と↓を押すことで以前のコマンドの履歴を遡ることができます。以前に実行したコマンドのテキストは編集することができます。

  最後のコマンドの繰り返し

  コマンドラインで!!をタイプします。

  以前のコマンドの繰り返し

  num番目前のコマンドを実行するには、!-numとタイプします。 例えば、5つ前のコマンドを実行するなら、!-5とタイプします。

  パターンに一致した最後のコマンドの繰り返し

  コマンドラインで!stringとタイプすれば、そのstringを含む以前のコマンドを実行します。

  コマンドヒストリーの閲覧

  historyコマンドを使うとコマンドヒストリーが表示されます。

• 使用頻度の高いコマンドのエイリアスの作成

  HScriptでは、aliasコマンドを使って使用頻度の高いコマンドを引数を含めて新しい名前のコマンド名にすることができます。例えば、頻繁にシーンのオブジェクトの名前をリストにすることがあるなら、そのコマンドをobjsというように短い名前にすることができます。例:

  alias objs "opls /obj"
  

  コマンドラインでobjsとタイプすると、opls /objが実行されます。

  HScriptのエイリアス展開は、cshほど高度ではありません。例えば、エイリアス展開は再帰的ではありません。つまり、以下のコマンドは期待した結果にはなりません:

  alias opcd opcf
  alias cd opcd
  

  cdエイリアスは、unknown command "opcd"というメッセージが出ます。これはopcdのエイリアス展開が失敗しているからです。

  また、HScriptのエイリアス展開には、cshのようにヒストリーメタ文字置換機能がありません。

hscriptアプリケーションは、$HFS/binにあります。システムのコマンドライン上でそれを実行すると、Textportと同じコンソールが開き、そこでHScriptコマンドを実行して結果を確認することができます。

HScriptアプリケーションでは、GUIを使わなくてもHoudiniのフルパワーを発揮できるバッチスクリプトを記述することができます。

コマンドラインでhscript -qをタイプすれば、HScriptを起動したときに通常では表示されるバージョン情報を非表示にすることができます。これはHScriptスタンドアローンの処理の結果をリダイレクトするときに役に立ちます。

スクリプトファイルに複数のコマンドをカプセル化することができるので、その機能を再利用することができます。単純に実行したいコマンドを含んだテキストファイルを作成するだけです。一般的には、スクリプトパスにスクリプトファイルを保存します。例えば、$HOME/houdiniX.Y/scriptsにスクリプトファイルを保存します。

スクリプトには、exitステートメントを記述してスクリプトを途中で終了させることができます。これは、すべてのループをきっちりと終了します。HScriptは、UNIXシェルの“exit status”の設定をサポートしていませんが、グローバル変数を使えば同じことができます。

スクリプトを実行する時には引数を渡して動作をカスタマイズすることができます。スクリプトファイルに引数を使用するには、$argn変数を使います:

$arg0はコールしたスクリプトの名前が設定されます。

$arg1, $arg2, $arg3,などは、スクリプトに渡された引数が設定されます。

$argcはスクリプトに渡された引数の数が設定されます。例えば、myscriptスクリプトに引数をfirst second thirdという引数を指定すると、$argcは3になります。

引数の変数の番号をもっと単純に取り扱うには、shiftコマンドを使用します。shiftコマンドは、最初の引数を除去して、残りの引数をシフトします。つまり、$arg2だった引数が$arg1になります。シフトの繰り返しによって$arg1の値だけですべての引数を処理することができます。

readコマンドによってユーザからの入力を読み込むことも可能です。

実際に使用できるHScriptのサンプルを見てみましょう。

# Script for a guessing game (guess.cmd)

# First, get a random seed

set foo = `system(date)`
set seed = `substr($foo, 14, 2)``substr($foo, 17, 2)`

# Then, pick a random number

set num = `int(rand($seed)*100)+1`

set guess = -1
echo Guess a random number between 1 and 100.

while ( "$guess" != "$num" )
    echo -n Enter guess (q to quit): "
    read guess

    if ( "$guess" == q || "$guess" == "") then
        break;
    endif

    # Convert to a number
    set iguess = `atof($guess)`

    if ( $iguess < $num ) then
        echo Too low
    else if ( $iguess > $num ) then
        echo Too high
    else
        echo Spot on!
    endif
end

echo The number was $num

ucdとunixコマンドを使うと、その言語のランタイムを外部プロセスとして起動することができます。

Houdiniは、グローバルHScript変数を外部プロセスに環境変数として渡し、そのstatus変数をコマンドの終了コードに設定します。

Houdiniには、通常のホストシステムコマンドをコールする専用のHScriptコマンドがあります。例えば、ulsはディレクトリの内容をリストし、urmはファイルを削除し、upwdは現行ディレクトリを表示します。WindowsのようなUNIX以外のシステムにコードを使えるようにするには、そのUNIXユーティリティ(ls,rm,pwdなど)と同等のHScriptコマンドを使用します。

ビューアは、“desk.pane.type”という書式の名前を持っています:

• desk = ビューアペインを含むデスクの名前。

• pane = ビューアペインの名前。

• type = ペインの内容に応じて“world”、“particle”、“texture”。

すべてのビューアのリストを見るには、“viewls -n”を使います。ビューア関連のコマンドのほとんどでは、同時に2つ以上のビューアを指定することができ、ビューア名にワイルドカードを使用することができます。

ビューアは4つのビューポート(例えば、top、left、front、perspective)に分割することができます。ビューポートは、“desk.pane.type.viewport”という書式の名前を持っています:

• desk = ビューアペインを含むデスクの名前。

• pane = ビューアペインの名前。

• type = ペインの内容に応じて“world”、“particle”、“texture”。

• viewport = ビューアペイン内のビューポートの名前。ビューポートのディスプレイオプションエディタのビューポートの名前を変更することができます。すべてのビューポートをリストするには、“viewls -n -v”(各ビューポートが存在するビューアが何か表示するには、“viewls -v”を使用)を使用します。

ビューポート関連コマンドのほとんどでは、同時に2つ以上のビューアを指定することができ、ビューア名にワイルドカードを使用することができます。ビューアの名前を使ってビューア内のすべてのビューポートを参照することができます。例えば、"viewcamera -c cam1 Build.panetab1.world.persp1 Build.panetab1.world.top1 ..."の代わりに"viewcamera -c cam1 Build.panetab1.world.*"または"viewcamera -c cam1 Build.panetab1.world"を使用することができます。

ビューポート関連コマンドのほとんどは、ビューポートだけでなくビューメモリでも動作します。ビューメモリは、"desk.pane.type:memory"の形式を持ち、memoryは1から9の番号または名前です。最初の3つのコンポーネント(desk name、pane name、type)にはワイルドカードを使うことができます。ビューメモリすべてをリストするには、viewls -n -lを使用してください。

viewlayoutコマンドは、ビューアペインのビューポートの数とレイアウトを設定します。

• TextportでHoudiniが内部的に実行するHScriptコマンドを出力するには、commandecho onを使用します。

• Houdiniで使用できるコマンドの最大の行長さは、すべての展開を含めて8 KBです。

• コマンドラインで使用できる引数の最大数は1024個です。

• 1個のソースファイル内のifステートメントでネスト化できる最大数は、128個です。

• ソースファイルの最大容量は、ファイルを開くシステムの制限に依存します。

• ループのネストには制限はありません。