Scripting Documentation Project

[Admins]

Graal Scrip Documentation

The documentation will contain general informations about the Graal scripting engine, exact description of the script commands, variables, functions and events and commented code examples.

For the script commands we need good explainations and code examples. The commands should be thematic ordered instead of alphabetical ordered. Possible blocks of commands could be loop commands, string list commands, player-manipulation commands, npc-manipulation commands etc.

Here is a list of all available commands, variables and functions available on client-side and server-side. If you have good code examples then you can post them on this forum. Please follow these rules when posting code:

- Specify which commands, variables or functions you want to describe
- Try to keep it short; It doesn't need to be a complete working script, but must contain the necessary lines to make the example understandable
- The example must be correct and not 'guessed', please also verify variable names
- Comment the code example; You don't need to describe each single line, but must explain variables and commands that are not obvisious; Possibly explain what the command can be used for, what you need to keep care of etc.
- Use a good scripting style, which means each line should only contain one command, the lines should be indented the same way (tabs or 2 spaces per level), variable names should show their purpose etc.
- If you provide more than one example then keep the document organized so that it can easily be put together with other code examples

Information about message codes (#c) and general information about Graal or Graal Script can be submitted too, e.g. level editor help or descriptions of things like the editor path laying scripts. But make them easily readable and not too complex so that they can be used in the final documentation, it would be hard to read through the documentation if each thing is described in a different style.