移動先: 概要 戻り値 関連項目. MEL 例.

概要

registerPluginResource(string $pluginName, string $lookUpKey, string $defaultValue)

プラグインで使用する文字列リソースを登録し、 デフォルト値を割り当てます。一度登録したリソースは、getPluginResource を使用して読み出せます。

ルックアップ キーは固有にしてください。プラグイン名とルックアップ キーは、ともにリソースを固有に特定するために使用します。プラグイン名は、loadPlugin コマンドに渡される文字列と同じです。

ローカライズしたリソース文字列を指定すると、指定した文字列が、setPluginResource コマンドを使用して初期の登録値をオーバーライドします。 リソースは、他の値でオーバーライドする前に、まず登録する必要があります。

プラグイン リソースは、getPluginResource コマンドを使用して読み出します。 プラグイン リソースは、最初に登録する必要があります。MEL では registerPluginResource コマンドを使用し、プラグインのコードでは MStringResource::registerString を使用します。登録後、ローカライズした値は setPluginResource を使用してリソースに設定できます。

このコマンドは、プラグインのスクリプト ファイルで使用する各文字列リソースのプラグインのロード中に呼び出します。 通常、これらの呼び出しは、UI 文字列登録プロシージャで行います(MFnPlugin::registerUIStrings を参照)。 C++ コードで使用するプラグイン リソースは、通常、プラグイン コードで登録されます(MStringResource::registerString を参照)。

戻り値

なし

関連項目

getPluginResource, loadPluginLanguageResources, setPluginResource

引数

変数名 変数型 説明
$pluginNamestring固有のプラグイン名です(loadPlugin に渡されるとおり)。
$lookUpKeystringこの文字列リソースの固有のキーです。
$defaultValuestringリソースに関連付けるデフォルト文字列の値です。

MEL 例

	// Assign resource values that will be used to initialize
	// menu item labels for the plugin. 
	// The plugin name is "myPlugin" and each resource has a unique
	// key. 
	// The default values given for the resource will be used unless
	// they are subsequently overridden using setPluginResource. 
	// 
	registerPluginResource("myPlugin", "showBBoxLabel", "Show Bounding Box");
	registerPluginResource("myPlugin", "hideBBoxLabel", "Hide Bounding Box");