Command Messages

• BROWSER_NAVIGATE_URL - Navigate to the given URL, either using the custom UI or the system browser.

  Parameters:

  • browser - 'custom' for the Showcase custom UI and anything else for the default system browser.

  • url - A valid URL.

• CONVERT_LABELS - Calls the specified message after processing the specified fields as labels and converting them into ids.

  Valid data flags are: 1 - Alternative Set 2 - Alternative 4 - Node 8 - Slide 16 - Shot 32 - Behavior 64 - Environment 65536 - List

  For example to call SHOT_PLAY using shot labels your parameters would be as follows: ('SHOT_PLAY', ( ('Front Wheels','Back Wheels'), False ), (65552, 0) )

  Adding 16 + 65536 = 65552 implies that the parameter is a list of shots lables to be converted to ids.

  Parameters:

  • messageId - The message to call

  • messageData - A tuple containing the data for the message.

  • dataFlags - A tuple of flags identifying which messageData fields are labels, and how to convert them.

• CUSTOM_OVERLAY_SET_MODE - Control the visibility of a particular custom overlay interface, created with a add-in.

  Parameters:

  • customOverlayName - The user defined, unique name of the custom overlay interface to control.

  • visible - True to show the interface, False to hide it.

• DELAY_UNTIL_MESSAGE_BATCH - Executes the message specified as the second argument once the message specified as the first argument is processed. All of the messages registered DELAY_UNTIL_MESSAGE_BATCH are sent when the correct message arrives and no nonbatch messages are sent.

  Parameters:

  • MessageID - The message that you are waiting for.

  • messageID - The message to issue when the message you are waiting for arrives.

  • messageData - The data for the message.

• DIAGNOSTIC_MODE_CHANGED - Indicates that the diagnostic mode changed.

  Parameters:

  • mode - The diagnostic mode value. The value is 0 when not in a diagnostic mode. Any value other than 0 means a diagnostic mode is active.

• DISPLAY_INCREASE_ANTIALIAS_ON_IDLE - Toggles an option to increase the anti-aliasing quality when there is idle event.

  Parameters:

  • increaseAntiAliasOnIdle - True to increase the quality of the anti-aliasing on idle events.

• HOTKEY_ASSIGN - Internal message. Defines a hotkey. A hotkey consists of the trigger and target. The trigger defines the specific key and modifiers, while the target indicates the action to be executed when the hotkey is triggered.

  Parameters:

  • hotkeyTrigger - The key and modifiers that define the hotkey.

  • hotkeyTarget - The target action to be performed when a hotkey is triggered.

• LIGHT_CREATE - Internal message. Creates an extra light with default parameters.

  Parameters:

  • light - The name of the light to be created.

  • type - The type of the light to be created, specified by Light.kPoint, Light.kSpot, Light.kDirectional.

• MENU_INVOKE_ITEM - Calls a particular item on a particular menu. You need to use the menu and menu item IDs, rather than user visible labels. To see the exact values for different menus, use MenusAndHotkeysCustom add-in.
  For example:
• For File->New, in any language - ('File','New')
• For File->Open in any language - ('File','Open')
• For Edit->Copy Transform in any language - ('Edit','CopyTransform')

• etc.
  To see the exact values for different menus, use MenusAndHotkeysCustom add-in.

  Parameters:

  • menu - The menu in question.

  • item - The menu item in question. Even if nested, you just need the item ID, not the path., as the IDs are unique within each menu.

• SAVE_SHOT_AS_YOUTUBE_AT_RESOLUTION - Save a movie to the specified location from a specified shot. Exactly the same parameter values as with SAVE_SHOT_AS_MOVIE_AT_RESOLUTION.

• SAVE_SLIDE_AS_YOUTUBE_AT_RESOLUTION - Save a movie to the specified location from a specified storyboard slide. Exactly the same parameter values as with SAVE_SLIDE_AS_MOVIE_AT_RESOLUTION.

• SCRIPT_CANCEL - Cancels the currently running script.

• SCRIPT_ENDED - Indicates that the named script has completed.

  Parameters:

  • scriptName - The name of the script that completed.

  • wasItTest - True if this was a test run.

  • success - True if script ended successfully.

  • message - Message upon completion.

• SCRIPT_SET_QUIET_MODE -

  Parameters:

  • quiet - True to run the script silently.

• SCRIPT_SET_QUIT_MODE -

  Parameters:

  • quitOnEnd - True to terminate the application at the completion of the script.

• SCRIPT_STARTED - Indicates that the named script has started.

  Parameters:

  • scriptName - The name of the script that started executing.

  • isAtest - True if this is a test, False otherwise.

• UNDO_QUEUE_CHANGED - Indicates that an undoable action was added to the undo queue or removed from it.

  Parameters:

  • undoQueueLength - The current length of the undo queue.

  • redoQueueLength - The current length of the redo queue.