[Assert,True
Or False Evaluation,Message that will be shown if the first
input is false (zero)]
(ZScript debugging helper) aborts execution if specified condition
is not true
[BackColorSet,Red,Green,Blue]
Sets the pen background color
[ButtonFind,Interface
item path,Button Text,Initially Disabled? (0=Enabled(ByDefault)
NonZero=Disabled)]
Locates a ZBrush interface item
[ButtonPress,Interface
item path,Button Text,Initially Disabled? (0=Enabled(ByDefault)
NonZero=Disabled)]
Locates and presses a ZBrush interface item
[ButtonSet,Interface
item path,Value,Button Text,Initially Disabled? (0=Enabled(ByDefault)
NonZero=Disabled)]
Locates and sets a new value to a ZBrush interface item
[ButtonUnPress,Interface
item path,Button Text,Initially Disabled? (0=Enabled(ByDefault)
NonZero=Disabled)]
Locates and unpresses a ZBrush interface item
[CanvasClick,X1,Y1,X2,Y2,X3,Y3,X4,Y4,X5,Y5,X6,Y6,X7,Y7,X8,Y8]
Emulates a click within the current canvas area
[CanvasGyroHide]
Hides the Transformation Gyro
[CanvasGyroShow]
Shows the Transformation Gyro
[CanvasStroke,StrokeData,Delayed
update until end of stroke,Rotation,HScale,VScale,HOffset,VOffset]
Emulates a brush stroke within the current canvas area
[CanvasStrokes,StrokesData,Delayed
update until end of stroke,Rotation,HScale,VScale,HOffset,VOffset,HRotateCenter,VRotateCenter]
Emulates multiple brush strokes within the current canvas
area
[Caption,Text]
Displays a text line using the current Caption settings
[Delay,Delay
(in seconds)]
Delays execution of ZScript for specified amount of time
[Exit]
Aborts execution and exits the current ZScript
[FileNameAdvance,base
file name,Number of digits (0-4) (i.e. 3= 001 ),Add 'Copy'
string? (0=no, NonZero=yes)]
Output: Updated file Name
Increments the index value contained within a filename string
[FileNameGetLastTyped]
Output: Latest file name that was typed by the user. Returned
Variable will be empty if the user has canceled the action.
Retrieves the latest file name that was typed by the user
in a Save/Load action
[FileNameGetLastUsed]
Output: Latest file name that was used. Returned Variable
will be empty if the user has canceled the action.
Retrieves the latest file name that was used (by the user
or by ZBrush) in a Save/Load action
[FileNameMake,Base
file name,Index,Number of numeric digits to use]
Output: Combined file name Variable
Combines a base filename with an index number
[FileNameSetNext,File
name including the extension (such as .psd ). If omitted the
stored file name will be cleared.]
Pre-sets the file name that will be used in the next Save/Load
action
[FontSetColor,Red,Green,Blue]
Sets the color of the text-flow font
[FontSetOpacity,Opacity]
Sets the opacity of the text-flow font
[FontSetSize,Size:
1=Small 2=Med 3=Large]
Sets the intensity of the text-flow font
[FontSetSizeLarge]
Sets the size of the text-flow font to large
[FontSetSizeMedium]
Sets the size of the text-flow font to medium
[FontSetSizeSmall]
Sets the size of the text-flow font to small
[FrontColorSet,Description
Text,Red,Green,Blue,Initially Disabled? (0=Enabled(ByDefault)
NonZero=Disabled)]
Sets the main interface color to a new value
[HotKeyText,Interface
item path]
Displays a hot-key for the specified interface item
[IButton,Button
Text,Popup info Text,Commands group to execute when button
is pressed,Initially Disabled? (0=Enabled(ByDefault) NonZero=Disabled),Button
width in pixels (0=AutoWidth NonZero=Specified width),Optional
hotkey]
Creates an interactive push button
[IClick,Interface
item path,X1,Y1,X2,Y2,X3,Y3,X4,Y4,X5,Y5,X6,Y6,X7,Y7]
Emulates a click within a specified ZBrush interface item
[IColorSet,Red
(0-255),Green (0-255),Blue (0-255)]
Sets the active color to a new value
[IDisable,Window
path,Window ID or relative windowID(-100<->100)]
Disables a ZScript interface item (can only be used for ZScript-generated
interface items)
[IEnable,Window
path,Window ID or relative windowID(-100<->100)]
Enables a ZScript interface item (can only be used for ZScript-generated
interface items)
[IExists,Interface
item path]
Output: 1 if item exists,0 otherwise
Verifies that a specified interface item exists.
[If,True
Or False Evaluation,Commands group to be executed if true
(not zero),Commands group to be executed if false (is zero)]
Provides conditional execution of a commands group
[IGet,Interface
item path]
Output: The item value
Returns the current value of a ZBrush or ZScript interface
item
[IGetMax,Interface
item path]
Output: The item maximum value
Returns the maximum possible value of a ZBrush or ZScript
interface item
[IGetMin,Interface
item path]
Output: The item minimum value
Returns the minimum possible value of a ZBrush or ZScript
interface item
[IGetStatus,Interface
item path]
Output: The item status
0=Disabled
1=Enabled
Returns the Enabled/Disabled status of a ZBrush or ZScript
interface item
[IKeyPress,The
key to press with an optional CTRL/CMD, ALT/OPT, SHIFT or
TAB combination. ,Commands group to execute while the key
is pressed,Optional H cursor position prior to key press,Optional
V cursor position prior to key press]
Simulates a key press
[Image,FileName
(.psd .bmp + .pct for Mac Systems),Align (0=center 1=left
2=right),Resized Width]
Loads and displays an image
[IMaximize,Interface
item path,Maximizeall sub palettes? (0=no, NonZero=yes)]
Locates an interface item and (if possible) maximize its size.
[IMinimize,Interface
item path,Minimize all sub palettes? (0=no, NonZero=yes)]
Locates an interface item and (if possible) minimize its size.
[IModGet,Interface
item path]
Output: The item value
Returns the current modifiers binary state of a ZBrush or
ZScript interface item
[IModSet,Interface
item path,value]
Sets the modifiers binary value of a ZBrush or a ZScript interface
item
[Interpolate,Time
(0=AtStart 0.5=half 1=AtEnd) ,Value1 (Num, VarName or ListName),Value2
(Num, VarName or ListName),Value3 (Num, VarName or ListName),Value4
(Num, VarName or ListName)]
Output: Interpolated value or list
Performs time-based interpolation
[IPress,Interface
item path]
Presses a ZBrush or ZScript interface item
[IReset,Optional
item to reset (default=All). 0=All,1=Interface,2=Document,3=Tools,4=Lights,5=Materials,6=Stencil]
Output: Returns the button that the user clicked. ( 0=NO,
1=YES )
Interface Reset
[IsDisabled,Interface
item path]
Output: The item 'Disabled' status (1=Disabled 0=Enabled)
Returns 1 if the specified ZBrush or ZScript interface item
is currently disabled, returns 0 otherwise
[IsEnabled,Interface
item path]
Output: The item 'Enabled' status (1=Enabled 0=Disabled)
Returns 1 if the specified ZBrush or ZScript interface item
is currently enabled, returns 0 otherwise
[ISet,Interface
item path,value]
Sets a new value to a ZBrush or ZScript interface item
[ISetMax,Interface
item path,New max value ]
Sets the maximum value for an ISlider interface item (can
only be used for ZScript-generated interface items)
[ISetMin,Interface
item path,New min value ]
Sets the minimum value for an ISlider interface item (can
only be used for ZScript-generated interface items)
[ISetStatus,Interface
item path,New status ( 0=Disable NotZero=Enable )]
Enables or Disables a ZScript interface item (can only be
used for ZScript-generated interface items)
[IShow,Interface
item path,Show Zoom Rectangles?]
Locates an interface item and makes it visible.
[ISlider,Slider
Text,CurValue,Resolution,MinValue,MaxValue,Popup info Text,Commands
group to execute when value is changed,Initially Disabled?
(0=Enabled(ByDefault) NonZero=Disabled),Button width in pixels
(0=AutoWidth NonZero=Specified width)]
Creates an interactive slider
[IStroke,Interface
item path,StrokeData]
Emulates a brush stroke within an interface item
[ISwitch,Button
Text,Initial state (1=pressed,0=unpressed),Popup info Text,Commands
group to execute when button is pressed,Commands group to
execute when button is unpressed,Initially Disabled? (0=Enabled(ByDefault)
NonZero=Disabled),Button width in pixels (0=AutoWidth NonZero=Specified
width)]
Creates an interactive switch
[IToggle,Interface
item path]
Toggles the state of a ZBrush or ZScript interface item
[IUnPress,Interface
item path]
Unpresses a ZBrush or ZScript interface item
[Loop,RepeatCount,Commands
group]
Repeats execution of the specified commands group
[LoopContinue]
Continues execution from the beginning of the current Loop
[LoopExit]
Exits the current Loop
[MessageOK,The
Message that will be shown,The Title of the message]
Displays a user message with a single OK button
[MessageOKCancel,The
Message that will be shown,The Title of the message]
Output: Returns the button that the user clicked. (0=CANCEL,
1=OK)
Displays a user message with CANCEL and OK buttons
[MessageYesNo,The
Message that will be shown,The Title of the message]
Output: Returns the button that the user clicked. (0=NO, 1=YES)
Displays a user message with YES and NO buttons
[MessageYesNoCancel,The
Message that will be shown,The Title of the message]
Output: Returns the button that the user clicked. (0=NO, 1=YES
CANCEL=-1)
Displays a user message with YES, NO and CANCEL buttons
[MouseHPos]
Output: The H position of the mouse
Returns the current H position of the mouse in Canvas coordinates
[MouseLButton]
Output: Returns 1 if mouse button is pressed, returns zero
if unpressed
Returns the current state of the left mouse button
[MouseVPos]
Output: The V position of the mouse
Returns the current V position of the mouse in Canvas coordinates
[Note,Text
line,Optional path1 of an interface item to be pointed out.
(default=none),Display Duration (in seconds). (zero= wait
for user action, -1=combine with next note command). (default=wait
action),Popup background color. (blue + (green*256) + (red*65536)
) (default=96+(96*256)+(96*65536)= ),Prefered distance of
the note from the specified interface item (default=48),Prefered
Note width (in pixels, default=400)]
Displays a note to the user.
[PageSetWidth,Preferred
PageWidth]
Sets the width of the page
[PaintBackground,Red,Green,Blue]
Paints the background using the current background color
[PaintBackSliver,height,Red,Green,Blue]
Draws a full page-width rectangle using the current background
color
[PaintPageBreak]
Draws a visual page-break
[PaintRect,Width,height,Red,Green,Blue]
Draws a rectangle (in the ZScript window) using the current
pen color
[PaintTextRect,Width,Height,Text]
Draws a rectangle with imbedded text
[PD]
Moves the pen position to the beginning of the next line (Same
as PenMoveDown)
[PenMoveCenter]
Moves the pen position to the horizontal center of the page
[PenMoveDown]
Moves the pen position to the beginning of the next line
[PenMoveLeft]
Moves the pen position to the left side of the page
[PenMoveRight]
Moves the pen position to the right side of the page
[PenMove,Horizontal
Offset,Vertical Offset]
Moves the pen a relative distance
[PenSetColor,Red,Green,Blue]
Sets the pen main color
[PixolPick,Component
Index. 0=CompositeColor (red*65536+green*256+blue) 1=Z(-32576
to 32576) 2=Red(0 to 255 ) 3=Green(0 to 255 ) 4=Blue(0 ,H
Position,V Position]
Output: The value of the specified Pixol
Retrieves information about a specified Pixol
[PropertySet,The
base command name (Title,SubTitle,Caption),Property Index,The
new Value]
Modifies the setting of Title, SubTitle and Caption text
[RGB,Red,Green,Blue]
Output: Combined RGB
Combines 3 color-components into one RGB value
[RoutineCall,Name
of the routine to be called,Input Var01,Input Var02,Input
Var03,Input Var04,Input Var05,Input Var06,Input Var07,Input
Var08,Input Var09,Input Var10]
Executes the specified defined routine
[RoutineDef,Name
of the routine,Commands group that will be executed when the
routine is called,Input Var01,Input Var02,Input Var03,Input
Var04,Input Var05,Input Var06,Input Var07,Input Var08,Input
Var09,Input Var10]
Defines a named commands group
[SectionBegin,Section
Title,Initial state (1=Expanded,0=Collapsed ),Popup Info Text,Commands
group to execute when expanding to reveal content,Commands
group to execute when collapsing to hide content,Initially
Disabled? (0=Enabled(ByDefault) NonZero=Disabled)]
Begins a collapsible section
[SectionEnd]
Ends a collapsible section
[StrokeGetInfo,Stroke-type
Variable,Info number,Point index (0 based)]
Output: StrokeInfo result
Retrieves the information from a specified Stroke-type Variable
[StrokeGetLast]
Output: StrokeData
Retrieves the last drawn brush stroke
[StrokeLoad,FileName
(.txt)]
Output: StrokeData
Loads a brush-stroke text file
[StrokesLoad,FileName
(.txt)]
Output: StrokesData
Loads a brush-strokes text file
[SubTitle,Text]
Displays a text line using the current SubTitle settings
[TextCalcWidth,The
text to be evaluated]
Output: Width of text in pixels
Calculates the pixel-width of the specified string
[Title,Text]
Displays a text line using the current Title settings
[TransformGet,xPos,yPos,zPos,xScale,yScale,zScale,xRotate,yRotate,zRotate]
Gets current transformation values.
[TransformSet,xPos,yPos,zPos,xScale,yScale,zScale,xRotate,yRotate,zRotate]
Sets new transformation values.
[Val,Variable
name]
Output: Value of the named variable
Evaluates the input and returns a numerical value
[VarAdd,Variable
name,Value To Add]
Adds a value to an existing variable
[VarDec,Variable
name]
Subtracts 1 from the value of an existing variable
[VarDef,Variable
name,Variable defaultValue]
Defines a variable
[VarDiv,Variable
name,Value to Divide By]
Divides an existing variable by a value
[VarInc,Variable
name]
Adds 1 to the value of an existing variable
[VarListCopy,Destination
list,Destination initial index,Source list,Source initial
index,Number of items to copy. (if omitted or it is 0, then
all items will be copied)]
Copies items from a source list to a destination list
[VarMul,Variable
name,Value to Multiply]
Multiplies an existing variable by a value
[VarSet,Variable
name,New Value]
Sets the value of a named variable
[VarSize,Variable
name]
Output: The number of items in a list or 1 if it is a simple
variable
Returns the number of items in a variable or in a list
[VarSub,Variable
name,Value To Subtract]
Subtracts a value from an existing variable
[Var,Variable
name]
Output: Value of the named variable
Gets the value of a named variable
Math
Functions:
SIN(angle)
COS(angle)
TAN(angle)
ASIN(value)
ACOS(value)
ATAN(value)
LOG(value)
LOG10(value)
SQRT(value)
ABS(value)
RAND(value)
IRAND(value)
BOOL(value)
INT(value)
FRAC(value)
NEG(value)
MIN(value1,value2)
MAX(value1,value2)
