v1.0
property
Adds a custom parameter to custom parameter list. This command is provided for backward compatibility, it is recommended that you use SIAddCustomParameter instead.
SIAddCustomParam( [InputObj], [ScriptName], [VarType], DefaultValue, MinValue, MaxValue, Classification, Capabilities, [SuggMin], [SuggMax], [ParamName], [Description] ); |
| Parameter | Type | Description | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| InputObj | String | List of custom parameter
list properties.
Default Value: Current Selection |
||||||||||||||||||||||||||
| ScriptName | String | Script name of the custom parameter to be added. This is
normally a short name, like "rotx". A script name cannot have
spaces in it.
Default Value: "ParamName" |
||||||||||||||||||||||||||
| VarType | Integer | Type of the custom parameter
Default Value: 5
|
||||||||||||||||||||||||||
| DefaultValue | Variant | Default value of the parameter | ||||||||||||||||||||||||||
| MinValue | Double | minimum value of the parameter
Default Value: 0.0 |
||||||||||||||||||||||||||
| MaxValue | Double | maximum value of the parameter
Default Value: 1.0 |
||||||||||||||||||||||||||
| Classification | siParamClassification | Classification
Default Value: siClassifUnknown |
||||||||||||||||||||||||||
| Capabilities | siCapabilities | Capabilities of the parameter
Default Value: siAnimatable+siPersistable for numeric parameters, siPersistable for string parameters |
||||||||||||||||||||||||||
| SuggMin | Double | Suggested minimum value of the parameter (for UI controls)
Default Value: MinValue |
||||||||||||||||||||||||||
| SuggMax | Double | Suggested maximum value of the parameter (for UI controls)
Default Value: MaxValue |
||||||||||||||||||||||||||
| ParamName | String | A name for the parameter that can be more descriptive than the
script name. For example "Rotation X" instead of "rotx".
Default Value: The ScriptName argument is reused |
||||||||||||||||||||||||||
| Description | String | A longer, descriptive version of the parameter name. This appears on the property page when the object is inspected. |
dim n set n = GetPrim( "Null" ) AddProp "Custom_parameter_list", , 0, "Custom Parameters" SIAddCustomParam n & ".Custom_Parameters","Happiness",5,0, -10, 10 RemoveCustomParam n & ".Custom_Parameters.Happiness" SIAddCustomParam n & ".Custom_Parameters","StringParam",8,"Defaultstr" DeleteObj n & ".Custom_Parameters" |