PluginRegistrar.RegisterOperator

Introduced

v5.1

Description

Registers a CustomOperatorPluginItem.

C# Syntax

PluginItem PluginRegistrar.RegisterOperator( String in_name );

Scripting Syntax

oReturn = PluginRegistrar.RegisterOperator( Name );

Return Value

PluginItem

Parameters

Parameter Type Description
Name String Name of the custom operator to register. It should begin with a letter and contain only letters, numbers and the underscore character.

If an operator name contains spaces (for example, "My Custom Operator"), the callback function names must omit the spaces (for example, "MyCustomOperator_Update").

Examples

JScript Example

function XSILoadPlugin( in_reg )
{
	in_reg.Author = "ABC" ;
	in_reg.Name = "ABC plugin" ;
	in_reg.Major = 1;
	in_reg.Minor = 0;
	in_reg.URL = "www.abc.com"
	// Let Softimage know that this plugin implements this CustomOperator
	in_reg.RegisterOperator( "myCustomOperator" ) ;
	return true ;
}

See Also

Plugin.Items Definition Callbacks for Operators