runTimeCommand

ジャンプ先: 概要. 戻り値. フラグ. MEL 例.

概要

runTimeCommand [-annotation string] [-category string] [-categoryArray] [-command script] [-commandArray] [-commandLanguage string] [-default boolean] [-defaultCommandArray] [-delete] [-exists] [-hotkeyCtx string] [-numberOfCommands] [-numberOfDefaultCommands] [-numberOfUserCommands] [-save] [-showInHotkeyEditor boolean] [-userCommandArray] name

runTimeCommand は、取り消し可能、照会可能、および編集可能です。

作成されたコマンドが、引数とフラグを取らないことに注意してください。照会や編集もできません。

指定するコマンド名は固有である必要があります。名前自体は、英字かアンダースコアで始める必要があり、その後は英数字かアンダースコアを続けることができます。

起動時に自動的に読み込まれるスクリプトでランタイム コマンドを作成する場合は、default フラグを true に設定します。このように設定すると、アプリケーションがラン タイム コマンドを保存しようとしなくなります。

戻り値

照会モードでは、戻り値のタイプは照会されたフラグに基づきます。

フラグ

ロング ネーム(ショート ネーム)	引数タイプ	プロパティ
-annotation(-ann)	string
コマンドの説明です。
-category(-cat)	string
コマンドのカテゴリです。
-categoryArray(-caa)
すべてのラン タイム コマンドのカテゴリを返します。
-command(-c)	script
runTimeCommand が呼び出された場合に実行されるコマンドです。
-commandArray(-ca)
すべてのラン タイム コマンド名を含む文字配列を返します。
-commandLanguage(-cl)	string
編集または作成モードでこのフラグを使用すると、呼び出し側で「-command」フラグに渡すコマンドのスクリプト言語を選択できます。このフラグを指定しないと、コールバックは runTimeCommand コマンドがコールされた言語であると仮定されます。照会モードの場合、この runTimeCommand の言語が返されます。有効な値は「mel」または「python」です。
-default(-d)	boolean
ラン タイム コマンドを既定 コマンドに指定します。既定のラン タイム コマンドは、プリファレンスに保存されません。
-defaultCommandArray(-dca)
すべての既定のラン タイム コマンド名を含む文字配列を返します。
-delete(-del)
指定したユーザ ラン タイム コマンドを削除します。
-exists(-ex)
指定したオブジェクトが存在するかどうかによって、true または false を返します。他のフラグは無視されます。
-hotkeyCtx(-hc)	string
コマンドのホットキー コンテキストです。
-numberOfCommands(-nc)
ラン タイム コマンドの数を返します。
-numberOfDefaultCommands(-ndc)
既定のラン タイム コマンドの数を返します。
-numberOfUserCommands(-nuc)
ユーザ ラン タイム コマンドの数を返します。
-save(-s)
すべてのユーザ ラン タイム コマンドを保存します。
-showInHotkeyEditor(-she)	boolean
ホットキー エディタにこのランタイム コマンドが表示されるように指定します。既定は true です。
-userCommandArray(-uca)
すべてのユーザ ラン タイム コマンドの名前を含む文字配列を返します。

フラグはコマンドの作成モードで表示できます	フラグはコマンドの編集モードで表示できます
フラグはコマンドの照会モードで表示できます	コマンド内でフラグを複数回使用できます。

MEL 例

//    Create a command that simply prints a message.  After executing
//    the following lines enter the command name <i>MyHelloCommand</i>
//    in the Command Line.
//
if (!`runTimeCommand -exists MyHelloCommand`) {
    runTimeCommand
        -annotation "Print the word \"Hello\""
        -command ("print \"Hello\\n\"")
        MyHelloCommand;
}

//    Create a window with a button that invokes the <i>MyHelloCommand</i>
//    command.
//
window;
paneLayout;
button -command ("MyHelloCommand");
showWindow;