Scriptor Configuration - coldrockgames/doc-scriptor GitHub Wiki
Like all other raptor
modules, scriptor
also adds a configuration file to the _GAME_SETUP_
section of your project.
This Scriptor_Configuration
file is simple and straightforward. It offers three configuration value:
#macro SCRIPTOR_ROOT_FOLDER "scripts/"
#macro SCRIPTOR_BROKER_AUTOSTART true
#macro SCRIPTOR_AUTO_INCLUDE_MODULES global.__scriptor_autoload
SCRIPTOR_AUTO_INCLUDE_MODULES = [ "raptor", "raptor_logger" ];
Configuration value | Description |
---|---|
SCRIPTOR_ROOT_FOLDER |
This is the folder inside your Included Files of the project, where scriptor will look for scripts. |
SCRIPTOR_BROKER_AUTOSTART |
Defaults to true and tells scriptor, to start an instance of The Scriptor Broker when the game starts. |
SCRIPTOR_AUTO_INCLUDE_MODULES |
This array contains the name of all modules that shall be included in every script before it gets compiled. Modules are added in the order, they are mentioned here. This saves you quite some repetitive code in your scripts. |