mirror of
https://github.com/etlegacy/lua_apidoc.git
synced 2024-11-24 21:01:23 +00:00
added intro
This commit is contained in:
parent
025a8f50e0
commit
e3577da381
2 changed files with 27 additions and 5 deletions
|
@ -1,3 +1,5 @@
|
|||
# Legacy Lua API documentation
|
||||
|
||||
This is the documentation of the Legacy mod Lua API
|
||||
Legacy's Lua API is the interface for communication between Lua and Legacy mod.
|
||||
|
||||
This documentation can be read online at [legacy-lua-api.rtfd.io](http://legacy-lua-api.rtfd.io)
|
||||
|
|
28
index.rst
28
index.rst
|
@ -3,18 +3,38 @@
|
|||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Welcome to Legacy Lua API's documentation!
|
||||
==========================================
|
||||
Legacy Lua API
|
||||
==============
|
||||
|
||||
Contents:
|
||||
Welcome to the Legacy Lua API's documentation!
|
||||
|
||||
The **Legacy mod** is the default mod shipped with `ET: Legacy <http://www.etlegecy.com>`_. It supports server-side modifications via the `Lua <http://www.lua.org/>`_ scripting language.
|
||||
|
||||
If present, the embedded Lua 5.3 interpreter will load user-defined scripts from the Legacy directory. It also provides an "et" library of function calls for Lua that allow access to the server engine, and provides callbacks so a server side mod may trigger on specific server events.
|
||||
|
||||
For more information about Lua, check out the `Reference Manual <http://www.lua.org/manual/5.3/>`_, the online edition of the book `Programming in Lua <http://www.lua.org/pil/>`_ or the `Lua-users wiki <http://lua-users.org/wiki/>`_.
|
||||
|
||||
If you want to see some ET-specific Lua examples, you can check the `ET Legacy Lua scripts <https://github.com/etlegacy/etlegacy-lua_scripts>`_ repository.
|
||||
|
||||
|
||||
Contents
|
||||
--------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
intro
|
||||
cvars
|
||||
commands
|
||||
functions
|
||||
callbacks
|
||||
fields
|
||||
constants
|
||||
database
|
||||
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
------------------
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
|
|
Loading…
Reference in a new issue