RandomNotes.wiki
author Wuzzy
Tue, 26 Sep 2017 13:17:57 +0100
changeset 1038 30a9877bf8e8
parent 845 3883f95063dc
child 1237 c4a843642c21
permissions -rw-r--r--
LuaAPI: Fix poor explanation of siTeamStats

#summary little tidbits that await proper structuring

= Introduction =
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.

This page is intentionally chaotic and may change rapidliy at any time.

= Undocumented LuaAPI functions =
Full list (without parameters, but automatically generated) at http://hw.ercatec.net/docs/lua_wiki_check.php.

 * `CampaignLock`
  * Marked as “TODO” in source code
 * `CampaignUnlock`
  * Marked as “TODO” in source code
 * `SetGearCollisionMask(gearUid, mask)`
  * `mask` can be between `0x0000` and `0xFFFF`. `0xFFFF` collides with everything, `0xFF00` collides with land only, `0x00FF` collides with other gears only, `0x0000` collides with nothing. The meaning of other values is unclear and should be discovered.
 * `GetGearCollisionMask(gearUid)`
 * `DeclareAchievement(achievementId, teamname, location, value)`
 * `EndLuaTest(state)`
  * state is `TEST_SUCCESSFUL` or `TEST_FAILED)`
 * `SetAmmoStore(loadouts, probabilities, delays, reinforcements)`
 * `SetGearAIHints(gearUid, aiHints)`
 * `onAchievementsDeclaration()`
 * `onSpecialPoint(x, y, flags)`

= How to add a settings option =
 * `QStringList HWGame::setArguments()` in `game.cpp` is the function that prepares the argument list
 * `void GameUIConfig::SaveOptions()` in `gameuiconfig.cpp` loads (or initializes) values and set the widgets to those values
 * `PageOptions::PageOptions(QWidget* parent) :  AbstractPage(parent)` is where you would add your widget


= Syntax test =

== Bullet points ==

 * Single lonely bullet point

 * Two bullet points
 * Two bullet points

 * Three bullets!
 * Three bullets!
 * Three bullets!

== Linktest ==

[RandomNotes#Undocumented_LuaAP_functions TESTLINK1]
[RandomNotes#Bullet_points TESTLINK2]