#ifndef OPENMW_OBJECTAPI_HPP #define OPENMW_OBJECTAPI_HPP #define OBJECTAPI \ {"ReadLastObjectList", ObjectFunctions::ReadLastObjectList},\ {"InitializeObjectList", ObjectFunctions::InitializeObjectList},\ \ {"GetObjectChangesSize", ObjectFunctions::GetObjectChangesSize},\ {"GetObjectListAction", ObjectFunctions::GetObjectListAction},\ {"GetObjectListContainerSubAction", ObjectFunctions::GetObjectListContainerSubAction},\ \ {"GetObjectRefId", ObjectFunctions::GetObjectRefId},\ {"GetObjectRefNumIndex", ObjectFunctions::GetObjectRefNumIndex},\ {"GetObjectMpNum", ObjectFunctions::GetObjectMpNum},\ {"GetObjectCount", ObjectFunctions::GetObjectCount},\ {"GetObjectCharge", ObjectFunctions::GetObjectCharge},\ {"GetObjectEnchantmentCharge", ObjectFunctions::GetObjectEnchantmentCharge},\ {"GetObjectGoldValue", ObjectFunctions::GetObjectGoldValue},\ {"GetObjectScale", ObjectFunctions::GetObjectScale},\ {"GetObjectState", ObjectFunctions::GetObjectState},\ {"GetObjectDoorState", ObjectFunctions::GetObjectDoorState},\ {"GetObjectLockLevel", ObjectFunctions::GetObjectLockLevel},\ {"GetObjectPosX", ObjectFunctions::GetObjectPosX},\ {"GetObjectPosY", ObjectFunctions::GetObjectPosY},\ {"GetObjectPosZ", ObjectFunctions::GetObjectPosZ},\ {"GetObjectRotX", ObjectFunctions::GetObjectRotX},\ {"GetObjectRotY", ObjectFunctions::GetObjectRotY},\ {"GetObjectRotZ", ObjectFunctions::GetObjectRotZ},\ \ {"GetContainerChangesSize", ObjectFunctions::GetContainerChangesSize},\ {"GetContainerItemRefId", ObjectFunctions::GetContainerItemRefId},\ {"GetContainerItemCount", ObjectFunctions::GetContainerItemCount},\ {"GetContainerItemCharge", ObjectFunctions::GetContainerItemCharge},\ {"GetContainerItemEnchantmentCharge", ObjectFunctions::GetContainerItemEnchantmentCharge},\ {"GetContainerItemActionCount", ObjectFunctions::GetContainerItemActionCount},\ \ {"SetObjectListCell", ObjectFunctions::SetObjectListCell},\ {"SetObjectListAction", ObjectFunctions::SetObjectListAction},\ {"SetObjectListConsoleCommand", ObjectFunctions::SetObjectListConsoleCommand},\ \ {"SetObjectRefId", ObjectFunctions::SetObjectRefId},\ {"SetObjectRefNumIndex", ObjectFunctions::SetObjectRefNumIndex},\ {"SetObjectMpNum", ObjectFunctions::SetObjectMpNum},\ {"SetObjectCount", ObjectFunctions::SetObjectCount},\ {"SetObjectCharge", ObjectFunctions::SetObjectCharge},\ {"SetObjectEnchantmentCharge", ObjectFunctions::SetObjectEnchantmentCharge},\ {"SetObjectGoldValue", ObjectFunctions::SetObjectGoldValue},\ {"SetObjectScale", ObjectFunctions::SetObjectScale},\ {"SetObjectState", ObjectFunctions::SetObjectState},\ {"SetObjectLockLevel", ObjectFunctions::SetObjectLockLevel},\ {"SetObjectDisarmState", ObjectFunctions::SetObjectDisarmState},\ {"SetObjectMasterState", ObjectFunctions::SetObjectMasterState},\ {"SetObjectPosition", ObjectFunctions::SetObjectPosition},\ {"SetObjectRotation", ObjectFunctions::SetObjectRotation},\ \ {"SetObjectDoorState", ObjectFunctions::SetObjectDoorState},\ {"SetObjectDoorTeleportState", ObjectFunctions::SetObjectDoorTeleportState},\ {"SetObjectDoorDestinationCell", ObjectFunctions::SetObjectDoorDestinationCell},\ {"SetObjectDoorDestinationPosition", ObjectFunctions::SetObjectDoorDestinationPosition},\ {"SetObjectDoorDestinationRotation", ObjectFunctions::SetObjectDoorDestinationRotation},\ \ {"SetPlayerAsObject", ObjectFunctions::SetPlayerAsObject},\ \ {"SetContainerItemRefId", ObjectFunctions::SetContainerItemRefId},\ {"SetContainerItemCount", ObjectFunctions::SetContainerItemCount},\ {"SetContainerItemCharge", ObjectFunctions::SetContainerItemCharge},\ {"SetContainerItemEnchantmentCharge", ObjectFunctions::SetContainerItemEnchantmentCharge},\ \ {"SetReceivedContainerItemActionCount", ObjectFunctions::SetReceivedContainerItemActionCount},\ \ {"AddObject", ObjectFunctions::AddObject},\ {"AddContainerItem", ObjectFunctions::AddContainerItem},\ \ {"SendObjectPlace", ObjectFunctions::SendObjectPlace},\ {"SendObjectSpawn", ObjectFunctions::SendObjectSpawn},\ {"SendObjectDelete", ObjectFunctions::SendObjectDelete},\ {"SendObjectLock", ObjectFunctions::SendObjectLock},\ {"SendObjectTrap", ObjectFunctions::SendObjectTrap},\ {"SendObjectScale", ObjectFunctions::SendObjectScale},\ {"SendObjectState", ObjectFunctions::SendObjectState},\ {"SendDoorState", ObjectFunctions::SendDoorState},\ {"SendDoorDestination", ObjectFunctions::SendDoorDestination},\ {"SendContainer", ObjectFunctions::SendContainer},\ {"SendConsoleCommand", ObjectFunctions::SendConsoleCommand},\ \ {"ReadLastEvent", ObjectFunctions::ReadLastEvent},\ {"InitializeEvent", ObjectFunctions::InitializeEvent},\ {"GetEventAction", ObjectFunctions::GetEventAction},\ {"GetEventContainerSubAction", ObjectFunctions::GetEventContainerSubAction},\ {"SetEventCell", ObjectFunctions::SetEventCell},\ {"SetEventAction", ObjectFunctions::SetEventAction},\ {"SetEventConsoleCommand", ObjectFunctions::SetEventConsoleCommand},\ {"AddWorldObject", ObjectFunctions::AddWorldObject} class ObjectFunctions { public: /** * \brief Use the last object list received by the server as the one being read. * * \return void */ static void ReadLastObjectList() noexcept; /** * \brief Clear the data from the last object list sent by the server. * * This is used to initialize the sending of new Object packets. * * \param pid The player ID to whom the object list should be attached. * \return void */ static void InitializeObjectList(unsigned short pid) noexcept; /** * \brief Get the number of indexes in the read object list's object changes. * * \return The number of indexes. */ static unsigned int GetObjectChangesSize() noexcept; /** * \brief Get the action type used in the read object list. * * \return The action type (0 for SET, 1 for ADD, 2 for REMOVE, 3 for REQUEST). */ static unsigned char GetObjectListAction() noexcept; /** * \brief Get the container subaction type used in the read object list. * * \return The action type (0 for NONE, 1 for DRAG, 2 for DROP, 3 for TAKE_ALL). */ static unsigned char GetObjectListContainerSubAction() noexcept; /** * \brief Get the refId of the object at a certain index in the read object list's object changes. * * \return The refId. */ static const char *GetObjectRefId(unsigned int i) noexcept; /** * \brief Get the refNumIndex of the object at a certain index in the read object list's object * changes. * * \param i The index of the object. * \return The refNumIndex. */ static int GetObjectRefNumIndex(unsigned int i) noexcept; /** * \brief Get the mpNum of the object at a certain index in the read object list's object changes. * * \param i The index of the object. * \return The mpNum. */ static int GetObjectMpNum(unsigned int i) noexcept; /** * \brief Get the count of the object at a certain index in the read object list's object changes. * * \param i The index of the object. * \return The object count. */ static int GetObjectCount(unsigned int i) noexcept; /** * \brief Get the charge of the object at a certain index in the read object list's object changes. * * \param i The index of the object. * \return The charge. */ static int GetObjectCharge(unsigned int i) noexcept; /** * \brief Get the enchantment charge of the object at a certain index in the read object list's object changes. * * \param i The index of the object. * \return The enchantment charge. */ static double GetObjectEnchantmentCharge(unsigned int i) noexcept; /** * \brief Get the gold value of the object at a certain index in the read object list's object * changes. * * This is used solely to get the gold value of gold. It is not used for other objects. * * \param i The index of the object. * \return The gold value. */ static int GetObjectGoldValue(unsigned int i) noexcept; /** * \brief Get the object scale of the object at a certain index in the read object list's object * changes. * * \param i The index of the object. * \return The object scale. */ static double GetObjectScale(unsigned int i) noexcept; /** * \brief Get the object state of the object at a certain index in the read object list's object * changes. * * \param i The index of the object. * \return The object state. */ static bool GetObjectState(unsigned int i) noexcept; /** * \brief Get the door state of the object at a certain index in the read object list's object * changes. * * \param i The index of the object. * \return The door state. */ static int GetObjectDoorState(unsigned int i) noexcept; /** * \brief Get the lock level of the object at a certain index in the read object list's object * changes. * * \param i The index of the object. * \return The lock level. */ static int GetObjectLockLevel(unsigned int i) noexcept; /** * \brief Get the X position of the object at a certain index in the read object list's object * changes. * * \param i The index of the object. * \return The X position. */ static double GetObjectPosX(unsigned int i) noexcept; /** * \brief Get the Y position of the object at a certain index in the read object list's object * changes. * * \param i The index of the object. * \return The Y position. */ static double GetObjectPosY(unsigned int i) noexcept; /** * \brief Get the Z position at a certain index in the read object list's object changes. * * \param i The index of the object. * \return The Z position. */ static double GetObjectPosZ(unsigned int i) noexcept; /** * \brief Get the X rotation of the object at a certain index in the read object list's object * changes. * * \param i The index of the object. * \return The X rotation. */ static double GetObjectRotX(unsigned int i) noexcept; /** * \brief Get the Y rotation of the object at a certain index in the read object list's object * changes. * * \param i The index of the object. * \return The Y rotation. */ static double GetObjectRotY(unsigned int i) noexcept; /** * \brief Get the Z rotation of the object at a certain index in the read object list's object * changes. * * \param i The index of the object. * \return The Z rotation. */ static double GetObjectRotZ(unsigned int i) noexcept; /** * \brief Get the number of container item indexes of the object at a certain index in the * read object list's object changes. * * \param i The index of the object. * \return The number of container item indexes. */ static unsigned int GetContainerChangesSize(unsigned int objectIndex) noexcept; /** * \brief Get the refId of the container item at a certain itemIndex in the container changes * of the object at a certain objectIndex in the read object list's object changes. * * \param objectIndex The index of the object. * \param itemIndex The index of the container item. * \return The refId. */ static const char *GetContainerItemRefId(unsigned int objectIndex, unsigned int itemIndex) noexcept; /** * \brief Get the item count of the container item at a certain itemIndex in the container * changes of the object at a certain objectIndex in the read object list's object changes. * * \param objectIndex The index of the object. * \param itemIndex The index of the container item. * \return The item count. */ static int GetContainerItemCount(unsigned int objectIndex, unsigned int itemIndex) noexcept; /** * \brief Get the charge of the container item at a certain itemIndex in the container changes * of the object at a certain objectIndex in the read object list's object changes. * * \param objectIndex The index of the object. * \param itemIndex The index of the container item. * \return The charge. */ static int GetContainerItemCharge(unsigned int objectIndex, unsigned int itemIndex) noexcept; /** * \brief Get the enchantment charge of the container item at a certain itemIndex in the container changes * of the object at a certain objectIndex in the read object list's object changes. * * \param objectIndex The index of the object. * \param itemIndex The index of the container item. * \return The enchantment charge. */ static double GetContainerItemEnchantmentCharge(unsigned int objectIndex, unsigned int itemIndex) noexcept; /** * \brief Get the action count of the container item at a certain itemIndex in the container * changes of the object at a certain objectIndex in the read object list's object changes. * * \param objectIndex The index of the object. * \param itemIndex The index of the container item. * \return The action count. */ static int GetContainerItemActionCount(unsigned int objectIndex, unsigned int itemIndex) noexcept; /** * \brief Set the cell of the temporary object list stored on the server. * * The cell is determined to be an exterior cell if it fits the pattern of a number followed * by a comma followed by another number. * * \param cellDescription The description of the cell. * \return void */ static void SetObjectListCell(const char* cellDescription) noexcept; /** * \brief Set the action type of the temporary object list stored on the server. * * \param action The action type (0 for SET, 1 for ADD, 2 for REMOVE, 3 for REQUEST). * \return void */ static void SetObjectListAction(unsigned char action) noexcept; /** * \brief Set the console command of the temporary object list stored on the server. * * When sent, the command will run once on every object added to the object list. If no objects * have been added, it will run once without any object reference. * * \param consoleCommand The console command. * \return void */ static void SetObjectListConsoleCommand(const char* consoleCommand) noexcept; /** * \brief Set the refId of the temporary object stored on the server. * * \param refId The refId. * \return void */ static void SetObjectRefId(const char* refId) noexcept; /** * \brief Set the refNumIndex of the temporary object stored on the server. * * Every object loaded from .ESM and .ESP data files has a unique refNumIndex which needs to be * retained to refer to it in packets. * * On the other hand, objects placed or spawned via the server should always have a refNumIndex * of 0. * * \param refNumIndex The refNumIndex. * \return void */ static void SetObjectRefNumIndex(int refNumIndex) noexcept; /** * \brief Set the mpNum of the temporary object stored on the server. * * Every object placed or spawned via the server is assigned an mpNum by incrementing the last * mpNum stored on the server. Scripts should take care to ensure that mpNums are kept unique * for these objects. * * Objects loaded from .ESM and .ESP data files should always have an mpNum of 0, because they * have unique refNumIndexes instead. * * \param mpNum The mpNum. * \return void */ static void SetObjectMpNum(int mpNum) noexcept; /** * \brief Set the object count of the temporary object stored on the server. * * This determines the quantity of an object, with the exception of gold. * * \param count The object count. * \return void */ static void SetObjectCount(int count) noexcept; /** * \brief Set the charge of the temporary object stored on the server. * * Object durabilities are set through this value. * * \param charge The charge. * \return void */ static void SetObjectCharge(int charge) noexcept; /** * \brief Set the enchantment charge of the temporary object stored on the server. * * Object durabilities are set through this value. * * \param charge The enchantment charge. * \return void */ static void SetObjectEnchantmentCharge(double enchantmentCharge) noexcept; /** * \brief Set the gold value of the temporary object stored on the server. * * This is used solely to set the gold value for gold. It has no effect on other objects. * * \param goldValue The gold value. * \return void */ static void SetObjectGoldValue(int goldValue) noexcept; /** * \brief Set the scale of the temporary object stored on the server. * * Objects are smaller or larger than their default size based on their scale. * * \param scale The scale. * \return void */ static void SetObjectScale(double scale) noexcept; /** * \brief Set the object state of the temporary object stored on the server. * * Objects are enabled or disabled based on their object state. * * \param objectState The object state. * \return void */ static void SetObjectState(bool objectState) noexcept; /** * \brief Set the lock level of the temporary object stored on the server. * * \param lockLevel The lock level. * \return void */ static void SetObjectLockLevel(int lockLevel) noexcept; /** * \brief Set the disarm state of the temporary object stored on the server. * * \param disarmState The disarmState. * \return void */ static void SetObjectDisarmState(bool disarmState) noexcept; /** * \brief Set the master state of the temporary object stored on the server. * * This only affects living actors and determines whether they are followers of another * living actor. * * \param masterState The master state. * \return void */ static void SetObjectMasterState(bool masterState) noexcept; /** * \brief Set the position of the temporary object stored on the server. * * \param x The X position. * \param y The Y position. * \param z The Z position. * \return void */ static void SetObjectPosition(double x, double y, double z) noexcept; /** * \brief Set the rotation of the temporary object stored on the server. * * \param x The X rotation. * \param y The Y rotation. * \param z The Z rotation. * \return void */ static void SetObjectRotation(double x, double y, double z) noexcept; /** * \brief Set the door state of the temporary object stored on the server. * * Doors are open or closed based on their door state. * * \param doorState The door state. * \return void */ static void SetObjectDoorState(int doorState) noexcept; /** * \brief Set the teleport state of the temporary object stored on the server. * * If a door's teleport state is true, interacting with the door teleports a player to its * destination. If it's false, it opens and closes like a regular door. * * \param teleportState The teleport state. * \return void */ static void SetObjectDoorTeleportState(bool teleportState) noexcept; /** * \brief Set the door destination cell of the temporary object stored on the server. * * The cell is determined to be an exterior cell if it fits the pattern of a number followed * by a comma followed by another number. * * \param cellDescription The description of the cell. * \return void */ static void SetObjectDoorDestinationCell(const char* cellDescription) noexcept; /** * \brief Set the door destination position of the temporary object stored on the server. * * \param x The X position. * \param y The Y position. * \param z The Z position. * \return void */ static void SetObjectDoorDestinationPosition(double x, double y, double z) noexcept; /** * \brief Set the door destination rotation of the temporary object stored on the server. * * Note: Because this sets the rotation a player will have upon using the door, and rotation * on the Y axis has no effect on players, the Y value has been omitted as an argument. * * \param x The X rotation. * \param z The Z rotation. * \return void */ static void SetObjectDoorDestinationRotation(double x, double z) noexcept; /** * \brief Set a player as the object in the temporary object stored on the server. * Currently only used for ConsoleCommand packets. * * \param pid The pid of the player. * \return void */ static void SetPlayerAsObject(unsigned short pid) noexcept; /** * \brief Set the refId of the temporary container item stored on the server. * * \param refId The refId. * \return void */ static void SetContainerItemRefId(const char* refId) noexcept; /** * \brief Set the item count of the temporary container item stored on the server. * * \param count The item count. * \return void */ static void SetContainerItemCount(int count) noexcept; /** * \brief Set the charge of the temporary container item stored on the server. * * \param charge The charge. * \return void */ static void SetContainerItemCharge(int charge) noexcept; /** * \brief Set the enchantment charge of the temporary container item stored on the server. * * \param charge The enchantment charge. * \return void */ static void SetContainerItemEnchantmentCharge(double enchantmentCharge) noexcept; /** * \brief Set the action count of the container item at a certain itemIndex in the container * changes of the object at a certain objectIndex in the read object list's object changes. * * When resending a received Container packet, this allows you to correct the amount of items * removed from a container by a player when it conflicts with what other players have already * taken. * * \param objectIndex The index of the object. * \param itemIndex The index of the container item. * \param actionCount The action count. * \return void */ static void SetReceivedContainerItemActionCount(unsigned int objectIndex, unsigned int itemIndex, int actionCount) noexcept; /** * \brief Add a copy of the server's temporary object to the server's temporary object list. * * In the process, the server's temporary object will automatically be cleared so a new * one can be set up. * * \return void */ static void AddObject() noexcept; /** * \brief Add a copy of the server's temporary container item to the container changes of the * server's temporary object. * * In the process, the server's temporary container item will automatically be cleared so a new * one can be set up. * * \return void */ static void AddContainerItem() noexcept; /** * \brief Send an ObjectPlace packet. * * \param broadcast Whether this packet should be sent only to the player for whom the current * object list was initialized or to everyone on the server. * * \return void */ static void SendObjectPlace(bool broadcast = false) noexcept; /** * \brief Send an ObjectSpawn packet. * * \param broadcast Whether this packet should be sent only to the player for whom the current * object list was initialized or to everyone on the server. * * \return void */ static void SendObjectSpawn(bool broadcast = false) noexcept; /** * \brief Send an ObjectDelete packet. * * \param broadcast Whether this packet should be sent only to the player for whom the current * object list was initialized or to everyone on the server. * * \return void */ static void SendObjectDelete(bool broadcast = false) noexcept; /** * \brief Send an ObjectLock packet. * * \param broadcast Whether this packet should be sent only to the player for whom the current * object list was initialized or to everyone on the server. * * \return void */ static void SendObjectLock(bool broadcast = false) noexcept; /** * \brief Send an ObjectTrap packet. * * \param broadcast Whether this packet should be sent only to the player for whom the current * object list was initialized or to everyone on the server. * * \return void */ static void SendObjectTrap(bool broadcast = false) noexcept; /** * \brief Send an ObjectScale packet. * * \param broadcast Whether this packet should be sent only to the player for whom the current * object list was initialized or to everyone on the server. * * \return void */ static void SendObjectScale(bool broadcast = false) noexcept; /** * \brief Send an ObjectState packet. * * \param broadcast Whether this packet should be sent only to the player for whom the current * object list was initialized or to everyone on the server. * * \return void */ static void SendObjectState(bool broadcast = false) noexcept; /** * \brief Send a DoorState packet. * * \param broadcast Whether this packet should be sent only to the player for whom the current * object list was initialized or to everyone on the server. * * \return void */ static void SendDoorState(bool broadcast = false) noexcept; /** * \brief Send a DoorDestination packet. * * \param broadcast Whether this packet should be sent only to the player for whom the current * object list was initialized or to everyone on the server. * * \return void */ static void SendDoorDestination(bool broadcast = false) noexcept; /** * \brief Send a Container packet. * * \param broadcast Whether this packet should be sent only to the player for whom the current * object list was initialized or to everyone on the server. * * \return void */ static void SendContainer(bool broadcast = false, bool useLastReadObjectList = false) noexcept; /** * \brief Send a ConsoleCommand packet. * * \param broadcast Whether this packet should be sent only to the player for whom the current * object list was initialized or to everyone on the server. * * \return void */ static void SendConsoleCommand(bool broadcast = false) noexcept; // All methods below are deprecated versions of methods from above static void ReadLastEvent() noexcept; static void InitializeEvent(unsigned short pid) noexcept; static unsigned char GetEventAction() noexcept; static unsigned char GetEventContainerSubAction() noexcept; static void SetEventCell(const char* cellDescription) noexcept; static void SetEventAction(unsigned char action) noexcept; static void SetEventConsoleCommand(const char* consoleCommand) noexcept; static void AddWorldObject() noexcept; }; #endif //OPENMW_OBJECTAPI_HPP