You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
97 lines
3.4 KiB
C++
97 lines
3.4 KiB
C++
#ifndef OPENMW_SPELLAPI_HPP
|
|
#define OPENMW_SPELLAPI_HPP
|
|
|
|
#define SPELLAPI \
|
|
{"ClearSpellbookChanges", SpellFunctions::ClearSpellbookChanges},\
|
|
\
|
|
{"GetSpellbookChangesSize", SpellFunctions::GetSpellbookChangesSize},\
|
|
{"GetSpellbookChangesAction", SpellFunctions::GetSpellbookChangesAction},\
|
|
\
|
|
{"SetSpellbookChangesAction", SpellFunctions::SetSpellbookChangesAction},\
|
|
{"AddSpell", SpellFunctions::AddSpell},\
|
|
\
|
|
{"GetSpellId", SpellFunctions::GetSpellId},\
|
|
\
|
|
{"SendSpellbookChanges", SpellFunctions::SendSpellbookChanges},\
|
|
\
|
|
{"InitializeSpellbookChanges", SpellFunctions::InitializeSpellbookChanges}
|
|
|
|
class SpellFunctions
|
|
{
|
|
public:
|
|
|
|
/**
|
|
* \brief Clear the last recorded spellbook changes for a player.
|
|
*
|
|
* This is used to initialize the sending of new PlayerSpellbook packets.
|
|
*
|
|
* \param pid The player ID whose spellbook changes should be used.
|
|
* \return void
|
|
*/
|
|
static void ClearSpellbookChanges(unsigned short pid) noexcept;
|
|
|
|
/**
|
|
* \brief Get the number of indexes in a player's latest spellbook changes.
|
|
*
|
|
* \param pid The player ID whose spellbook changes should be used.
|
|
* \return The number of indexes.
|
|
*/
|
|
static unsigned int GetSpellbookChangesSize(unsigned short pid) noexcept;
|
|
|
|
/**
|
|
* \brief Get the action type used in a player's latest spellbook changes.
|
|
*
|
|
* \param pid The player ID whose spellbook changes should be used.
|
|
* \return The action type (0 for SET, 1 for ADD, 2 for REMOVE).
|
|
*/
|
|
static unsigned int GetSpellbookChangesAction(unsigned short pid) noexcept;
|
|
|
|
/**
|
|
* \brief Set the action type in a player's spellbook changes.
|
|
*
|
|
* \param pid The player ID whose spellbook changes should be used.
|
|
* \param action The action (0 for SET, 1 for ADD, 2 for REMOVE).
|
|
* \return void
|
|
*/
|
|
static void SetSpellbookChangesAction(unsigned short pid, unsigned char action) noexcept;
|
|
|
|
/**
|
|
* \brief Add a new spell to the spellbook changes for a player.
|
|
*
|
|
* \param pid The player ID whose spellbook changes should be used.
|
|
* \param spellId The spellId of the spell.
|
|
* \return void
|
|
*/
|
|
static void AddSpell(unsigned short pid, const char* spellId) noexcept;
|
|
|
|
/**
|
|
* \brief Get the spellId at a certain index in a player's latest spellbook changes.
|
|
*
|
|
* \param pid The player ID whose spellbook changes should be used.
|
|
* \param index The index of the spell.
|
|
* \return The spellId.
|
|
*/
|
|
static const char *GetSpellId(unsigned short pid, unsigned int index) noexcept;
|
|
|
|
/**
|
|
* \brief Send a PlayerSpellbook packet with a player's recorded spellbook changes.
|
|
*
|
|
* \param pid The player ID whose spellbook 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 SendSpellbookChanges(unsigned short pid, bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept;
|
|
|
|
// All methods below are deprecated versions of methods from above
|
|
|
|
static void InitializeSpellbookChanges(unsigned short pid) noexcept;
|
|
|
|
private:
|
|
|
|
};
|
|
|
|
#endif //OPENMW_SPELLAPI_HPP
|