Trees       Indices       Help   
SUE - Revision 232
Package AccessEngine :: Package AccessEngineAPI :: Module System
[hide private]
[frames] | no frames]

Module System

source code

Defines AccessEngineAPI for manging AETiers and AEScripts.

Authors:
Peter Parente, Scott Haeger, Frank Zenker, Ramona Bunk
Organizations: Copyright:

License: The BSD License All rights reserved. This program and the accompanying materials are made available under the terms of the BSD license which accompanies this distribution, and is available at http://www.opensource.org/licenses/bsd-license.php

Functions [hide private]
string
getProfileName()
Gets the name of the profile SUE is running under.		 source code
 
pushScript(tier, *names)
Adds one or more AEScripts to the top of the script stack in the tier.		 source code
 
insertScript(tier, index, script_name)
Adds one AEScript to the stack at the insertion index.		 source code
 
popScript(tier, *indices)
Removes one or more AEScripts from the stack given their indices.		 source code
 
reloadScripts(tier)
Reloads all AEScripts in the current AETier.		 source code
list of string
_getUIEInstances(kind, which, tier=None)
Internal method for getting instances of all installed or associated AEUserInterfaces for the given kind.		 source code
list of string
_getClassNames(kind, which, tier=None)
Internal method for getting class names of all installed or associated AEUserInterfaces for the given kind.		 source code
list of string
_getNames(kind, which, tier=None)
Internal method for getting names of all installed or associated AEUserInterfaces for the given kind.		 source code
list of string
_getDescriptions(kind, which, tier=None)
Internal method for getting descriptions of all installed or associated AEUserInterfaces for the given kind.		 source code
list of 3-tuple of string
getScriptMetadata(tier, which=AEConstants.UIE_LOADED)
Gets metadata for all AEScripts in the AETier, all installed Scripts, Scripts associated with the AETier, or all Scripts associated with this profile depending on the which flag.		 source code
list of 3-tuple of string
getDeviceMetadata(which=AEConstants.UIE_LOADED)
Gets metadata for all AEOutput and AEInput devices currently loaded in, installed in, or associated with the active profile depending on the which flag.		 source code
list of 3-tuple of string
getMonitorMetadata(which=AEConstants.UIE_LOADED)
Gets metadata for all AEMonitors currently loaded in, installed in, or associated with the active profile depending on the which flag.		 source code
list of 3-tuple of string
getChooserMetadata(which=AEConstants.UIE_ALL_ASSOCIATED)
Gets metadata for all AEChoosers installed in or associated with the active profile depending on the which flag.		 source code
list of string
getDeviceClassNames(which=AEConstants.UIE_LOADED)
Gets the programmatic class names of all AEOutput and AEInput devices currently loaded in, installed in, or associated with the active profile depending on the which flag.		 source code
list of string
getDeviceNames(which=AEConstants.UIE_LOADED)
Gets the human readable names of all AEOutput and AEInput devices currently loaded in, installed in, or associated with the active profile depending on the which flag.		 source code
list of string
getDeviceDescriptions(which=AEConstants.UIE_LOADED)
Gets the descriptions of all AEOutput and AEInput devices currently loaded in, installed in, or associated with the active profile depending on the which flag.		 source code
list of string
getMonitorClassNames(which=AEConstants.UIE_LOADED)
Gets the programmatic class names of all AEMonitors currently loaded in, installed in, or associated with the active profile depending on the which flag.		 source code
list of string
getMonitorNames(which=AEConstants.UIE_LOADED)
Gets the human readable names of all AEMonitors currently loaded in, installed in, or associated with the active profile depending on the which flag.		 source code
list of string
getMonitorDescriptions(which=AEConstants.UIE_LOADED)
Gets the human readable descriptions of all AEMonitors currently loaded in, installed in, or associated with the active profile depending on the which flag.		 source code
list of string
getChooserClassNames(which=AEConstants.UIE_ALL_ASSOCIATED)
Gets the programmatic class names of all AEChoosers installed in or associated with the active profile depending on the which flag.		 source code
list of string
getChooserNames(which=AEConstants.UIE_ALL_ASSOCIATED)
Gets the human readable names of all AEChoosers installed in or associated with the active profile depending on the which flag.		 source code
list of string
getChooserDescriptions(which=AEConstants.UIE_ALL_ASSOCIATED)
Gets the descriptions of all AEChoosers installed in or associated with the active profile depending on the which flag.		 source code
list of string
getScriptClassNames(tier, which=AEConstants.UIE_LOADED)
Gets the programmatic class names of all AEScripts in this AETier, all installed Scripts, Scripts associated with this AETier, or all Scripts associated with this profile depending on the which flag.		 source code
list of string
getScriptNames(tier, which=AEConstants.UIE_LOADED)
Gets the human readable names of all AEScripts in this AETier, all installed Scripts, Scripts associated with this AETier, or all Scripts associated with this profile depending on the which flag.		 source code
list of string
getScriptDescriptions(tier, which=AEConstants.UIE_LOADED)
Gets the human readable descriptions of all AEScripts in this AETier, all installed Scripts, Scripts associated with this AETier, or all Scripts associated with this profile depending on the which flag.		 source code
list of tuples ('Task Identity', script.getClassName())
getAETierNamedTasks(tier, name)
Gets the Tasks with the given name if they are registered anywhere in the AETier.		 source code
list of tuples ('Task Identity', script.getClassName())
getAETierEventTasks(event_type, task_layer, tier)
Gets all registered Tasks, which are registered to handle the given AEEvent type on the given layer from the AETier.		 source code
tuple ('Task Identity', script.getClassName())
getScriptNamedTask(script, task_name, task_script_name=None)
Checks whether the task with the given name is registered in the AEScript.		 source code
tuple (exec_function, update_function)
getScriptNamedTaskFunctions(script, task_name, task_script_name=None)
Gets the Task functions with the given name if it is registered in this AEScript only.		 source code
list of tuple ('Task Identity', script.getClassName())
getScriptEventTasks(event_type, task_layer, script)
Get all registered Tasks registered to handle the given AEEvent type in the AEScript.		 source code
AEState
getDeviceState(device_name)
Gets the default AEState associated with an AEOutput or AEInput device currently loaded in the AEDeviceManager.		 source code
AEState
getScriptState(tier, script_name, reload=True)
Gets the AEState associated with a AEScript.		 source code
boolean
loadAllMonitors()
Loads and shows all AEMonitors associated with this profile.		 source code
boolean
unloadAllMonitors()
Hides and unloads all AEMonitors associated with this profile.		 source code
 
