Skip to content
Andrzej edited this page Aug 26, 2024 · 70 revisions

Welcome to the Wiki!

Note

This wiki is currently under reconstruction.

Here you can find all the necessary information to start working with the plugin.

  • how to install the plugin
  • how to write a script

Old documentation

Notice for documentation:

Starting with Version 3.0.0 of Scripted Events, documentation can now be hosted entirely on your computer.

How?

In your server console, run the shelp GENERATE command and follow the instructions to create documentation entirely on your computer. Run shelp SHOW to open the folder with documentation at any time.

Why?

Although online documentation is a bit more standard, unfortunately we don't have the time or manpower to continue updating this wiki. The generated documentation through the command is generated entirely via the plugin's source code, with the descriptions being the only thing written by us. The descriptions being in the source code allows everything to be together in one place, and is overall a lot easier for us to maintain as opposed to an entirely separate wiki.

I don't want to generate all documentation, is there any way to view documentation for individual actions/variables?

Of course! Using the shelp command, provide the name of an action, variable, enum, or error code to generate only its respective documentation. The file is automatically deleted when the server restarts, or after 5 minutes, so don't worry about documentation piling up. Alternatively, running shelp LIST, shelp LISTVAR, or shelp LISTENUM will list actions, variables, or enums respectively.

Does the documentation automatically update?

As of Version 3.0.0, no. However, SE will detect when the plugin has updated but the documentation has not, and will prompt you to re-run the shelp GENERATE command. Re-generating documentation deletes all previous documentation.

I have more questions!!!

Join our discord Server: https://discord.gg/3j54zBnbbD

Actions

Clone this wiki locally