Scriptor Contents - coldrockgames/doc-scriptor GitHub Wiki

Once you have included the gml-scriptor.yymps file in your project or created a new project using the gml-raptor-pro template, you will find a folder named gml-scriptor within the _gml_raptor_packages_ directory in the asset browser:

image

All files are prefixed with either Scriptor (for classes) or scriptor_ (for global functions) to minimize the risk of name-clashes with your project.
There are only two files you will directly interact with:

  • Scriptor (the main class)
  • ScriptorGml in case you need to extend the available gml functions (see Call a gml Function)

Since scriptor is a raptor-pro component, you also gain access to two modules:

  • The raptor module and
  • The logger module

Both modules provide additional Raptor functionality that can be used within your scripts.
You can create and integrate as many custom modules as you like. Learn more in Create Your Own Modules.