loadMonitor(name)
Loads and shows one AEMonitor.		 source code
 
unloadMonitor(name)
Hides and unloads one AEMonitor.		 source code
AEChooser
loadChooser(script, name, **kwargs)
Loads an AEChooser dialog with the given name from disk.		 source code
 
unloadChooser(script, chooser)
Unloads the given AEChooser dialog.		 source code
 
blockNTasks(n, task_type, condition=lambda**x: True)
Blocks tasks of the given type from executing in response to the next n events.		 source code
 
associateScript(name, tier=None, all_tiers=False, index=None)
Associates a AEScript with the active profile.		 source code
 
disassociateScript(name, tier=None, all_tiers=False)
Disassociates a AEScript from the active profile.		 source code
 
associateMonitor(name)
Associates a AEMonitor with the active profile.		 source code
 
disassociateMonitor(name)
Associates a AEMonitor with the active profile.		 source code
 
associateDevice(name, index=None)
Associates a AEOutput or AEInput device with the active profile.		 source code
 
disassociateDevice(name)
Disassociates a AEOutput or AEInput device from the active profile.		 source code
 
refreshDevices()
Unloads all existing devices then immediately loads all devices associated with the active profile.		 source code
 
registerConstants(scope, *names)
Adds new constants to AccessEngine.AEConstants.API such that they are visible to other AEScripts.		 source code
AEScript
getScriptByName(tier, name)
Gets the AEScript with the given name from the AETier.		 source code
object
getScriptVar(tier, script_name, var_name)
Gets the AEScript instance variable with the given name.		 source code
object
setScriptVar(tier, script_name, var_name, value)
Sets the AEScript instance variable with the given name to value.		 source code
object
getScriptSetting(tier, script_name, setting_name)
Gets the AEScript Setting state variable with the given name.		 source code
object
getScriptSettingVal(tier, script_name, setting_name)
Gets the value of the AEScript Setting state variable with the given name.		 source code
 
