RandomNotes.wiki
author Wuzzy
Fri, 19 Apr 2019 15:16:14 +0100
changeset 1825 1d2aeacbdd8e
parent 1814 e6e9ed9d2626
child 1834 323d6e659cd7
permissions -rw-r--r--
LuaGears: Add usage warning for HideHog
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1728
26fbc53190c5 Add sandbox page to play around with wiki syntax
Wuzzy <almikes@aol.com>
parents: 1726
diff changeset
     1
#summary Little tidbits that await proper structuring
8
55340ce0339a Created wiki page through web user interface.
vittorio.giovara@gmail.com
parents:
diff changeset
     2
504
fbc43fa808ff Explain purpose of page, add undocumented Lua functions with parameters and guesses what they might do.
almikes@aol.com
parents: 8
diff changeset
     3
= Introduction =
fbc43fa808ff Explain purpose of page, add undocumented Lua functions with parameters and guesses what they might do.
almikes@aol.com
parents: 8
diff changeset
     4
This page is a collection of random unsorted or unfinished stuff which is not good or structured enough to be put into one of the “real” wiki pages. Wiki editors: If something becomes actually useable, please move it to the appropriate wiki page and remove it from this page.
fbc43fa808ff Explain purpose of page, add undocumented Lua functions with parameters and guesses what they might do.
almikes@aol.com
parents: 8
diff changeset
     5
fbc43fa808ff Explain purpose of page, add undocumented Lua functions with parameters and guesses what they might do.
almikes@aol.com
parents: 8
diff changeset
     6
This page is intentionally chaotic and may change rapidliy at any time.
fbc43fa808ff Explain purpose of page, add undocumented Lua functions with parameters and guesses what they might do.
almikes@aol.com
parents: 8
diff changeset
     7
fbc43fa808ff Explain purpose of page, add undocumented Lua functions with parameters and guesses what they might do.
almikes@aol.com
parents: 8
diff changeset
     8
= How to add a settings option =
fbc43fa808ff Explain purpose of page, add undocumented Lua functions with parameters and guesses what they might do.
almikes@aol.com
parents: 8
diff changeset
     9
 * `QStringList HWGame::setArguments()` in `game.cpp` is the function that prepares the argument list
fbc43fa808ff Explain purpose of page, add undocumented Lua functions with parameters and guesses what they might do.
almikes@aol.com
parents: 8
diff changeset
    10
 * `void GameUIConfig::SaveOptions()` in `gameuiconfig.cpp` loads (or initializes) values and set the widgets to those values
634
174622a27c8f web-edit: test
sheepluva
parents: 633
diff changeset
    11
 * `PageOptions::PageOptions(QWidget* parent) :  AbstractPage(parent)` is where you would add your widget
174622a27c8f web-edit: test
sheepluva
parents: 633
diff changeset
    12
1239
b028249e74c9 RandomNotes: fix typo
Wuzzy
parents: 1238
diff changeset
    13
= How to convert a `.hwmap` file to a Lua string =
1238
11ecdec25bf3 RandomNotes: How to converts a `.hwmap` file to Lua
Wuzzy
parents: 1237
diff changeset
    14
1814
e6e9ed9d2626 RandomNotes: Update hwmap help
Wuzzy
parents: 1765
diff changeset
    15
Run the shell script `tools/hwmap2lua.sh` found in the Hedgewars repository. Help is included in the source code.
1731
4fc410bc434e RandomNotes: Add newline at end
Wuzzy
parents: 1728
diff changeset
    16
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents: 1731
diff changeset
    17
= Undocumented Lua functions =
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents: 1731
diff changeset
    18
This script was used on [LuaAPI] to detect undocumented functions:
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents: 1731
diff changeset
    19
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents: 1731
diff changeset
    20
[http://hw.ercatec.net/docs/lua_wiki_check.php]
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents: 1731
diff changeset
    21
1814
e6e9ed9d2626 RandomNotes: Update hwmap help
Wuzzy
parents: 1765
diff changeset
    22
But due to a restructuring, this script no longer works, it needs to be updated. Functions are now located on LuaEvents, LuaGameplay, LuaGears, LuaStats, LuaGUI, LuaAudio and LuaUtil.