aboutsummaryrefslogtreecommitdiff
path: root/doc/manual/7_LuaInterface.md
blob: f1e343d94679d7883b9196a27ff7bd6f99d2799b (plain)
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
# Lua Interface

After startup, Textadept relinquishes control to Lua. At this point, having a
Manual is pointless since all of Textadept's functionality is dynamic from here
on out. This is where the most important resource for help comes in: the
[LuaDoc][LuaDoc]. It contains not only documentation for Textadept's Lua API,
but documentation for all of its modules and features as well. It is more up to
date than a manual like this could ever be.

[LuaDoc]: ../index.html

## Global Variables

The following global variables not mentioned in the LuaDoc are available in
Textadept's Lua state:

* `arg`: Table containing the command line arguments passed to Textadept.
* `_HOME`: Path to the directory containing Textadept.
* `WIN32`: If Textadept is running on Windows, this flag is `true`.
* `MAC`: If Textadept is running on Mac OSX, this flag is `true`.
* `_CHARSET`: The character set encoding of the filesystem. This is used in
  [File I/O][file_io].
* `RESETTING`: If [`textadept.reset()`][textadept_reset] has been called, this
  flag is `true` while the Lua state is being re-initialized.

[file_io]: ../modules/textadept.io.html
[textadept_reset]: ../modules/textadept.html#reset