setScriptSettingVal(tier, script_name, setting_name, value)
Sets the value of the AEScript Setting state variable with the given name.		 source code
Function Details [hide private]

getProfileName()

source code 
Gets the name of the profile SUE is running under.
Returns: string
Profile name

pushScript(tier, *names)

source code 

Adds one or more AEScripts to the top of the script stack in the tier.

If more than one AEScript is specified, the last specified AEScript will be at the top of the stack when this method completes. That is, the behavior of pushing more than one AEScript at a time is the same as if each AEScript were pushed individually.
Parameters:
  • tier (AETier) - The tier to which the scripts should be added.
  • names (list of string) - Names of AEScripts to add

insertScript(tier, index, script_name)

source code 
Adds one AEScript to the stack at the insertion index. Negative indices are valid per Python list convention.
Parameters:
  • tier (AETier) - tier to which the script should be added
  • index (integer) - Index at which the AEScript should be inserted into the stack where zero is the bottom
  • script_name (string) - Name of the Script to add

popScript(tier, *indices)

source code 
Removes one or more AEScripts from the stack given their indices.
Parameters:
  • tier (AETier) - AETier from which the scripts should be removed
  • indices (list of integer) - Indices of AEScripts to remove
Raises:
  • IndexError - When the stack is empty
  • ValueError - When specified AEScript is not found

reloadScripts(tier)

source code 
Reloads all AEScripts in the current AETier. Any changes made to the AEScript logic will take effect immediately after the reload. This method does not refer to the AEScripts associated with the current profile. It simply reloads all currently loaded AEScripts.
Parameters:
  • tier (AETier) - The scripts will be reloaded for this tier.

_getUIEInstances(kind, which, tier=None)

source code 
Internal method for getting instances of all installed or associated AEUserInterfaces for the given kind.
Parameters:
Returns: list of string
All descriptions
Notes:
  • Installed UIEs that are not importable because of missing dependencies or other errors are not included in the list.
  • Getting loaded chooser names is not currently supported.

_getClassNames(kind, which, tier=None)

source code 
Internal method for getting class names of all installed or associated AEUserInterfaces for the given kind.
Parameters:
Returns: list of string
All descriptions

Note: Installed UIEs that are not importable because of missing dependencies are not listed as installed to maintain parity with _getNames and _getDescriptions.

_getNames(kind, which, tier=None)

source code 
Internal method for getting names of all installed or associated AEUserInterfaces for the given kind.
Parameters:
Returns: list of string
All descriptions

_getDescriptions(kind, which, tier=None)

source code 
Internal method for getting descriptions of all installed or associated AEUserInterfaces for the given kind.
Parameters:
Returns: list of string
All descriptions

getScriptMetadata(tier, which=AEConstants.UIE_LOADED)

source code 

Gets metadata for all AEScripts in the AETier, all installed Scripts, Scripts associated with the AETier, or all Scripts associated with this profile depending on the which flag. Includes Script class names, human readable names, and descriptions.

The default value is used if which is invalid.
Parameters:
Returns: list of 3-tuple of string
Class names, names, descriptions

