Description
Reload is called when the plug-in is reloaded into the cache.
A plug-in is unloaded from the cache when a user right-clicks a plug-in in the plug-in tree and clears the Cached check. This unloads the plug-in (the .dll/.so file, or the script file) from memory, but does not "unload" the plug-in from Softimage. The Plugin and PluginItem objects still exist in Softimage, and the plug-in is still registered.
When a plug-in is not cached, it is loaded and unloaded every time a plug-in item (such as a command) is invoked. This triggers the Reload and Unload callbacks.
Applies To
All plug-in items except Custom Properties.
Syntax
// C#
public class <plugin-item_name>
{
public bool Reload( Context in_ctxt )
{
...
}
}
// C++ CStatus <plugin-item_name>_Reload( CRef& in_context ) { ... } // JScript function <plugin-item_name>_Reload( in_context ) { ... } # Python def <plugin-item_name>_Reload( in_context ): ... ' VBScript Function <plugin-item_name>_Reload( in_context ) ... End Function # PerlScript sub <plugin-item_name>_Reload { my $in_context = shift; }
<plugin-item_name> is the name used to register the plug-in item in XSILoadPlugin, with any spaces removed.
Parameters
|
Parameter |
Language |
Type |
Description |
|
in_context |
Scripting and C# |
Context.Source returns the plug-in item. Each event has different context attributes. |
|
|
C++ |
CRef & |
A reference to the Context object. |
See Also
• Unload
Autodesk Softimage v7.5