IPlugin script interface

The IPlugin script interface represents a plugin, such as the Sprite plugin. The plugin only exists once in the project: if there are multiple Sprite objects in a project, then each object type is represented with a different IObjectClass.

IPlugin APIs

runtime

A reference back to the IRuntime interface.

isSingleGlobal

A read-only boolean indicating whether this plugin is a 'single global' type, meaning it is added to the project once and then is available globally, such as with the Mouse object.

isWorldType

A read-only boolean indicating whether this plugin is a world type, meaning it appears in layouts.

isHTMLElementType

A read-only boolean indicating whether this plugin creates a HTML element.

isRotatable

A read-only boolean indicating whether instances of the plugin may be rotated.

hasEffects

A read-only boolean indicating whether the plugin may use effects.

is3d

A read-only boolean indicating whether the plugin is 3D (i.e. has depth on the Z axis).

supportsHierarchies

A read-only boolean indicating whether instances of the plugin may be used in hierarchies.

supportsMesh

A read-only boolean indicating whether instances of the plugin may use the mesh distortion feature.