Luxology modo Scripting & Commands Copyright ©2001-2012 Luxology, LLC. All Rights Reserved. Patents Pending. Scripting and Commands!modo!Luxology, LLC IMPORTANT NOTE: THIS DOCUMENT IS NOW OBSOLETE As of modo 601, the Scripting and Commands document should be considered obsolete, and may be incomplete. It is now superseded by the Luxology SDK Wiki. The wiki contains all of the information present here, and provides more up-to-date information, user-edited and submitted articles, and the latest corrections, and includes both scripting language and C++ SDK documentation, as well as information about kits, config files and other developer-related materials. We expect the wiki to be a much improved source of information over this document. Be sure to visit sdk.luxology.com for the up-to-date wiki. Happy Coding! -- The Luxology Team Version 4.2!Page 1 of 299 Scripting and Commands!modo!Luxology, LLC Scripting and Commands!...............................................................17 Command System!...........................................................................18 Command History Viewport!...........................................................................................18 Command Entry!.............................................................................................................................18 Undo List!.........................................................................................................................................19 History!............................................................................................................................................20 Command List!.................................................................................................................................21 Scripts!.............................................................................................................................................22 Results!............................................................................................................................................23 Filtering!...........................................................................................................................................24 Event Log Viewport!........................................................................................................25 Command Classes!........................................................................................................26 UI!....................................................................................................................................................26 Side Effect!.......................................................................................................................................26 Undoable!........................................................................................................................................26 Model!..............................................................................................................................................26 Sub-Commands and Class Inheritance!..........................................................................................27 Quiet!...............................................................................................................................................28 Undo Special, Containers and Other Flags!....................................................................................28 Command Arguments!....................................................................................................29 Required versus Optional Arguments!.............................................................................................29 Argument Datatypes!.......................................................................................................................29 Choices/TextValueHints!..................................................................................................................29 ToggleValue Arguments!..................................................................................................................30 Command Usage Marker Guide!.....................................................................................................31 Command Blocks!..........................................................................................................32 Executing Commands!.....................................................................33 Explicitly Naming Arguments!..........................................................................................................33 Implicitly Named Arguments!...........................................................................................................33 Wrapping arguments: Quotes and Curly Braces!...........................................................................33 Arguments Out of Order!..................................................................................................................34 Values with Units: Using Square Braces!.......................................................................................34 Version 4.2!Page 2 of 299 Scripting and Commands!modo!Luxology, LLC Return Codes!..................................................................................................................................34 Special Prefixes!.............................................................................................................35 Suppressing Dialogs: !!...................................................................................................................35 Suppressing All Dialogs: !!!..............................................................................................................35 Showing Dialogs: +!.........................................................................................................................36 Showing All Dialogs: ++!..................................................................................................................36 Showing Argument Dialogs: ?!........................................................................................................36 Querying Commands!......................................................................38 Using the Command History’s Results Tab!...................................................................38 Performing a Query!.......................................................................................................39 Argument Datatypes!......................................................................................................39 integer!.............................................................................................................................................39 float!.................................................................................................................................................39 boolean!...........................................................................................................................................39 percent!............................................................................................................................................39 distance!..........................................................................................................................................39 angle!...............................................................................................................................................40 axis!..................................................................................................................................................40 uvcoords!.........................................................................................................................................40 time!.................................................................................................................................................40 color!................................................................................................................................................40 light!.................................................................................................................................................40 memory!...........................................................................................................................................40 pixel!.................................................................................................................................................41 string!...............................................................................................................................................41 Datatype Examples!.........................................................................................................................41 Complex Datatypes!........................................................................................................................41 Querying and the User Interface!...................................................................................43 Toggle/Tool Buttons!........................................................................................................................43 Simple Buttons!................................................................................................................................43 Checkmarks!....................................................................................................................................44