Adds a property to objects.

Notice that UV cluster properties and vertex color properties can only be added to clusters which are always complete, see Geometry.AddCluster method.

Note: This command uses output arguments. C# and some scripting languages (such as JScript, PerlScript and Python) don't support arguments passed by reference so you need to use the best workaround for your situation:

For scripting languages this command returns an ISIVTCollection which you can use to get the output arguments.

For C# you can use the XSIApplication.ExecuteCommand method to call this command. ExecuteCommand packs the output arguments into a C# System.Object containing an Array of the output arguments (see Calling Commands from C#).

Scripting Syntax

SIAddProp( PresetObj, [InputObjs], [PropagationType], [PropertyName], [Value] );


Parameter Type Description
PresetObj String or a preset object (see SIGetPreset) One of the Property Presets
InputObjs String List of objects

Default Value: Current Selection

PropagationType siPropagationType Propagation type for property

Default Value: siDefaultPropagation

PropertyName String Name of property
Value XSICollection Returns the created properties


VBScript Example

'Example showing how two custom properties can be added with a single call to


SIGetPrim "Null", "FirstNull" , ActiveSceneRoot

SIGetPrim "Null", "SecondNull", ActiveSceneRoot

dim oCustomProperties, oCustomProperty

'Create a custom property under each null

SIAddProp "Custom_parameter_list", "FirstNull,SecondNull", , "Chain_From_Curve", oCustomProperties

'The return value is a collection of the newly created items

for each oCustomProperty in oCustomProperties

	SIAddCustomParameter oCustomProperty , _

		"nbJoints", siInt2, 10, 1, 1000, 8, 16, 1, 100, "Bones", "Number of Bones"


See Also

AddProp SIAddPropEx