新しいカスタムパラメータをカスタムプロパティに追加します。このバージョンは、CustomProperty.AddParameter2
の単純化バージョンです。
特に使用頻度の高い siCapabilities フラグである
siAnimatable および SiReadOnly は、オプションの引数として直接表示されます。
ほとんどのパラメータは、このメソッドを使って指定できます。ただし、パラメータが UI
range、特定の分類フラグ、またはユーザ名を必要とする場合は、CustomProperty.AddParameter
または CustomProperty.AddParameter2
の使用を考慮してください。
oReturn = CustomProperty.AddParameter3( ScriptName, ValueType, [DefaultValue], [Min], [Max], [Animatable], [ReadOnly] ); |
新しく作成されたParameterオブジェクト
| パラメータ | タイプ | 詳細 |
|---|---|---|
| ScriptName | String | カスタム パラメータの名前。 この引数は、Parameter.ScriptNameおよびSIObject.Nameの両方を指定します。スペースを含めることはできません。 |
| ValueType | siVariantType | カスタムパラメータのタイプ。推奨タイプは siString、siBool、siInt4、siUByte、および siFloat です（Parameter.ValueTypeを参照）。 |
| DefaultValue | Variant | カスタムパラメータのデフォルト値。ブール値および数値の場合のデフォルト値は 0で、文字列のデフォルト値は""です。（Parameter.Defaultを参照）。 |
| 最小 | Variant | カスタムパラメータの最小値。siString タイプと siBool タイプでは Min 値は不要です。その他の数値タイプでは、デフォルト値をそのタイプの最小値にすることができます。たとえば、すべての未署名値には min=0 が設定されます（Parameter.Minを参照）。 |
| 最大 | Variant | カスタムパラメータの最大値。siString タイプと siBool タイプでは Max 値は不要です。その他の数値タイプでは、デフォルト値をそのタイプの最小値にすることができます。たとえば、siUByte の最大値は 255 です（Parameter.Maxを参照）。 |
| アニメート可能 | Boolean |
パラメータがアニメーションをサポートするように指定します。この引数は、アニメーションをサポートしない文字列パラメータでは無視されます。Parameter.Animatableを使用すると、パラメータの特定インスタンスに対してこの設定を上書きすることができます。
デフォルト値： true |
| 読み取り専用 | Boolean |
このパラメータの値をユーザが変更できないことを指定します。読み取り専用パラメータの場合はスクリプトを使用して変更できます（Parameter.Valueを参照）。Parameter.ReadOnlyを使用すると、パラメータの特定インスタンスに対してこの設定を上書きすることができます。
デフォルト値： false |