Project

General

Profile

Task #4090

Scripting documentation

Added by scrawl . 11 days ago.

Status:
New
Priority:
Normal
Assignee:
-
Category:
-
Target version:
-
Start date:
09/08/2017
% Done:

0%

Severity:
Normal

Description

UESP is not a useful resource in the context of OpenMW because it often lists bugs that no longer exists, workarounds that aren't necessary or parameters that don't actually exist. Aside from also being incomplete, this documentation lacks clarity and formality.

We should write a new scripting documentation specifically for OpenMW. The function reference should be written first as the most important resource. Later we can add a tutorial for the scripting language.

The function reference should include, for each function:
- parameters and their types
- return type
- complete behavior
- error handling
- interaction with other function(s)
- related functions

Note: for the purpose of research, check 'Op<scriptFunction>' in the code, e.g. https://github.com/OpenMW/openmw/search?utf8=%E2%9C%93&q=OpPosition&type=

Also available in: Atom PDF