Cyclone 3DR Script is a module allowing the use of most functionalities from scripting code, using the Javascript programming language. It is currently based on the V8 engine (ECMA 2021 / ES12).

Writing your first script

Before writing your first line of code, it is strongly advised to browse the current pages to better understand the main philosophy of the script API.

Style Guide: Description about the class architecture and code syntax to write scripts.
Frequently Asked Questions: Frequent questions to help beginners.
Tutorials: Some tutorials to browse advanced components in the script API such as reporting.

Note: Additionaly, you can find complete scripts on the official GitHub repository.

API changes

We tend to change method parameters as little as possible. However, it is sometimes necessary to provide code modernization or fix bugs. In this case, you may need to update your script from time to time.

Note: Regularly check for the Deprecated List page to update your script if needed.

Current limitations

Currently, the import declaration is not supported.Therefore, importing module is not possible.