Skip to content

Commit d04712f

Browse files
committed
Revert renaming for now
This mostly reverts commit 762f048, except when irrelevant. This commit can be reverted when/if renamng is done.
1 parent c665019 commit d04712f

10 files changed

+32
-32
lines changed

Makefile

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -91,9 +91,9 @@ qthelp:
9191
@echo
9292
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
9393
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
94-
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/LeagueLuaAPI.qhcp"
94+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/LegacyLuaAPI.qhcp"
9595
@echo "To view the help file:"
96-
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/LeagueLuaAPI.qhc"
96+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/LegacyLuaAPI.qhc"
9797

9898
.PHONY: applehelp
9999
applehelp:
@@ -110,8 +110,8 @@ devhelp:
110110
@echo
111111
@echo "Build finished."
112112
@echo "To view the help file:"
113-
@echo "# mkdir -p $$HOME/.local/share/devhelp/LeagueLuaAPI"
114-
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/LeagueLuaAPI"
113+
@echo "# mkdir -p $$HOME/.local/share/devhelp/LegacyLuaAPI"
114+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/LegacyLuaAPI"
115115
@echo "# devhelp"
116116

117117
.PHONY: epub

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# League Lua API documentation [![Documentation Status](https://readthedocs.org/projects/etlegacy-lua-docs/badge/?version=latest)](http://etlegacy-lua-docs.readthedocs.io/en/latest/?badge=latest)
1+
# Legacy Lua API documentation [![Documentation Status](https://readthedocs.org/projects/etlegacy-lua-docs/badge/?version=latest)](http://etlegacy-lua-docs.readthedocs.io/en/latest/?badge=latest)
22

3-
League's Lua API is the interface for communication between Lua and League mod.
3+
Legacy's Lua API is the interface for communication between Lua and Legacy mod.
44