getDeviceMetadata(which=AEConstants.UIE_LOADED)

source code 

Gets metadata for all AEOutput and AEInput devices currently loaded in, installed in, or associated with the active profile depending on the which flag.

The default value is used if which is invalid.
Parameters:
Returns: list of 3-tuple of string
Class names, names, descriptions

getMonitorMetadata(which=AEConstants.UIE_LOADED)

source code 

Gets metadata for all AEMonitors currently loaded in, installed in, or associated with the active profile depending on the which flag.

The default value is used if which is invalid.
Parameters:
Returns: list of 3-tuple of string
Class names, names, descriptions

getChooserMetadata(which=AEConstants.UIE_ALL_ASSOCIATED)

source code 

Gets metadata for all AEChoosers installed in or associated with the active profile depending on the which flag.

The default value is used if which is invalid.
Parameters:
Returns: list of 3-tuple of string
Class names, names, descriptions

Note: Getting loaded chooser names is not currently supported.

getDeviceClassNames(which=AEConstants.UIE_LOADED)

source code 

Gets the programmatic class names of all AEOutput and AEInput devices currently loaded in, installed in, or associated with the active profile depending on the which flag.

The default value is used if which is invalid.
Parameters:
Returns: list of string
Names of all AEOutput and AEInput classes

getDeviceNames(which=AEConstants.UIE_LOADED)

source code 

Gets the human readable names of all AEOutput and AEInput devices currently loaded in, installed in, or associated with the active profile depending on the which flag.

The default value is used if which is invalid.
Parameters:
Returns: list of string
Names of all AEOutput and AEInput devices

getDeviceDescriptions(which=AEConstants.UIE_LOADED)

source code 

Gets the descriptions of all AEOutput and AEInput devices currently loaded in, installed in, or associated with the active profile depending on the which flag.

The default value is used if which is invalid.
Parameters:
Returns: list of string
Names of all AEOutput and AEInput devices

getMonitorClassNames(which=AEConstants.UIE_LOADED)

source code 

Gets the programmatic class names of all AEMonitors currently loaded in, installed in, or associated with the active profile depending on the which flag.

The default value is used if which is invalid.
Parameters:
Returns: list of string
Names of all AEMonitor classes

getMonitorNames(which=AEConstants.UIE_LOADED)

source code 

Gets the human readable names of all AEMonitors currently loaded in, installed in, or associated with the active profile depending on the which flag.

The default value is used if which is invalid.
Parameters:
Returns: list of string
Names of all AEMonitors

getMonitorDescriptions(which=AEConstants.UIE_LOADED)

source code 

Gets the human readable descriptions of all AEMonitors currently loaded in, installed in, or associated with the active profile depending on the which flag.

The default value is used if which is invalid.
Parameters:
Returns: list of string
Descriptions of all AEMonitors

getChooserClassNames(which=AEConstants.UIE_ALL_ASSOCIATED)

source code 

Gets the programmatic class names of all AEChoosers installed in or associated with the active profile depending on the which flag.

The default value is used if which is invalid.
Parameters:
Returns: list of string
Names of all AEChooser classes

Note: Getting loaded chooser names is not currently supported.

getChooserNames(which=AEConstants.UIE_ALL_ASSOCIATED)

source code 

Gets the human readable names of all AEChoosers installed in or associated with the active profile depending on the which flag.

The default value is used if which is invalid.
Parameters:
Returns: list of string
Names of all AEChoosers

Note: Getting loaded chooser names is not currently supported.

getChooserDescriptions(which=AEConstants.UIE_ALL_ASSOCIATED)

source code 

Gets the descriptions of all AEChoosers installed in or associated with the active profile depending on the which flag.

The default value is used if which is invalid.
Parameters:
Returns: list of string
Descriptions of all AEChoosers

Note: Getting loaded chooser names is not currently supported.

getScriptClassNames(tier, which=AEConstants.UIE_LOADED)

source code 

