SDKPluginBase interface

Addon SDK v1 retirement

The SDKPluginBase interface is used as the base class for your plugin in the runtime.

SDKPluginBase cannot be directly constructed; it should only be used as a base class.

Note plugins that create a DOM element should derive from SDKDOMPluginBase instead.

Properties

this._runtime

Reference to the associated Runtime that controls execution of the project.

Methods

GetRuntime()

Returns this._runtime publicly.

OnCreate()

Optional override called by the runtime when the plugin is created. This is done early on in the loading process.

IsSingleGlobal()

Return a boolean indicating if the plugin specified it was single-global.

IsWorldType()

Return a boolean indicating if the plugin specified it was the "world" type.

IsRotatable()

Return a boolean indicating if the plugin specified it was rotatable.

MustPreDraw()

Return a boolean indicating if the plugin specified it must pre-draw when compositing effects.

HasEffects()

Return a boolean indicating if the plugin specified it could have effects added to its instances.