KB: Edit a script to accommodate the latest changes in Altium API

Solution Details

If you encounter a function that does not work as described in our documentation, or if a script that previously worked in an older 64-bit version of Altium Designer no longer runs in a newer version, we can engage our R&D department to advise on what has changed in the codebase of Altium Designer and what change needs to be made to an existing script to make it working again, so please feel free to create a support case and attach your script.  Be sure to let us know in what older version it works.  For many questions & issues, posting on our community forum to see if another user has written a script for a similar function or had a similar issue will get a favorable response:
https://forum.live.altium.com/#/search?searchText=script
Please understand that creating and reviewing your own scripts is outside the scope of our technical support.
 
Upfront, there are few known changes that need to be made to accommodate progressive updates to the Altium Designer API:
• In some variable assignments, you need to prepend set\get to avoid the error "Object doesn't support this property or method".
• It is only starting in AD19 that unlimited number of mechanical layers is supported, such that constants prescribed prior are defined only in the fixed range of [eMechanical1..eMechanical16].
 

Variable Assignments

You need to prepend set\get to avoid the error such as below.

e.g.
error: Param = SchServer.SchObjectFactory(eParameter, eCreate_Default)
no error: Set Param = SchServer.SchObjectFactory(eParameter, eCreate_Default)
 

Constant Definition

It is only starting in AD19 that unlimited number of mechanical layers is supported, such that constants prescribed prior are defined only in the fixed range of [eMechanical1..eMechanical16].  A newer, more robust way to access mechanical layer would be as depicted in the following code snippet.

for LayerType := 1 to N do
    begin
        LyrMech := Stack.LayerObject[PCBServer.LayerUtils.MechanicalLayer(LayerType)];
        LayerName := Board.LayerName(PCBServer.LayerUtils.MechanicalLayer(LayerType));
    end;
end;

Script Language supported:

For the foreseeable future, Altium continues to support the use of different kinds of scripting languages.  Delphi is recommended, as this is a language for which no additional resources need to be installed on a computer to run it.  Since Version AD18 the support for JavaScript, VisualBasic Script, EnableBasic Script and TCL needs to be enabled in the Preferences ► System ► General ► Advanced section of Altium Designer.  Check the box under the Value column for the Preference Name Legacy.Scripts.SupportOldLanguages.
 

List of Additional Documentation Related to Scripting:

Participating in SDK Beta Program: 

In contrast to scripting, SDK can be used for larger projects, where Vector manipulation, dictionary, maps, sort, select and group algorithms are needed. Therefore a compiler needs to be installed.  For companies that want to create their own applications, we provide the Altium Software Development Kit (SDK) in the current beta, version free of charge.  The technical exchange and questions about the Altium Developer will take place exclusively via the forum provided at that time.