Special characters

Meaning in macro

(Space)

A space character in macros acts like pressing Enter.

When scripting a name (or a text string) that contains spaces, you need to enclose it in double-quotes to avoid breaking the command sequence.

For example:

_-SelName "Table 01" ✔

_-SelName Table 01 ✘

*
(asterisk)

Causes the command to repeat automatically without pressing Enter to restart.

!
(exclamation point)

Cancels the previous command.

An exclamation point (!) and a space in the beginning of a macro cancels any previous command. At other locations, it cancels the macro. If necessary, the exclamation point can be used at the end of the macro.

-
(hyphen / dash)

Suppresses dialog box.

Basically, all commands can be made into macros at the command line (even commands that have dialog boxes by default). To suppress the dialog box and use command-line options, prefix the command name with a hyphen (-). A few commands (e.g., DevLoft) have options only available at the command-line.

_
(underscore)

Runs commands and options in English.

Rhino is localized in several languages. Commands and options are translated differently in different languages. To make macros work worldwide, we suggest writing macros in English with an underscore in front of every command and option.

For example:

Cerchio 3Punti 0,0,0 1,1,0 0,3,0 ❗

This macro only works in the Italian version of Rhino.

_Circle _3Point 0,0,0 1,1,0 0,3,0 ✔

This macro works in all language versions of Rhino.

'
(apostrophe)

The next command is a nestable command.

View and construction plane manipulation and object snaps are nestable. Geometry creation commands are not nestable.

One-shot object snaps and sub-object picking filters are automatically nestable and do not require an apostrophe.

\
(backslash)

If the last character in a toolbar button macro is "\", the macro runs without proceeding Enter at the end.

For example:

Create a toolbar button with a macro "5\". Clicking the button enters 5 to the command line and stops there for further input. This feature can be used to create a toolbar that works like an on-screen numeric keypad.

~
(tilde)

Suppresses command options for clutter free command feedback. The options still work as usual.

;

Comment.

Lines beginning with a semicolon (;) are not part of the macro, but let you document the macro or try alternative input.

For example:

; This is a test macro
_Circle 0,0,0 15
_Line 0,0,0 pause ;15,0,0
; Line 0,0,0 0,15,0
_Line 0,0,0 -15,0,0

Layer nesting is indicated by a double colon - "::" between layer names. In the -Layer command, add a new layer nested under Layer 01 using a macro like this:

! _-Layer New "Layer 01:: New Layer" Enter

Enables history recording for the following command.

For example: #ArcBlend

Disables history recording for the following command.

For example: %ArcBlend

! _SelAll

Cancels all previous commands and selects all the objects currently in the model.

_Points

Runs the Points command.

_Pause

_Pause

_Pause

Allows picking three point locations.

_Enter

Simulates pressing Enter, which stops the creation of point objects.

_Invert

Inverts the selection. All visible objects in the scene were selected at the beginning of the script, so after Invert only the newly created point objects are selected.

_CurveThroughPt

Creates a polyline through the point objects.

_EnterEnd

Completes the command.

Pause

Stops for user input in a macro.

Example:

! _Circle _Pause 50

This macro asks for a point and then draws a circle with a 50 unit radius centered there.

MultiPause

Stops a script for the duration of multiple selections, for example in Join, Polyline, and FilletEdge.

Enter

Simulates pressing Enter inside a macro.

This command does not repeat the previous command like pressing Enter does.

EnterEnd

Completes the command.

SetRedrawOff

Prevents screen redraw, construction plane or camera changes during macros.

SetRedrawOn

Turns screen redraw back on after SetRedrawOff.

NoEcho

Turns off echoing of macro commands to the command history window.

Echo

Turns on echoing of macro commands to the command history window.