aboutsummaryrefslogtreecommitdiff
path: root/docs/api/globals.lua
blob: 04b84f4078d8f31cd2cc3c36ea992faf13dcba7f (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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
---@meta

---The command line arguments given to pragtical.
---@type table<integer, string>
ARGS = {}

---The current platform tuple used for native modules loading,
---for example: "x86_64-linux", "x86_64-darwin", "x86_64-windows", etc...
---@type string
ARCH = "Architecture-OperatingSystem"

---The current operating system.
---@type string | "Windows" | "Mac OS X" | "Linux" | "iOS" | "Android"
PLATFORM = "Operating System"

---The current text or ui scale.
---@type number
SCALE = 1.0

---Full path of pragtical executable.
---@type string
EXEFILE = "/path/to/pragtical"

---Path to the users home directory.
---@type string
HOME = "/path/to/user/dir"

---This is set to true if pragtical was compiled with luajit.
---@type boolean
LUAJIT = false

---Directory that holds the editor lua sources and other data files.
---@type string
DATADIR = "/usr/share/pragtical"

---Directory that holds the user configuration files, plugins, colors, etc...
---@type string
USERDIR = "/home/user/.config/pragtical"

---Directory where the editor executable resides.
---@type string
EXEDIR = "/usr/bin"

---Default system scale.
---@type number
DEFAULT_SCALE = 1.0

---Current platform path separator, usually `/` or `\` on windows.
---@type string
PATHSEP = "/"

---Same as application major version.
---@type integer
MOD_VERSION_MAJOR = 3

---Same as application minor version.
---@type integer
MOD_VERSION_MINOR = 0

---Same as application patch version.
---@type integer
MOD_VERSION_PATCH = 0

---Same as application version.
---@type string
MOD_VERSION_STRING = "3.0.0"

---The application version.
---@type string
VERSION = "3.0.0"