Gets the programmatic class names of all AEScripts in this AETier, all installed Scripts, Scripts associated with this AETier, or all Scripts associated with this profile depending on the which flag.

The default value is used if which is invalid.
Parameters:
Returns: list of string
Names of all AEScript classes

getScriptNames(tier, which=AEConstants.UIE_LOADED)

source code 

Gets the human readable names of all AEScripts in this AETier, all installed Scripts, Scripts associated with this AETier, or all Scripts associated with this profile depending on the which flag.

The default value is used if which is invalid.
Parameters:
Returns: list of string
Names of all AEScripts

getScriptDescriptions(tier, which=AEConstants.UIE_LOADED)

source code 

Gets the human readable descriptions of all AEScripts in this AETier, all installed Scripts, Scripts associated with this AETier, or all Scripts associated with this profile depending on the which flag.

The default value is used if which is invalid.
Parameters:
Returns: list of string
Descriptions of all AEScripts

getAETierNamedTasks(tier, name)

source code 
Gets the Tasks with the given name if they are registered anywhere in the AETier. If no Task is registered under the given name, returns None.
Parameters:
  • tier (AETier) - The tier, in which to look for the tasks.
  • name (string) - Name of the Tasks to locate
Returns: list of tuples ('Task Identity', script.getClassName())
A list with the found task keys or None.

getAETierEventTasks(event_type, task_layer, tier)

source code 

Gets all registered Tasks, which are registered to handle the given AEEvent type on the given layer from the AETier.

Calls AETier.getEventTasks to search across all AEScripts in the owning AETier.
Parameters:
  • event_type (AEEvent class) - Desired type of AEEvent
  • task_layer (integer) - Layer on which the desired Tasks are registered
Returns: list of tuples ('Task Identity', script.getClassName())
A list of Tasks that handle the given event type and on the given layer in the AETier which owns this AEScript.

getScriptNamedTask(script, task_name, task_script_name=None)

source code 
Checks whether the task with the given name is registered in the AEScript. If no Task is registered under the given name in the AEScript, returns None.
Parameters:
  • script (AEScript) - The script in which the task should be registered.
  • task_name (string) - Name of the Task to locate
  • task_script_name (string) - The name of the script in which the task is implemented in. If this parameter is None, it will be assumed the task is implemented in script.
Returns: tuple ('Task Identity', script.getClassName())
A tuple with the task key information or None

See Also: getAETierNamedTasks

getScriptNamedTaskFunctions(script, task_name, task_script_name=None)

source code 
Gets the Task functions with the given name if it is registered in this AEScript only. If no Task is registered under the given name in this AEScript, returns None.
Parameters:
  • script (AEScript) - The script in which the task should be registered.
  • task_name (string) - Name of the Task to locate
  • task_script_name (string) - The name of the script in which the task is implemented in. If this parameter is None, it will be assumed the task is implemented in script.
Returns: tuple (exec_function, update_function)
tuple with the execute and update function of the task with the given name or None

See Also: getAETierNamedTasks

getScriptEventTasks(event_type, task_layer, script)

source code 
Get all registered Tasks registered to handle the given AEEvent type in the AEScript.
Parameters:
  • event_type (AEEvent class) - Desired type of AEEvent
  • task_layer (integer) - Layer on which the desired Tasks are registered
  • script (AEScript) - the script in which to look for the tasks
Returns: list of tuple ('Task Identity', script.getClassName())
List of the keys to all tasks that handle the given event type on the given layer in the AEScript

See Also: getAETierEventTasks

getDeviceState(device_name)

source code 
Gets the default AEState associated with an AEOutput or AEInput device currently loaded in the AEDeviceManager.
Parameters:
  • device_name (string) - Name of the device
Returns: AEState
Loaded state for the device

getScriptState(tier, script_name, reload=True)

