<     > 

Plugin

The Plugin section contains information crucial to scripted or compiled operators, like defining the entry points. The short name, long name, and bitmap for an operator are specified in the file header.

This section contains the following topics:

• Scripted Operator

• Compiled Operator

Scripted Operator

Plugin = Scripted
{
   Language = "scripting_language";
   FileName = name of the external script file
   Update =
   BeginScript
   script_code
   EndScript
   Helpers =
   BeginScript
   script_code
   EndScript
}

scripting_language

This is the progID of the scripting language; for example, “VBScript” or ‘JScript”.

FileName

You can reference an external script to run in the SPDL file. The script must be installed in the ...\Data\Scripts folder, relative to the SPDL installation point. For example, if this is the location of your SPDL file:

C:\users\simonin\Softimage\XSI_Mallorca_beta5\Application\spdl\MyTwist.spdl

XSI will look for the script here:

C:\users\simonin\Softimage\XSI_Mallorca_beta5\Data\Scripts\MyTwist.js.

The script would be referenced like this in the SPDL file.

Plugin = Scripted
{
       Language = "JScript";
       FileName = "MyTwist";
}

Note that the _Update callback in the script must use the script name as a prefix. For example:

sub MyTwist_Update(In_UpdateContext, Out, InGeom, InGPosY )

Update

The Update script is executed when the operator needs to recompute a port.

Helpers

The optional Helpers script is code (typically helper functions) that can be called from the Update script code.

Compiled Operator

Plugin = Library
{
   Filename = "library_filename";

   EntryPoints
   {
       Update = "update_entry_point";
   }
}

For more information about the Plugin section of a SPDL file, see Preset-based Operators under Deprecated Features.

 <     >