CreateCommandWizard

Introduced

v7.5

Description

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

Scripting Syntax

oReturn = CreateCommandWizard( [DestinationDir] );

Return Value

Newly created custom command 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.

Examples

JScript Example

/*

	This example demonstrates how to create a command wizard using 

	the CreateCommandWizard command and then generate a very simple 

	custom command using the new wizard.

*/

var cmdwiz = CreateCommandWizard();

cmdwiz.ScriptLanguage = "Python";

cmdwiz.ScriptingName = "XYZCmd";

cmdwiz.PluginName = "XYZCmdPlugin";

// Generates the command XYZ implementation and plug-in

GenerateCommandPlugin(cmdwiz);

var xyzcmd = Application.Commands("XYZCmd");

Application.LogMessage(xyzcmd.Name); 

// Expected results:

// INFO: "XYZCmd"

See Also

GenerateCommandPlugin Command Wizard help CreatePropertyWizard CreateEventWizard CreateFilterWizard CreateICENodeWizard CreateOperatorWizard