source code 
Gets the AEState associated with a AEScript. If the state was previously persisted to disk, it is loaded from disk. If not, a new state object is created for the named Script and immediately persisted in the user's profile.
Parameters:
  • tier (AETier) - The tier that contains the script.
  • script_name (string) - Name of the AEScript
Returns: AEState
Loaded state for the AEScript

loadAllMonitors()

source code 
Loads and shows all AEMonitors associated with this profile.
Returns: boolean
Was at least one monitor loaded?

unloadAllMonitors()

source code 
Hides and unloads all AEMonitors associated with this profile.
Returns: boolean
Was at least one monitor unloaded?

loadMonitor(name)

source code 
Loads and shows one AEMonitor.
Parameters:
  • name (string) - Class name of the AEMonitor

unloadMonitor(name)

source code 
Hides and unloads one AEMonitor.
Parameters:
  • name (string) - Class name of the AEMonitor

loadChooser(script, name, **kwargs)

source code 
Loads an AEChooser dialog with the given name from disk. Passes the keyword arguments to the init method of the chooser. This method should typically only be invoked by a AEScript.EventScript subclass, which implements one or more of the following methods: EventScript.onChooserStart, EventScript.onChooserSignal, EventScript.onChooserEnd.
Parameters:
  • script (AEScript.EventScript) - the script which invokes this method.
  • name (string) - UIE name of the chooser
  • kwargs (dictionary) - Keyword arguments to initialize the chooser
Returns: AEChooser
Reference to the chooser if it was created. If it already existed, None is returned instead.

unloadChooser(script, chooser)

source code 
Unloads the given AEChooser dialog. This method should typically only be invoked by a by a AEScript.EventScript subclass, which implements one or more of the following methods: EventScript.onChooserStart, EventScript.onChooserSignal, EventScript.onChooserEnd.
Parameters:

blockNTasks(n, task_type, condition=lambda**x: True)

source code 
Blocks tasks of the given type from executing in response to the next n events. This is a convenience shortcut to avoid registering one-shot tasks in AEScripts to do exactly the same thing.
Parameters:
  • n (integer) - Number of events to block
  • task_type (task class) - Kind of task to block
  • condition (callable) - Condition statement to check if the event is actually one to be consumed. The callable is called with the keyword arguments passed to the task execute method.

associateScript(name, tier=None, all_tiers=False, index=None)

source code 
Associates a AEScript with the active profile.
Parameters:
  • name (string) - Name of the UIE to associate
  • tier (string) - Name of the AETier with which the AEScript will be associated.
  • all_tiers (boolean) - Should the AEScript be loaded on every AETier? Defaults to the value specified by the Script itself.
  • index (integer) - Load order index of the AEScript. Lower means sooner to load but also later to handle events (i.e. bottom of the Script stack).

disassociateScript(name, tier=None, all_tiers=False)

source code 
Disassociates a AEScript from the active profile.
Parameters:
  • name (string) - Name of the UIE to disassociate
  • tier (string) - Name of the AETier from which the AEScript will be disassociated. Defaults to the name of the AETier specified by the Script itself.
  • all_tiers (boolean) - Should the AEScript be removed from the list of Scripts to load for every AETier? Defaults to the value specified by the Script itself.

associateMonitor(name)

source code 
Associates a AEMonitor with the active profile. Loads it immediately.
Parameters:
  • name (string) - Name of the UIE to associate

disassociateMonitor(name)

source code 
Associates a AEMonitor with the active profile. Unloads it immediately.
Parameters:
  • name (string) - Name of the UIE to associate

associateDevice(name, index=None)

source code 
Associates a AEOutput or AEInput device with the active profile. Does not load it immediately. See refreshDevices for that functionality.
Parameters:
  • name (string) - Name of the UIE to associate
  • index (integer) - Load order index of the device where lower means sooner, None means last.

disassociateDevice(name)

source code 
Disassociates a AEOutput or AEInput device from the active profile. Does not unload it immediately. See refreshDevices for that functionality.
Parameters:
  • name (string) - Name of the UIE to associate