55
This documentation is generated with [Sphinx](http://www.sphinx-doc.org/) using the [reStructuredText](http://www.sphinx-doc.org/en/stable/rest.html) markup language.
66

callbacks.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Called when qagame runs a server frame.
3838
et_Quit()
3939
---------
4040

41-
Called when League unloads the mod.
41+
Called when Legacy unloads the mod.
4242

4343
The mod should close all open filedescriptors and perform all cleanup.
4444

conf.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/usr/bin/env python3
22
# -*- coding: utf-8 -*-
33
#
4-
# League Lua API documentation build configuration file, created by
4+
# Legacy Lua API documentation build configuration file, created by
55
# sphinx-quickstart on Tue Sep 13 00:05:27 2016.
66
#
77
# This file is execfile()d with the current directory set to its
@@ -52,7 +52,7 @@
5252
master_doc = 'index'
5353

5454
# General information about the project.
55-
project = 'League Lua API'
55+
project = 'Legacy Lua API'
5656
copyright = '2012-2020, ET: Legacy Team'
5757
author = 'ET: Legacy Team'
5858

@@ -137,7 +137,7 @@
137137
# The name for this set of Sphinx documents.
138138
# "<project> v<release> documentation" by default.
139139
#
140-
# html_title = 'League Lua API v2.76'
140+
# html_title = 'Legacy Lua API v2.76'
141141

142142
# A shorter title for the navigation bar. Default is the same as html_title.
143143
#
@@ -237,7 +237,7 @@
237237
# html_search_scorer = 'scorer.js'
238238

239239
# Output file base name for HTML help builder.
240-
htmlhelp_basename = 'LeagueLuaAPIdoc'
240+
htmlhelp_basename = 'LegacyLuaAPIdoc'
241241

242242
# -- Options for LaTeX output ---------------------------------------------
243243

@@ -263,7 +263,7 @@
263263
# (source start file, target name, title,
264264
# author, documentclass [howto, manual, or own class]).
265265
latex_documents = [
266-
(master_doc, 'LeagueLuaAPI.tex', 'League Lua API Documentation',
266+
(master_doc, 'LegacyLuaAPI.tex', 'Legacy Lua API Documentation',
267267
'ET: Legacy Team', 'manual'),
268268
]
269269

@@ -305,7 +305,7 @@
305305
# One entry per manual page. List of tuples
306306
# (source start file, name, description, authors, manual section).
307307
man_pages = [
308-
(master_doc, 'leagueluaapi', 'League Lua API Documentation',
308+
(master_doc, 'legacyluaapi', 'Legacy Lua API Documentation',
309309
[author], 1)
310310
]
311311

@@ -320,8 +320,8 @@
320320
# (source start file, target name, title, author,
321321
# dir menu entry, description, category)
322322
texinfo_documents = [
323-
(master_doc, 'LeagueLuaAPI', 'League Lua API Documentation',
324-
author, 'LeagueLuaAPI', 'One line description of project.',
323+
(master_doc, 'LegacyLuaAPI', 'Legacy Lua API Documentation',
324+
author, 'LegacyLuaAPI', 'One line description of project.',
325325
'Miscellaneous'),
326326
]
327327

constants.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -511,12 +511,12 @@ Lua constants
511511
================= ==================================== ==================
512512
Name Value Description
513513
================= ==================================== ==================
514-
LUA_PATH ./league/?.lua; Ease use of the require function
515-
./league/lualibs/?.lua; to load scripts
514+
LUA_PATH ./legacy/?.lua; Ease use of the require function
515+
./legacy/lualibs/?.lua; to load scripts
516516
fs_homepath/fs_game/?.lua;
517517
fs_homepath/fs_game/lualibs/?.lua
518-
LUA_CPATH ./league/lualibs/?.so; Ease use of the require function
519-
fs_homepath/league/lualibs/?.so to load libraries
518+
LUA_CPATH ./legacy/lualibs/?.so; Ease use of the require function
519+
fs_homepath/legacy/lualibs/?.so to load libraries
520520
LUA_DIRSEP / Directory separator
521521
_VERSION Lua 5.4 Lua version
522522
================= ==================================== ==================

cvars.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Cvars
1111
lua_modules
1212
-----------
1313

14-
Space separated list of lua modules for League mod to load. Modules will be run in the order listed.
14+
Space separated list of lua modules for Legacy mod to load. Modules will be run in the order listed.
1515

1616

1717
lua_allowedmodules

database.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Database
33
========
44

5-
Both the League mod and the ET: Legacy engine are built-in with `SQLite3 <https://www.sqlite.org/>`_ database support. The engine allows to execute SQL statement directly in console, while the League mod has access through `LuaSQL <https://keplerproject.github.io/luasql/>`_.
5+
Both the Legacy mod and the ET: Legacy engine are built-in with `SQLite3 <https://www.sqlite.org/>`_ database support. The engine allows to execute SQL statement directly in console, while the Legacy mod has access through `LuaSQL <https://keplerproject.github.io/luasql/>`_.
66

77
.. tip:: See the `Database <sample.html#database>`__ sample code for an example of basic database usage.
88

index.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
1-
.. League Lua API documentation master file, created by
1+
.. Legacy Lua API documentation master file, created by
22
sphinx-quickstart on Tue Sep 13 00:05:27 2016.
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
6-
League Lua API documentation
6+
Legacy Lua API documentation
77
============================
88

9-
Welcome to the League Lua API's documentation!
9+
Welcome to the Legacy Lua API's documentation!
1010

11-
The **League mod** is the default mod shipped with `ET: Legacy <http://www.etlegacy.com>`_. It supports server-side modifications via the `Lua <http://www.lua.org/>`_ scripting language, with the League Lua API being the interface for communication between them.
11+
The **Legacy mod** is the default mod shipped with `ET: Legacy <http://www.etlegacy.com>`_. It supports server-side modifications via the `Lua <http://www.lua.org/>`_ scripting language, with the Legacy Lua API being the interface for communication between them.
1212

13-
The embedded **Lua 5.4** interpreter will load user-defined scripts if present in the `league` directory. The Lua API provides an "et" library of `function calls <functions.html>`__ that allow access to the server engine, and also provides `callbacks <callbacks.html>`__ so a server side mod may trigger on specific server events.
13+
The embedded **Lua 5.4** interpreter will load user-defined scripts if present in the `legacy` directory. The Lua API provides an "et" library of `function calls <functions.html>`__ that allow access to the server engine, and also provides `callbacks <callbacks.html>`__ so a server side mod may trigger on specific server events.
1414

15-
In some cases values can be returned to League mod, whenever something is intercepted (i.e. a command) and prevented to be further handled. This way, new commands can easily be defined or existing ones can be altered.
15+
In some cases values can be returned to Legacy mod, whenever something is intercepted (i.e. a command) and prevented to be further handled. This way, new commands can easily be defined or existing ones can be altered.
1616

1717
Through special functions, it is also possible to alter internal structures or entities (manipulate client XP, set and read cvars, remap shaders, etc.).
1818
For example, if a player dies the `et_Obituary( victim, killer, meansOfDeath ) <callbacks.html#et-obituary-target-attacker-meansofdeath>`__ function is executed, and the Lua API allows you to manipulate and control this information.
1919

2020
.. note:: Like qagame, Lua modules are unloaded and reloaded on `map_restart` and map changes, which means that all global variables and other information is lost. Persistent data can be stored in `cvars <functions.html#cvars>`__, external `files <functions.html#filesystem>`__ or `database <database.html>`__.
2121

22-
League's Lua API follows mostly the `ETPub <http://www.etpub.org/>`_ implementation with partial code of the NoQuarter implemention. The ETPub implementation being built to be compatible with `ETPro's Lua <http://wolfwiki.anime.net/index.php/Lua_Mod_API>`_, all scripts written in ETPro's documentation should be valid and more or less compatible with League mod's Lua API.
22+
Legacy's Lua API follows mostly the `ETPub <http://www.etpub.org/>`_ implementation with partial code of the NoQuarter implemention. The ETPub implementation being built to be compatible with `ETPro's Lua <http://wolfwiki.anime.net/index.php/Lua_Mod_API>`_, all scripts written in ETPro's documentation should be valid and more or less compatible with Legacy mod's Lua API.
2323

24-
.. important:: As League uses the newer Lua 5.4, you might want to check the **Incompatibilities with the Previous Version** sections of the `Lua 5.1 <https://www.lua.org/manual/5.1/manual.html#7>`_, `Lua 5.2 <https://www.lua.org/manual/5.2/manual.html#8>`_, `Lua 5.3 <https://www.lua.org/manual/5.3/manual.html#8>`_, and `Lua 5.4 <https://www.lua.org/manual/5.4/manual.html#8>`_ manuals while porting scripts written for other mods.
24+
.. important:: As Legacy uses the newer Lua 5.4, you might want to check the **Incompatibilities with the Previous Version** sections of the `Lua 5.1 <https://www.lua.org/manual/5.1/manual.html#7>`_, `Lua 5.2 <https://www.lua.org/manual/5.2/manual.html#8>`_, `Lua 5.3 <https://www.lua.org/manual/5.3/manual.html#8>`_, and `Lua 5.4 <https://www.lua.org/manual/5.4/manual.html#8>`_ manuals while porting scripts written for other mods.
2525

2626
.. toctree::
2727
:maxdepth: 2

make.bat

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -129,9 +129,9 @@ if "%1" == "qthelp" (
129129
echo.
130130
echo.Build finished; now you can run "qcollectiongenerator" with the ^
131131
.qhcp project file in %BUILDDIR%/qthelp, like this:
132-
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\LeagueLuaAPI.qhcp
132+
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\LegacyLuaAPI.qhcp
133133
echo.To view the help file:
134-
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\LeagueLuaAPI.ghc
134+
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\LegacyLuaAPI.ghc
135135
goto end
136136
)
137137

sample.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Sample code
33
===========
44

5-
.. tip:: If you want to see some specific Lua examples, you can check the `Lua scripts <https://github.com/etlegacy/etlegacy-lua-scripts>`_ repository.
5+
.. tip:: If you want to see some specific Lua examples, you can check the `ET Legacy Lua scripts <https://github.com/etlegacy/etlegacy-lua-scripts>`_ repository.
66

77

88
General

0 commit comments

Comments
 (0)