Archive/TombEngine
0
0
Fork 0
mirror of https://github.com/TombEngine/TombEngine.git synced 2025-05-10 12:36:45 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fix some documentation.

Browse source
This commit is contained in:
hispidence 2021-08-12 22:11:50 +01:00
parent bee2a2d2f4
commit e7166b05ba
3 changed files with 8 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

11
TR5Main/Scripting/GameLogicScript.cpp
View file

@ -20,7 +20,7 @@
#endif
/***
functions and callbacks for game specific scripts
Functions and callbacks for level-specific logic scripts.
@module gamelogic
@pragma nostrip
*/
@ -193,7 +193,7 @@ A count of 0 will add the "default" amount of that item
For example, giving "zero" crossbow ammo would give the player
10 instead, whereas giving "zero" medkits would give the player 1 medkit.
@function GiveInvItem
@tparam @{InvItem} item the item to be added
@tparam InvItem item the item to be added
@tparam int count the number of items to add (default: 0)
*/
m_lua->set_function("GiveInvItem", &InventoryAdd);
@ -202,7 +202,7 @@ For example, giving "zero" crossbow ammo would give the player
Remove x of a certain item from the inventory.
As in @{GiveInvItem}, a count of 0 will remove the "default" amount of that item.
@function TakeInvItem
@tparam @{InvItem} item the item to be removed
@tparam InvItem item the item to be removed
@tparam int count the number of items to remove (default: 0)
*/
m_lua->set_function("TakeInvItem", &InventoryRemove);
@ -210,8 +210,8 @@ As in @{GiveInvItem}, a count of 0 will remove the "default" amount of that item
/***
Get the amount the player holds of an item.
@function GetInvItemCount
@tparam @{InvItem} item the item to check
@return the amount of the item the player has in the inventory
@tparam InvItem item the item to check
@treturn int the amount of the item the player has in the inventory
*/
m_lua->set_function("GetInvItemCount", &InventoryGetCount);
@ -280,6 +280,7 @@ Calculate the distance between two positions.
@treturn int the direct distance from one position to the other
*/
m_lua->set_function("CalculateDistance", &CalculateDistance);
/***
Calculate the horizontal distance between two positions.
@function CalculateHorizontalDistance