RandomNotes.wiki
author almikes@aol.com
Mon, 15 Dec 2014 23:00:55 +0000
changeset 504 fbc43fa808ff
parent 8 55340ce0339a
child 506 c619a5931ee5
permissions -rw-r--r--
Explain purpose of page, add undocumented Lua functions with parameters and guesses what they might do.
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)
fbc43fa808ff Explain purpose of page, add undocumented Lua functions with parameters and guesses what they might do.
almikes@aol.com
parents: 8
diff changeset
    16
 * 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
    17
 * 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
    18
 * EndLuaTest(state)
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
  * state is TEST_SUCCESSFUL or TEST_FAILED
fbc43fa808ff Explain purpose of page, add undocumented Lua functions with parameters and guesses what they might do.
almikes@aol.com
parents: 8
diff changeset
    20
 * GetCampaignVar(varname)
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
 * SaveCampaignVar(varname, 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
    22
 * GetFlightTime(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
    23
 * SetFlightTime(gearUid, flighttime)
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
 * PlaceSprite(x, y, sprite, frameIdx, ...)
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
 * SetAmmoDelay(ammoType, delay)
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
  * Changes delay of ammoType to delay, the question remains where it is safe to be called.
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
 * 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
    28
 * 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
    29
 * 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
    30
 * onParameters()
fbc43fa808ff Explain purpose of page, add undocumented Lua functions with parameters and guesses what they might do.
almikes@aol.com
parents: 8
diff changeset
    31
 * 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
    32
fbc43fa808ff Explain purpose of page, add undocumented Lua functions with parameters and guesses what they might do.
almikes@aol.com
parents: 8
diff changeset
    33
= 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
    34
 * `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
    35
 * `void GameUIConfig::SaveOptions()` in `gameuiconfig.cpp` loads (or initializes) values and set the widgets to those values
fbc43fa808ff Explain purpose of page, add undocumented Lua functions with parameters and guesses what they might do.
almikes@aol.com
parents: 8
diff changeset
    36
 * `PageOptions::PageOptions(QWidget* parent) :  AbstractPage(parent)` is where you would add your widget