Difference between revisions of "Silhouette Module Reference"

From Silhouette Wiki
Jump to navigation Jump to search
Line 9: Line 9:
 
! scope="col" class="unsortable" | Description
 
! scope="col" class="unsortable" | Description
 
|-
 
|-
|<tt>addAction(action)</tt>||Adds a new [[Action]] subclass to the Action system
+
|<tt>action(name)||Returns the [[Action]] with the given name
 +
|-
 +
|<tt>activeLayer()||Return the active [[Layer]], or None
 +
|-
 +
|<tt>activeNode()||Return the active [[Node]], or None
 +
|-
 +
|<tt>activeProject()||Return the active [[Project]], or None
 
|-
 
|-
|<tt>action(name)||Returns the [[Action]] with the given name
+
|<tt>activeSession()||Return the active [[Session]], or None
 +
|-
 +
|<tt>addAction(action)</tt>||Add a new [[Action]] to the action list
 
|}
 
|}
  
Line 23: Line 31:
 
|[[Action]]||Base class for Actions
 
|[[Action]]||Base class for Actions
 
|-
 
|-
|Object||Base class for all objects
+
|[[Object]]||Base class for all objects
 
|}
 
|}

Revision as of 23:23, 17 November 2012

The fx Module

All of Silhouette's built-in functions are defined in the fx module. The easiest way to make use of the module is to use the Python statement from fx import *.

Global Functions

Name Description
action(name) Returns the Action with the given name
activeLayer() Return the active Layer, or None
activeNode() Return the active Node, or None
activeProject() Return the active Project, or None
activeSession() Return the active Session, or None
addAction(action) Add a new Action to the action list

Global Constants

fx Objects

Name Description
Action Base class for Actions
Object Base class for all objects