CreatePropertyWizard

Introduced

v7.5

Description

Creates an instance of a custom property wizard you can use to generate self-installing CustomProperty plug-ins. The resulting wizard is a CustomProperty nested under the SDK wizard model which itself resides under the scene root.

Scripting Syntax

oReturn = CreatePropertyWizard( [DestinationDir], [MigrationProperty], [PropName] );

Return Value

Newly created custom property wizard as a CustomProperty object.

Parameters

Parameter Type Description
DestinationDir String The destination folder for the plug-in to generate.

Default Value: If no destination folder is specified, the wizard property will be created in the user path.

MigrationProperty String List of CustomProperty objects you wish to migrate with the new plug-in.

Default Value: Current selection

PropName String Name of the property to create.

Default Value: Custom Property Wizard

Examples

JScript Example

/*

	This example demonstrates how to create a property wizard using 

	the CreatePropertyWizard command and then generate a very simple 

	custom property using the new wizard.

*/

var propwiz = CreatePropertyWizard();

propwiz.ScriptLanguage = "JScript";

propwiz.PropertyName = "XYZProp";

// Declare parameters

propwiz.ParamType = "siBool";

propwiz.ParamName = "BoolParam";

AddParamToPropertyWizard(propwiz);

propwiz.ParamType = "siFloat";

propwiz.ParamName = "FloatParam";

AddParamToPropertyWizard(propwiz);

// Generates the XYZProp property implementation and plug-in

GeneratePropertyPlugin(propwiz);

var xyzprop = ActiveSceneRoot.Properties("XYZProp");

Application.LogMessage(xyzprop.Name);

// Expected results:

// INFO : XYZProp

See Also

GeneratePropertyPlugin AddParamToPropertyWizard Property Wizard help CreateCommandWizard CreateEventWizard CreateFilterWizard CreateICENodeWizard CreateOperatorWizard