Archive/TombEngine
0
0
Fork 0
mirror of https://github.com/TombEngine/TombEngine.git synced 2025-05-01 01:08:01 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions
TombEngine/TR5Main/Scripting/GameScriptItemInfo.h

94 lines
2.2 KiB
C
Raw Normal View History

Add GameScriptItemInfo class. This is the first pass at wrapping an ITEM_INFO in a struct and handing it over to Lua. Many improvements should follow - this is more of a test implementation.
2021-06-28 18:23:26 +01:00
#pragma once
Add GameScriptItemInfo::«Set/Get»ObjectID and GameScriptItemInfo::SetNameCallbacks. Add calls to the callbacks to GameScriptItemInfo::SetName, so that giving a Lua name to an object removes its existing object and any other object currently using the new name, before then putting the name into the map. Add initial documentation for the Lua-exported parts.
2021-07-17 23:46:09 +01:00
#include <functional>
Add GameScriptItemInfo class. This is the first pass at wrapping an ITEM_INFO in a struct and handing it over to Lua. Many improvements should follow - this is more of a test implementation.
2021-06-28 18:23:26 +01:00
namespace sol {
class state;
Add CreateEmpty, so that new can be called on the Lua side with no args. Change pos and rot from arrays to GameScript[Position/Rotation]. Add getters and setters for the members used so far. Add Init, which for now is needed to get an item working properly.
2021-06-30 14:08:12 +01:00
template <typename T> struct as_table_t;
Add GameScriptItemInfo class. This is the first pass at wrapping an ITEM_INFO in a struct and handing it over to Lua. Many improvements should follow - this is more of a test implementation.
2021-06-28 18:23:26 +01:00
}
Add CreateEmpty, so that new can be called on the Lua side with no args. Change pos and rot from arrays to GameScript[Position/Rotation]. Add getters and setters for the members used so far. Add Init, which for now is needed to get an item working properly.
2021-06-30 14:08:12 +01:00
class GameScriptPosition;
class GameScriptRotation;
Merge GameScriptInfo into GameScriptItemInfo. Add move constructor. Make functions use item ptr directly.
2021-07-01 19:27:57 +01:00
struct ITEM_INFO;
Add GameScriptItemInfo::«Set/Get»ObjectID and GameScriptItemInfo::SetNameCallbacks. Add calls to the callbacks to GameScriptItemInfo::SetName, so that giving a Lua name to an object removes its existing object and any other object currently using the new name, before then putting the name into the map. Add initial documentation for the Lua-exported parts.
2021-07-17 23:46:09 +01:00
enum GAME_OBJECT_ID : short;
using callbackSetName = std::function<bool(std::string const&, short itemID)>;
using callbackRemoveName = std::function<bool(std::string const&)>;
Add GameScriptItemInfo class. This is the first pass at wrapping an ITEM_INFO in a struct and handing it over to Lua. Many improvements should follow - this is more of a test implementation.
2021-06-28 18:23:26 +01:00
class GameScriptItemInfo
{
public:
Add concept of 'temporary' ItemInfo instances. These instances will kill the ITEM_INFO they reference when they are destroyed. This was previously the default behaviour. However, now that we're using things like GetItemByName, it makes more sense for ItemInfos to be non-owning by default. Move LDoc from GameScriptItemInfo.h to GameScriptItemInfo.cpp. This might seem counter-intuitive, but LDoc is concerned with the Lua interfaces rather than the actual C++ functions; since the Lua interfaces are defined in GameScriptItemInfo::Register, it makes more sense for the comments to be nearby.
2021-07-20 17:18:39 +01:00
GameScriptItemInfo(short num, bool temporary);
Add GameScriptItemInfo class. This is the first pass at wrapping an ITEM_INFO in a struct and handing it over to Lua. Many improvements should follow - this is more of a test implementation.
2021-06-28 18:23:26 +01:00
~GameScriptItemInfo();
GameScriptItemInfo& operator=(GameScriptItemInfo const& other) = delete;
GameScriptItemInfo(GameScriptItemInfo const& other) = delete;
Merge GameScriptInfo into GameScriptItemInfo. Add move constructor. Make functions use item ptr directly.
2021-07-01 19:27:57 +01:00
GameScriptItemInfo(GameScriptItemInfo && other) noexcept;
Add and register "name" getter and setter for the string ID of an item.
2021-07-05 18:19:10 +01:00
Add GameScriptItemInfo class. This is the first pass at wrapping an ITEM_INFO in a struct and handing it over to Lua. Many improvements should follow - this is more of a test implementation.
2021-06-28 18:23:26 +01:00
static void Register(sol::state *);
Add m_initialised to GameScriptItemInfo. This is possibly temporary, and controls whether SetRoom calls ItemNewRoom or just sets the room number. This is because ItemNewRoom relies on InitialiseItem having been called, but InitialiseItem requires the roomNumber of the object to be correct. Add and document GetLara.
2021-07-20 00:10:00 +01:00
Add GameScriptItemInfo::«Set/Get»ObjectID and GameScriptItemInfo::SetNameCallbacks. Add calls to the callbacks to GameScriptItemInfo::SetName, so that giving a Lua name to an object removes its existing object and any other object currently using the new name, before then putting the name into the map. Add initial documentation for the Lua-exported parts.
2021-07-17 23:46:09 +01:00
static void SetNameCallbacks(callbackSetName, callbackRemoveName);
GAME_OBJECT_ID GetObjectID() const;
void SetObjectID(GAME_OBJECT_ID id);
Add and register "name" getter and setter for the string ID of an item.
2021-07-05 18:19:10 +01:00
std::string GetName() const;
void SetName(std::string const &);
Add GameScriptItemInfo::«Set/Get»ObjectID and GameScriptItemInfo::SetNameCallbacks. Add calls to the callbacks to GameScriptItemInfo::SetName, so that giving a Lua name to an object removes its existing object and any other object currently using the new name, before then putting the name into the map. Add initial documentation for the Lua-exported parts.
2021-07-17 23:46:09 +01:00
Add CreateEmpty, so that new can be called on the Lua side with no args. Change pos and rot from arrays to GameScript[Position/Rotation]. Add getters and setters for the members used so far. Add Init, which for now is needed to get an item working properly.
2021-06-30 14:08:12 +01:00
GameScriptPosition GetPos() const;
Add GameScriptItemInfo::«Set/Get»ObjectID and GameScriptItemInfo::SetNameCallbacks. Add calls to the callbacks to GameScriptItemInfo::SetName, so that giving a Lua name to an object removes its existing object and any other object currently using the new name, before then putting the name into the map. Add initial documentation for the Lua-exported parts.
2021-07-17 23:46:09 +01:00
void SetPos(GameScriptPosition const& pos);
Add CreateEmpty, so that new can be called on the Lua side with no args. Change pos and rot from arrays to GameScript[Position/Rotation]. Add getters and setters for the members used so far. Add Init, which for now is needed to get an item working properly.
2021-06-30 14:08:12 +01:00
GameScriptRotation GetRot() const;
Add GameScriptItemInfo::«Set/Get»ObjectID and GameScriptItemInfo::SetNameCallbacks. Add calls to the callbacks to GameScriptItemInfo::SetName, so that giving a Lua name to an object removes its existing object and any other object currently using the new name, before then putting the name into the map. Add initial documentation for the Lua-exported parts.
2021-07-17 23:46:09 +01:00
void SetRot(GameScriptRotation const& rot);
Rename «Current/Goal/Required»Anim to «Current/Goal/Required»AnimState.
2021-07-18 15:29:40 +01:00
short GetCurrentAnimState() const;
void SetCurrentAnimState(short animState);
Add GameScriptItemInfo::«Set/Get»ObjectID and GameScriptItemInfo::SetNameCallbacks. Add calls to the callbacks to GameScriptItemInfo::SetName, so that giving a Lua name to an object removes its existing object and any other object currently using the new name, before then putting the name into the map. Add initial documentation for the Lua-exported parts.
2021-07-17 23:46:09 +01:00
Add SetAnimNumber, GetAnimNumber, SetFrameNumber and GetFrameNumber. Fix SetGoalAnimState call.
2021-07-18 17:37:39 +01:00
short GetAnimNumber() const;
void SetAnimNumber(short animNumber);
short GetFrameNumber() const;
void SetFrameNumber(short frameNumber);
Rename «Current/Goal/Required»Anim to «Current/Goal/Required»AnimState.
2021-07-18 15:29:40 +01:00
short GetRequiredAnimState() const;
void SetRequiredAnimState(short animState);
Add GameScriptItemInfo::«Set/Get»ObjectID and GameScriptItemInfo::SetNameCallbacks. Add calls to the callbacks to GameScriptItemInfo::SetName, so that giving a Lua name to an object removes its existing object and any other object currently using the new name, before then putting the name into the map. Add initial documentation for the Lua-exported parts.
2021-07-17 23:46:09 +01:00
Rename «Current/Goal/Required»Anim to «Current/Goal/Required»AnimState.
2021-07-18 15:29:40 +01:00
short GetGoalAnimState() const;
void SetGoalAnimState(short animState);
Add GameScriptItemInfo::«Set/Get»ObjectID and GameScriptItemInfo::SetNameCallbacks. Add calls to the callbacks to GameScriptItemInfo::SetName, so that giving a Lua name to an object removes its existing object and any other object currently using the new name, before then putting the name into the map. Add initial documentation for the Lua-exported parts.
2021-07-17 23:46:09 +01:00
Add CreateEmpty, so that new can be called on the Lua side with no args. Change pos and rot from arrays to GameScript[Position/Rotation]. Add getters and setters for the members used so far. Add Init, which for now is needed to get an item working properly.
2021-06-30 14:08:12 +01:00
short GetHP() const;
Add GameScriptItemInfo::«Set/Get»ObjectID and GameScriptItemInfo::SetNameCallbacks. Add calls to the callbacks to GameScriptItemInfo::SetName, so that giving a Lua name to an object removes its existing object and any other object currently using the new name, before then putting the name into the map. Add initial documentation for the Lua-exported parts.
2021-07-17 23:46:09 +01:00
void SetHP(short hp);
Add CreateEmpty, so that new can be called on the Lua side with no args. Change pos and rot from arrays to GameScript[Position/Rotation]. Add getters and setters for the members used so far. Add Init, which for now is needed to get an item working properly.
2021-06-30 14:08:12 +01:00
short GetOCB() const;
Add GameScriptItemInfo::«Set/Get»ObjectID and GameScriptItemInfo::SetNameCallbacks. Add calls to the callbacks to GameScriptItemInfo::SetName, so that giving a Lua name to an object removes its existing object and any other object currently using the new name, before then putting the name into the map. Add initial documentation for the Lua-exported parts.
2021-07-17 23:46:09 +01:00
void SetOCB(short ocb);
Add CreateEmpty, so that new can be called on the Lua side with no args. Change pos and rot from arrays to GameScript[Position/Rotation]. Add getters and setters for the members used so far. Add Init, which for now is needed to get an item working properly.
2021-06-30 14:08:12 +01:00
sol::as_table_t<std::array<short, 8>> GetItemFlags() const;
Add GameScriptItemInfo::«Set/Get»ObjectID and GameScriptItemInfo::SetNameCallbacks. Add calls to the callbacks to GameScriptItemInfo::SetName, so that giving a Lua name to an object removes its existing object and any other object currently using the new name, before then putting the name into the map. Add initial documentation for the Lua-exported parts.
2021-07-17 23:46:09 +01:00
void SetItemFlags(sol::as_table_t<std::array<short, 8>> const & arr);
Add CreateEmpty, so that new can be called on the Lua side with no args. Change pos and rot from arrays to GameScript[Position/Rotation]. Add getters and setters for the members used so far. Add Init, which for now is needed to get an item working properly.
2021-06-30 14:08:12 +01:00
byte GetAIBits() const;
Add GameScriptItemInfo::«Set/Get»ObjectID and GameScriptItemInfo::SetNameCallbacks. Add calls to the callbacks to GameScriptItemInfo::SetName, so that giving a Lua name to an object removes its existing object and any other object currently using the new name, before then putting the name into the map. Add initial documentation for the Lua-exported parts.
2021-07-17 23:46:09 +01:00
void SetAIBits(byte bits);
Add CreateEmpty, so that new can be called on the Lua side with no args. Change pos and rot from arrays to GameScript[Position/Rotation]. Add getters and setters for the members used so far. Add Init, which for now is needed to get an item working properly.
2021-06-30 14:08:12 +01:00
short GetStatus() const;
Add GameScriptItemInfo::«Set/Get»ObjectID and GameScriptItemInfo::SetNameCallbacks. Add calls to the callbacks to GameScriptItemInfo::SetName, so that giving a Lua name to an object removes its existing object and any other object currently using the new name, before then putting the name into the map. Add initial documentation for the Lua-exported parts.
2021-07-17 23:46:09 +01:00
void SetStatus(short status);
Add CreateEmpty, so that new can be called on the Lua side with no args. Change pos and rot from arrays to GameScript[Position/Rotation]. Add getters and setters for the members used so far. Add Init, which for now is needed to get an item working properly.
2021-06-30 14:08:12 +01:00
bool GetHitStatus() const;
Add GameScriptItemInfo::«Set/Get»ObjectID and GameScriptItemInfo::SetNameCallbacks. Add calls to the callbacks to GameScriptItemInfo::SetName, so that giving a Lua name to an object removes its existing object and any other object currently using the new name, before then putting the name into the map. Add initial documentation for the Lua-exported parts.
2021-07-17 23:46:09 +01:00
void SetHitStatus(bool status);
Add CreateEmpty, so that new can be called on the Lua side with no args. Change pos and rot from arrays to GameScript[Position/Rotation]. Add getters and setters for the members used so far. Add Init, which for now is needed to get an item working properly.
2021-06-30 14:08:12 +01:00
bool GetActive() const;
Add GameScriptItemInfo::«Set/Get»ObjectID and GameScriptItemInfo::SetNameCallbacks. Add calls to the callbacks to GameScriptItemInfo::SetName, so that giving a Lua name to an object removes its existing object and any other object currently using the new name, before then putting the name into the map. Add initial documentation for the Lua-exported parts.
2021-07-17 23:46:09 +01:00
void SetActive(bool active);
Merge GameScriptInfo into GameScriptItemInfo. Add move constructor. Make functions use item ptr directly.
2021-07-01 19:27:57 +01:00
short GetRoom() const;
Add GameScriptItemInfo::«Set/Get»ObjectID and GameScriptItemInfo::SetNameCallbacks. Add calls to the callbacks to GameScriptItemInfo::SetName, so that giving a Lua name to an object removes its existing object and any other object currently using the new name, before then putting the name into the map. Add initial documentation for the Lua-exported parts.
2021-07-17 23:46:09 +01:00
void SetRoom(short Room);
Merge GameScriptInfo into GameScriptItemInfo. Add move constructor. Make functions use item ptr directly.
2021-07-01 19:27:57 +01:00
void EnableItem();
Add GameScriptItemInfo::«Set/Get»ObjectID and GameScriptItemInfo::SetNameCallbacks. Add calls to the callbacks to GameScriptItemInfo::SetName, so that giving a Lua name to an object removes its existing object and any other object currently using the new name, before then putting the name into the map. Add initial documentation for the Lua-exported parts.
2021-07-17 23:46:09 +01:00
Merge GameScriptInfo into GameScriptItemInfo. Add move constructor. Make functions use item ptr directly.
2021-07-01 19:27:57 +01:00
void DisableItem();
Add CreateEmpty, so that new can be called on the Lua side with no args. Change pos and rot from arrays to GameScript[Position/Rotation]. Add getters and setters for the members used so far. Add Init, which for now is needed to get an item working properly.
2021-06-30 14:08:12 +01:00
void Init();
Add concept of 'temporary' ItemInfo instances. These instances will kill the ITEM_INFO they reference when they are destroyed. This was previously the default behaviour. However, now that we're using things like GetItemByName, it makes more sense for ItemInfos to be non-owning by default. Move LDoc from GameScriptItemInfo.h to GameScriptItemInfo.cpp. This might seem counter-intuitive, but LDoc is concerned with the Lua interfaces rather than the actual C++ functions; since the Lua interfaces are defined in GameScriptItemInfo::Register, it makes more sense for the comments to be nearby.
2021-07-20 17:18:39 +01:00
private:
ITEM_INFO* m_item;
short m_num;
bool m_initialised;
bool m_temporary;
static callbackSetName s_callbackSetName;
static callbackRemoveName s_callbackRemoveName;
Add GameScriptItemInfo class. This is the first pass at wrapping an ITEM_INFO in a struct and handing it over to Lua. Many improvements should follow - this is more of a test implementation.
2021-06-28 18:23:26 +01:00
};
Reference in a new issue Copy permalink