mirror of
https://github.com/TES3MP/openmw-tes3mp.git
synced 2025-11-04 03:56:42 +00:00
75 lines
2.5 KiB
C++
75 lines
2.5 KiB
C++
#ifndef OPENMW_BOOKAPI_HPP
|
|
#define OPENMW_BOOKAPI_HPP
|
|
|
|
#define BOOKAPI \
|
|
{"ClearBookChanges", BookFunctions::ClearBookChanges},\
|
|
\
|
|
{"GetBookChangesSize", BookFunctions::GetBookChangesSize},\
|
|
\
|
|
{"AddBook", BookFunctions::AddBook},\
|
|
\
|
|
{"GetBookId", BookFunctions::GetBookId},\
|
|
\
|
|
{"SendBookChanges", BookFunctions::SendBookChanges},\
|
|
\
|
|
{"InitializeBookChanges", BookFunctions::InitializeBookChanges}
|
|
|
|
class BookFunctions
|
|
{
|
|
public:
|
|
|
|
/**
|
|
* \brief Clear the last recorded book changes for a player.
|
|
*
|
|
* This is used to initialize the sending of new PlayerBook packets.
|
|
*
|
|
* \param pid The player ID whose book changes should be used.
|
|
* \return void
|
|
*/
|
|
static void ClearBookChanges(unsigned short pid) noexcept;
|
|
|
|
/**
|
|
* \brief Get the number of indexes in a player's latest book changes.
|
|
*
|
|
* \param pid The player ID whose book changes should be used.
|
|
* \return The number of indexes.
|
|
*/
|
|
static unsigned int GetBookChangesSize(unsigned short pid) noexcept;
|
|
|
|
/**
|
|
* \brief Add a new book to the book changes for a player.
|
|
*
|
|
* \param pid The player ID whose book changes should be used.
|
|
* \param bookId The bookId of the book.
|
|
* \return void
|
|
*/
|
|
static void AddBook(unsigned short pid, const char* bookId) noexcept;
|
|
|
|
/**
|
|
* \brief Get the bookId at a certain index in a player's latest book changes.
|
|
*
|
|
* \param pid The player ID whose book changes should be used.
|
|
* \param index The index of the book.
|
|
* \return The bookId.
|
|
*/
|
|
static const char *GetBookId(unsigned short pid, unsigned int index) noexcept;
|
|
|
|
/**
|
|
* \brief Send a PlayerBook packet with a player's recorded book changes.
|
|
*
|
|
* \param pid The player ID whose book changes should be used.
|
|
* \param sendToOtherPlayers Whether this packet should be sent to players other than the
|
|
* player attached to the packet (false by default).
|
|
* \param skipAttachedPlayer Whether the packet should skip being sent to the player attached
|
|
* to the packet (false by default).
|
|
* \return void
|
|
*/
|
|
static void SendBookChanges(unsigned short pid, bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept;
|
|
|
|
// All methods below are deprecated versions of methods from above
|
|
|
|
static void InitializeBookChanges(unsigned short pid) noexcept;
|
|
|
|
};
|
|
|
|
#endif //OPENMW_BOOKAPI_HPP
|