File: index_packages.rst

package info (click to toggle)
openmw 0.50.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 37,076 kB
  • sloc: cpp: 380,958; xml: 2,192; sh: 1,449; python: 911; makefile: 26; javascript: 5
file content (37 lines) | stat: -rw-r--r-- 986 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
########
Packages
########

.. include:: version.rst

.. toctree::
    :hidden:

    ambient <openmw_ambient>
    animation <openmw_animation>
    async <openmw_async>
    camera <openmw_camera>
    core <openmw_core>
    debug <openmw_debug>
    input <openmw_input>
    markup <openmw_markup>
    menu <openmw_menu>
    nearby <openmw_nearby>
    postprocessing <openmw_postprocessing>
    self <openmw_self>
    storage <openmw_storage>
    types <openmw_types>
    ui <openmw_ui>
    util <openmw_util>
    vfs <openmw_vfs>
    world <openmw_world>

**API packages**

API packages provide functions that can be called by scripts. I.e. it is a script-to-engine interaction.
A package can be loaded with ``require('<package name>')``.
It can not be overloaded even if there is a lua file with the same name.
The list of available packages is different for global and for local scripts.
Player scripts are local scripts that are attached to a player.

.. include:: tables/packages.rst