RandomNotes.wiki
author Wuzzy
Thu, 10 Sep 2015 04:38:13 +0000
changeset 632 097e645fe00b
parent 599 5f4ca19b75ca
child 633 87ad9962ee1f
permissions -rw-r--r--
Clean-up
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
8
55340ce0339a Created wiki page through web user interface.
vittorio.giovara@gmail.com
parents:
diff changeset
     1
#summary little tidbits that await proper structuring
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
= Undocumented LuaAPI functions =
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
Full list (without parameters, but automatically generated) at http://hw.ercatec.net/docs/lua_wiki_check.php.
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
fbc43fa808ff Explain purpose of page, add undocumented Lua functions with parameters and guesses what they might do.
almikes@aol.com
parents: 8
diff changeset
    11
 * CampaignLock
fbc43fa808ff Explain purpose of page, add undocumented Lua functions with parameters and guesses what they might do.
almikes@aol.com
parents: 8
diff changeset
    12
  * Marked as “TODO” in source code
fbc43fa808ff Explain purpose of page, add undocumented Lua functions with parameters and guesses what they might do.
almikes@aol.com
parents: 8
diff changeset
    13
 * CampaignUnlock
fbc43fa808ff Explain purpose of page, add undocumented Lua functions with parameters and guesses what they might do.
almikes@aol.com
parents: 8
diff changeset
    14
  * Marked as “TODO” in source code
fbc43fa808ff Explain purpose of page, add undocumented Lua functions with parameters and guesses what they might do.
almikes@aol.com
parents: 8
diff changeset
    15
 * SetGearCollisionMask(gearUid, mask)
632
097e645fe00b Clean-up
Wuzzy
parents: 599
diff changeset
    16
  * `mask` can be between `0x0000` and `0xFFFF`. `0xFFFF` collides with everything, `0xFF00` collides with land only, `0x00FF` collides with other gears only. The meaning of other values is unclear and should be discovered.
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
    17
 * GetGearCollisionMask(gearUid)
fbc43fa808ff Explain purpose of page, add undocumented Lua functions with parameters and guesses what they might do.
almikes@aol.com
parents: 8
diff changeset
    18
 * DeclareAchievement(achievementId, teamname, location, value)
fbc43fa808ff Explain purpose of page, add undocumented Lua functions with parameters and guesses what they might do.
almikes@aol.com
parents: 8
diff changeset
    19
 * EndLuaTest(state)
632
097e645fe00b Clean-up
Wuzzy
parents: 599
diff changeset
    20
  * state is `TEST_SUCCESSFUL` or `TEST_FAILED)
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
    21
 * SetAmmoStore(loadouts, probabilities, delays, reinforcements)
fbc43fa808ff Explain purpose of page, add undocumented Lua functions with parameters and guesses what they might do.
almikes@aol.com
parents: 8
diff changeset
    22
 * SetGearAIHints(gearUid, aiHints)
fbc43fa808ff Explain purpose of page, add undocumented Lua functions with parameters and guesses what they might do.
almikes@aol.com
parents: 8
diff changeset
    23
 * onAchievementsDeclaration()
fbc43fa808ff Explain purpose of page, add undocumented Lua functions with parameters and guesses what they might do.
almikes@aol.com
parents: 8
diff changeset
    24
 * onSpecialPoint(x, y, flags)
fbc43fa808ff Explain purpose of page, add undocumented Lua functions with parameters and guesses what they might do.
almikes@aol.com
parents: 8
diff changeset
    25
fbc43fa808ff Explain purpose of page, add undocumented Lua functions with parameters and guesses what they might do.
almikes@aol.com
parents: 8
diff changeset
    26
= 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
    27
 * `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
    28
 * `void GameUIConfig::SaveOptions()` in `gameuiconfig.cpp` loads (or initializes) values and set the widgets to those values
632
097e645fe00b Clean-up
Wuzzy
parents: 599
diff changeset
    29
 * `PageOptions::PageOptions(QWidget* parent) :  AbstractPage(parent)` is where you would add your widget