Be sure to update the identifiers to describe your own plugin, in both the SDK namespace and the class
name.
Updating in type.js and instance.js
Likewise in both type.js and instance.js, you must update the following:
PLUGIN_CLASS
to refer to your plugin's name
- The
class
name suffixed with Type
or Instance
. (For example the Audio plugin uses AudioPlugin
, AudioType
and AudioInstance
as the three names.)
The plugin constructor
The main function of plugin.js is to define a class representing your plugin. In the class constructor, the configuration for the plugin is set via the this._info
member, which is an IPluginInfo interface. The constructor also reads potentially translated strings from the language subsystem.
For more information about the possible plugin configurations, see the IPluginInfo
reference.
Specifying plugin properties
The plugin properties appear in the Properties Bar when instances of the plugin are selected. To set which properties appear, pass an array of PluginProperty to this._info.SetProperties
. An example is shown below. For more details see the PluginProperty
reference.
this._info.SetProperties([
new SDK.PluginProperty("integer", "test-property", 0)
]);