SIAddCustomParameter

Introduced

1.0

Description

Adds a custom parameter to a custom parameter set.

Scripting Syntax

SIAddCustomParameter( [InputObj], [ScriptName], [VarType], DefaultValue, [MinValue], [MaxValue], [Classification], [Capabilities], [SuggMin], [SuggMax], [ParamName], [Description] )

Parameters

Parameter

Type

Description

InputObj

String

List of custom parameter sets

Default Value: Current selection

ScriptName [in/out]

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 [in/out]

siVariantType

Type of the parameter

Default Value: siDouble

DefaultValue [in/out]

Variant

Default parameter value

MinValue [in/out]

Double

minimum value of the parameter

Default Value: 0.0

MaxValue [in/out]

Double

maximum value of the parameter

Default Value: 1.0

Classification

siParamClassification

Determines the classification of the parameter (gives Softimage some hint about the purpose of the Parameter--see the siParamClassification enum for more details)

Default Value: siClassifUnknown

Capabilities [in/out]

siCapabilities

Determines the capabilities of the parameter (see the siCapabilities enum for more details)

Default Value: 5 (siAnimatable + siPersistable)

SuggMin [in/out]

Double

Suggested minimum value of the parameter (for UI controls)

Default Value: MinValue

SuggMax [in/out]

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".

Description

String

Description of the parameter

See Also

SIAddCustomParam

CustomProperty.AddParameter

Parameter

Examples

• See SIAddCustomParameter.1.vbs

• See SIAddCustomParameter.2.vbs



Autodesk Softimage 2011