Manual Modules Loaded Module scripting commands General scripting commands Scripting

Universal Mesquite scripting commands

• tell
  • Explanation: Send the commands to follow (until endTell) to the indicated object
  • Parameters: [Object to which commands are to be sent]
• endTell
  • Explanation: End this level of the script
• exitTell
  • Explanation: Exit out of this current level of the script, jumping to 'endTell'
• toggleSuppressAllProgressIndicatorsCurrentThread
  • Explanation: Toggles suppression of all progress indicators on this thread
• showLogWindow
  • Explanation: Shows the log window
• sc
  • Explanation: Writes to log & console a list of the commands available for the currently commanded object
• ?
  • Explanation: Writes to log & console a list of the commands available for the currently commanded object
• ??
  • Explanation: Writes to log & console a list of the commands available for the currently commanded object
• stop
  • Explanation: Stop this script
• for
  • Explanation: The start of a FOR loop (end is 'endFor')
  • Parameters: [An integer or reference to an integer, indicating the number of times the loop is to be cycled]
• while
  • Explanation: The start of a WHILE loop (end is 'endWhile')
  • Parameters: [An integer or reference to an integer; loop is cycled until that integer equals zero]
• if
  • Explanation: The start of an IF block (end is 'endIf')
  • Parameters: [An integer or reference to an integer; block is entered if integer is non-zero]
• ifNot
  • Explanation: The start of an IFNOT block (end is 'endIf')
  • Parameters: [An integer or reference to an integer; block is entered if integer is zero]
• ifExists
  • Explanation: The start of an IFEXISTS block (end is 'endIf')
  • Parameters: [A reference to an object; block is entered if object is non-null]
• ifCombinable
  • Explanation: The start of an IFCOMBINABLE block (end is 'endIf')
  • Parameters: [A reference to a number object; block is entered if object is combinable]
• ifNotCombinable
  • Explanation: The start of an IFNOTCOMBINABLE block (end is 'endIf')
  • Parameters: [A reference to a number object; block is entered if object is not combinable]
• ifNotExists
  • Explanation: The start of an IFNOTEXISTS block (end is 'endIf')
  • Parameters: [A reference to an object; block is entered if object is null]
• queryString
  • Explanation: Queries the user for a String
  • Parameters: [Message to be shown to user (as a quoted token)]
• queryInteger
  • Explanation: Queries the user for an integer value
  • Parameters: [Message to be shown to user (as a quoted token)]
• queryNumber
  • Explanation: Queries the user for a numerical value
  • Parameters: [Message to be shown to user (as a quoted token)]
• queryListNumber
  • Explanation: Queries the user with a list from which an item is to be chosen; returned is the integer position in the list
  • Parameters: [reference to ListableVector object] [Message to be shown to user (as a quoted token)]
• queryList
  • Explanation: Queries the user with a list from which an item is to be chosen; returned is the object in the list
  • Parameters: [reference to ListableVector object] [Message to be shown to user (as a quoted token)]
• queryFile
  • Explanation: Queries the user to choose a file; returned is the tokenized path to the file
  • Parameters: [Message to be shown to user (as a quoted token)]
• queryFileSave
  • Explanation: Queries the user to choose a file name by which to save a file; returned is the tokenized path to the file
  • Parameters: [Message to be shown to user (as a quoted token)]
• queryYesNo
  • Explanation: Queries the user about a yes/no choice; returned is 0 (no) or 1 (yes)
  • Parameters: [Message to be shown to user (as a quoted token)] [String for No] [String for Yes]
• appendMessageToFile
  • Explanation: Appends string to a file
  • Parameters: [filename] [an object or variable that can be converted to a string]
• appendLiteralToFile
  • Explanation: Appends literal string to a file
  • Parameters: [filename] [a string or a reference to a string]
• saveMessageToFile
  • Explanation: Saves string to a file
  • Parameters: [filename] [an object or variable that can be converted to a string]
• appendReturnToFile
  • Explanation: Appends an end line character/characters to a file
  • Parameters: [filename]
• appendTabToFile
  • Explanation: Appends an tab to a file
  • Parameters: [filename]
• closeFileAfterRead
  • Explanation: Requests that file (if any) containing script being executed be closed after reading
• rememberArguments
  • Explanation: Sets the arguments for the following command
  • Parameters: [args]
• mkdir
  • Explanation: Makes a new directory
  • Parameters: [path]
• newThread
  • Explanation: For subsequent commands at this level in the script, execute on a new Thread
• writeIt
  • Explanation: Writes the current 'It' to the System console
• message
  • Explanation: Displays a message in the system console
  • Parameters: The message to be displayed (a single token; use quotes ' if needed)
• messageLiteral
  • Explanation: Displays a message in the system console
  • Parameters: The message to be displayed (a single token; use quotes ' if needed)
• alert
  • Explanation: Displays a message in an alert dialog for the user
  • Parameters: The message to be displayed (a single token; use quotes ' if needed)
• showObjectCommanded
  • Explanation: Displays a message in the system console indicating the current object being commanded
• telling
  • Explanation: Used at the start of macros, to indicate the Class to which the macro is designed to direct its commands
  • Parameters: [short (packageless) name of Class]
• debug
  • Explanation: Toggles debug mode -- in debug mode, a record of commands and results returned is written to the System console
• logonlydebug
  • Explanation: Toggles logonlydebug mode -- in logonlydebug mode, a record of commands and results returned is written to the log file
• millis
  • Explanation: Returns System.currentTimeMillis as a string
• time
  • Explanation: Toggles timing mode -- in timing mode, the time required to complete each command is written to the System console
• stampVersion
  • Explanation: Stamps the time to the log
• stampTime
  • Explanation: Stamps the time to the log
• messagesToLog
  • Explanation: Toggles whether the messages (for instance, if the debug toggle is on) are echoed into log
• sleep
  • Explanation: Sleeps
  • Parameters: [integer of how long this thread is to sleep]
• gc
  • Explanation: call the Runtime garbage collector
• paging
  • Explanation: may be defunct
• removePaging
  • Explanation: may be defunct