Script Manager Typical Compiler Error Messages

Format of Reference Pages


The pages following this one describe the script methods available in Mira Pro Script. In this User's Guide, all functions and class methods have a reference page that describes their usage. To understand how to implement a class method in your script, you must understand the layout of the Reference Pages.

The Reference Pages are organized into the following sections: Syntax, Example, Remarks, and Related Topics, as described below. On some of the References Pages, some particular sections are intentionally omitted.

Syntax Section

The Syntax section shows how the method or data is written in your script and describes its parameters. For example, the CImage:PolyFitImage method shows all the components of the method-call syntax:

     bResult = CImage:PolyFitImage( ct, rt, bConserve=true, CRect=nil )

and here is how to understand the components of the syntax:

                       bSuccess = I:PolyFitImage( 2, 3, true, R )

                       bSuccess = I:PolyFitImage( 2, 3, false )

                       bSuccess = I:PolyFitImage( 2, 3 )

                       I:PolyFitImage( 2, 3 )

Remarks Section

This section describes how the method is used and how it works or might be implemented in a script.

Example Section

This section is present on most of the description pages. It usually gives a short description of how to implement the method followed by a script fragment. In the script fragment, the line containing the actual method of interest is highlighted. Comments are included in green, like this -- this is a comment, as you would see them in the Script Editor. For the PolyFitImage example, here is what is meant by a script fragment:

I = CImage:new()

-- create a new CImage

I:Open( sPath )

-- load the image

I:PolyFitImage(7,4)

-- perform the operation on image I

I:Display()

 

I:delete()

 

Related Topics Section

The Related Topics lists links to other topics having related methods or a similar purpose.

Related Topics

Script Classes, Script Editor