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

Give InventoryObject some documentation. Rename "name" to "nameKey".

Browse source
This commit is contained in:
hispidence 2021-08-09 20:01:05 +01:00
parent 9ce4157d54
commit 6257cf49b7
1 changed files with 21 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

22
TR5Main/Scripting/GameScriptInventoryObject.cpp
View file

@ -1,6 +1,13 @@
#include "framework.h" #include "framework.h"
#include "GameScriptInventoryObject.h" #include "GameScriptInventoryObject.h"
/***
Represents the properties of an object as it appears in the inventory.
@classmod InventoryObject
@pragma nostrip
*/
GameScriptInventoryObject::GameScriptInventoryObject(std::string const& a_name, ItemEnumPair a_slot, float a_yOffset, float a_scale, float a_xRot, float a_yRot, float a_zRot, short a_rotationFlags, int a_meshBits, __int64 a_operation) : GameScriptInventoryObject::GameScriptInventoryObject(std::string const& a_name, ItemEnumPair a_slot, float a_yOffset, float a_scale, float a_xRot, float a_yRot, float a_zRot, short a_rotationFlags, int a_meshBits, __int64 a_operation) :
name{ a_name }, name{ a_name },
slot{ a_slot.m_pair.second }, slot{ a_slot.m_pair.second },
@ -18,9 +25,22 @@ void GameScriptInventoryObject::Register(sol::state * lua)
{ {
lua->new_usertype<GameScriptInventoryObject>("InventoryObject", lua->new_usertype<GameScriptInventoryObject>("InventoryObject",
sol::constructors<GameScriptInventoryObject(std::string const &, ItemEnumPair, float, float, float, float, float, short, int, __int64)>(), sol::constructors<GameScriptInventoryObject(std::string const &, ItemEnumPair, float, float, float, float, float, short, int, __int64)>(),
"name", &GameScriptInventoryObject::name,
/// (string) string key for the item's (localised) name. Corresponds to an entry in strings.lua.
//@mem nameKey
"nameKey", &GameScriptInventoryObject::name,
/// (float) y-axis offset.
// A value of about 100 will cause the item to display directly below its usual position.
//@mem nameKey
"yOffset", &GameScriptInventoryObject::yOffset, "yOffset", &GameScriptInventoryObject::yOffset,
/// (float) Item's size when displayed in the inventory as a multiple of its "regular" size.
// A value of 0.5 will cause the item to render at half the size,
// and a value of 2 will cause the item to render at twice the size.
//@mem scale
"scale", &GameScriptInventoryObject::scale, "scale", &GameScriptInventoryObject::scale,
"xRot", &GameScriptInventoryObject::xRot, "xRot", &GameScriptInventoryObject::xRot,
"yRot", &GameScriptInventoryObject::yRot, "yRot", &GameScriptInventoryObject::yRot,
"zRot", &GameScriptInventoryObject::zRot, "zRot", &GameScriptInventoryObject::zRot,