registerConstants(scope, *names)

source code 
Adds new constants to AccessEngine.AEConstants.API such that they are visible to other AEScripts. If any of the named constants do not exist, an exception will be raised. If any of the named constants are already registered, they will be silently ignored by AEConstants.register method.
Parameters:
  • scope (dictionary) - Scope in which the constants are defined (e.g. globals())
  • names (list of string) - Names of constants to register
Raises:
  • KeyError - When one of the named constants does not exist in the scope

getScriptByName(tier, name)

source code 

Gets the AEScript with the given name from the AETier.

If no script is registered under the given name, KeyError is raised.
Parameters:
  • tier (AETier) - The tier in which the script may be registered.
  • name (string) - Name of the script
Returns: AEScript
Script with the given name
Raises:
  • KeyError - When the script with the given name is not found

getScriptVar(tier, script_name, var_name)

source code 

Gets the AEScript instance variable with the given name.

If no script is registered under the given name a KeyError is raised, if the script does not contain var_name an AttributeError is raised.
Parameters:
  • tier (AETier) - The tier in which the script may be registered.
  • script_name (immutable) - Name of the script
  • var_name (immutable) - Name of the instance variable
Returns: object
script variable with the given name
Raises:
  • KeyError - When the script or variable with it's given name is not found
  • AttributeError - When the attribute is not found

setScriptVar(tier, script_name, var_name, value)

source code 

Sets the AEScript instance variable with the given name to value.

If no script is registered under the given name a KeyError is raised, if the script does not contain var_name an AttributeError is raised.
Parameters:
  • tier (AETier) - The tier in which the script may be registered.
  • script_name (immutable) - Name of the script
  • var_name (immutable) - Name of the instance variable
  • value (immutable) - value to set instance variable
Returns: object
script variable with the given name
Raises:
  • KeyError - When the script or variable with it's given name
  • AttributeError - When attribute is not found

getScriptSetting(tier, script_name, setting_name)

source code 

Gets the AEScript Setting state variable with the given name.

This method should be used when a script needs to access the settings of another script. If a script wants to access its own settings use the AEScript.getScriptSetting method.

If no script is registered under the given name or setting_name is not found, KeyError is raised.
Parameters:
  • tier (AETier) - The tier in which the script may be registered.
  • script_name (immutable) - Name of the script
  • setting_name (immutable) - Name of the script
Returns: object
Setting object for given script.
Raises:
  • KeyError - When the script is not found

getScriptSettingVal(tier, script_name, setting_name)

source code 

Gets the value of the AEScript Setting state variable with the given name.

This method should be used when a script needs to access the settings of another script. If a script wants to access its own settings use the AEScript.getScriptSettingVal method.

If no script is registered under the given name or if setting_name is not found, KeyError is raised.
Parameters:
  • tier (AETier) - The tier in which the script may be registered.
  • script_name (immutable) - Name of the script
  • setting_name (immutable) - Name of the script
Returns: object
value contained in AEState attribute with given name
Raises:
  • KeyError - When the script is not found

setScriptSettingVal(tier, script_name, setting_name, value)

source code 

Sets the value of the AEScript Setting state variable with the given name.

This method should be used when a script needs to set the settings of another script. If a script wants to set its own settings use the AEScript.setScriptSettingVal method.

If no script is registered under the given name or if setting_name is not found, KeyError is raised.
Parameters:
  • tier (AETier) - The tier in which the script may be registered.
  • script_name (immutable) - Name of the script
  • setting_name (immutable) - Name of the script
  • value (object) - value contained in AEState attribute with given name
Raises:
  • KeyError - When the AEScript is not found

   Trees       Indices       Help   
SUE - Revision 232
Generated by Epydoc 3.0beta1 on Mon Jun 30 13:05:49 2008 http://epydoc.sourceforge.net