Category:Script Events: Difference between revisions

The following is an index of script event hooks.

Script events are points during engine activity where OpenBOR executes either a native script or a user-defined script. Provided the script file exists and has been loaded, OpenBOR calls the main() function within that file. Lifecycle oncreate() and ondestroy() functions fire on load and destruction of the scripts respectfully.

Depending on its purpose, the script may modify properties, alter how the event is processed, or cancel the parent event entirely.

For example, OpenBOR checks for data/scripts/update.c when the game starts. When the file exists, OpenBOR loads it and executes its main() function during every internal engine update.