Action

All Actions must be derived from the Action base class, and should implement the available and execute methods.

Refer to the built-in Actions in the resources/scripts/actions directory for examples.

Attributes

These attributes are read-only.

Name	Description
actionType	The Action Type
extension	If the Action implements an importer or exporter, the file extension the action works with
id	The Action class name
label	The Action label that appears in the Actions menu
root	The root menu name the Action is in

Methods

Name	Description
__init__(label, menu=None, root=None, type=Action, extension=None)	Constructor - Initializes the base class. The menu can be listed separately or prefixed to the label with the '|' character. "Actions" is the default top-level menu for normal Actions, but can be overridden with the root argument.
available()	Should return True (the default) if the Action is available. The Action should examine the current state in this method and assert (with an optional error message) that conditions are good for execution.
execute(path=None)	Called to execute the Action. UI Actions should be undoable. Importer/Exporter actions are passed the path to the file to operate on.

Constants

Action Type

Name	Description
Action	A normal action that appears in the Actions menu (the default)
ShapeImporter	An Action that should appear in the Shape Import menu
ShapeExporter	An Action that should appear in the Shape Export menu
Extension	An Action that implements core functionality is bound using some other means