Class IPackageActions

Interface for package-level actions.

Hierarchy (View Summary)

IPluginComponent
- IPackageActions

Index

Constructors

Properties

Methods

exportAsZip exportPackage exportScript getTypeName isOfType isSame

Constructors

`Protected`constructor

new IPackageActions(): IPackageActions
Snap Hidden
Returns IPackageActions
Overrides IPluginComponent.constructor

Properties

`Static`interfaceId

interfaceId: InterfaceId

Methods

exportAsZip

exportAsZip(
    exportPath: Path,
    exportOptions: ExportOptions,
    includeCache: boolean,
): void
Parameters
- exportPath: Path
- exportOptions: ExportOptions
- includeCache: boolean
Returns void

exportPackage

exportPackage(
    nativePackageDescriptor: NativePackageDescriptor,
    path: Path,
    exportOptions: ExportOptions,
): void
Parameters
- nativePackageDescriptor: NativePackageDescriptor
- path: Path
- exportOptions: ExportOptions
Returns void

exportScript

exportScript(
    scriptAsset: ScriptAsset,
    path: Path,
    exportOptions: ExportOptions,
): void
Parameters
- scriptAsset: ScriptAsset
- path: Path
- exportOptions: ExportOptions
Returns void

getTypeName

getTypeName(): string
Returns the name of this object's type.

Returns string
Inherited from IPluginComponent.getTypeName

isOfType

isOfType(type: string): boolean
Returns true if the object is of the specified type.
Parameters
- type: string
Returns boolean
Inherited from IPluginComponent.isOfType

isSame

isSame(other: ScriptObject): boolean
Returns true if this object refers to the same instance as the given object.
Parameters
- other: ScriptObject
Returns boolean
Inherited from IPluginComponent.isSame