[General] Implement RecordDynamic packet, part 1
Spell, potion, enchantment, creature, NPC, armor, book, clothing, miscellaneous and weapon record data can now be sent in a RecordDynamic packet. Additionally, the packets include data related to associated magical effects (for spells, potions and enchantments), data related to default inventory contents (for creatures and NPCs) and data related to body parts affected (for armor and clothing). The server now has associated script functions for setting most of the details of the above, with the main exception being individual creature and NPC stats. Records can either be created entirely from scratch or can use an existing record (set via the baseId variable) as a starting point for their values. In the latter case, only the values that are specifically set override the starting values. Creature and NPC records also have an inventoryBaseId that can be used on top of the baseId to base their inventories on another existing record. The client's RecordHelper class has been heavily expanded to allow for the above mentioned functionality. When players create spells, potions and enchantments as part of regular gameplay, they send RecordDynamic packets that provide the server with the complete details of the records that should be created. When they create enchantments, they also provide the server with armor, book, clothing and weapon records corresponding to the items they've enchanted. This functionality added by this packet was originally supposed to be exclusive to the rewrite, but I've gone ahead and tried to provide it for the pre-rewrite in a way that can mostly be reused for the rewrite.pull/471/head
David Cernat
7 years ago
parent
2dbf3893c0
commit
b57807407a
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,880 @@
|
||||
#ifndef OPENMW_RECORDSDYNAMICAPI_HPP
|
||||
#define OPENMW_RECORDSDYNAMICAPI_HPP
|
||||
|
||||
#include "../Types.hpp"
|
||||
|
||||
#define RECORDSDYNAMICAPI \
|
||||
{"ClearRecords", RecordsDynamicFunctions::ClearRecords},\
|
||||
\
|
||||
{"GetRecordType", RecordsDynamicFunctions::GetRecordType},\
|
||||
{"GetRecordCount", RecordsDynamicFunctions::GetRecordCount},\
|
||||
{"GetRecordEffectCount", RecordsDynamicFunctions::GetRecordEffectCount},\
|
||||
\
|
||||
{"GetRecordId", RecordsDynamicFunctions::GetRecordId},\
|
||||
{"GetRecordBaseId", RecordsDynamicFunctions::GetRecordBaseId},\
|
||||
\
|
||||
{"GetRecordSubtype", RecordsDynamicFunctions::GetRecordSubtype},\
|
||||
{"GetRecordName", RecordsDynamicFunctions::GetRecordName},\
|
||||
{"GetRecordModel", RecordsDynamicFunctions::GetRecordModel},\
|
||||
{"GetRecordIcon", RecordsDynamicFunctions::GetRecordIcon},\
|
||||
{"GetRecordScript", RecordsDynamicFunctions::GetRecordScript},\
|
||||
{"GetRecordEnchantmentId", RecordsDynamicFunctions::GetRecordEnchantmentId},\
|
||||
{"GetRecordEnchantmentCharge", RecordsDynamicFunctions::GetRecordEnchantmentCharge},\
|
||||
\
|
||||
{"GetRecordAutoCalc", RecordsDynamicFunctions::GetRecordAutoCalc},\
|
||||
{"GetRecordCharge", RecordsDynamicFunctions::GetRecordCharge},\
|
||||
{"GetRecordCost", RecordsDynamicFunctions::GetRecordCost},\
|
||||
{"GetRecordFlags", RecordsDynamicFunctions::GetRecordFlags},\
|
||||
{"GetRecordValue", RecordsDynamicFunctions::GetRecordValue},\
|
||||
{"GetRecordWeight", RecordsDynamicFunctions::GetRecordWeight},\
|
||||
\
|
||||
{"GetRecordEffectId", RecordsDynamicFunctions::GetRecordEffectId},\
|
||||
{"GetRecordEffectAttribute", RecordsDynamicFunctions::GetRecordEffectAttribute},\
|
||||
{"GetRecordEffectSkill", RecordsDynamicFunctions::GetRecordEffectSkill},\
|
||||
{"GetRecordEffectRangeType", RecordsDynamicFunctions::GetRecordEffectRangeType},\
|
||||
{"GetRecordEffectArea", RecordsDynamicFunctions::GetRecordEffectArea},\
|
||||
{"GetRecordEffectDuration", RecordsDynamicFunctions::GetRecordEffectDuration},\
|
||||
{"GetRecordEffectMagnitudeMax", RecordsDynamicFunctions::GetRecordEffectMagnitudeMax},\
|
||||
{"GetRecordEffectMagnitudeMin", RecordsDynamicFunctions::GetRecordEffectMagnitudeMin},\
|
||||
\
|
||||
{"SetRecordType", RecordsDynamicFunctions::SetRecordType},\
|
||||
\
|
||||
{"SetRecordId", RecordsDynamicFunctions::SetRecordId},\
|
||||
{"SetRecordBaseId", RecordsDynamicFunctions::SetRecordBaseId},\
|
||||
{"SetRecordInventoryBaseId", RecordsDynamicFunctions::SetRecordInventoryBaseId},\
|
||||
\
|
||||
{"SetRecordSubtype", RecordsDynamicFunctions::SetRecordSubtype},\
|
||||
{"SetRecordName", RecordsDynamicFunctions::SetRecordName},\
|
||||
{"SetRecordModel", RecordsDynamicFunctions::SetRecordModel},\
|
||||
{"SetRecordIcon", RecordsDynamicFunctions::SetRecordIcon},\
|
||||
{"SetRecordScript", RecordsDynamicFunctions::SetRecordScript},\
|
||||
{"SetRecordEnchantmentId", RecordsDynamicFunctions::SetRecordEnchantmentId},\
|
||||
{"SetRecordEnchantmentCharge", RecordsDynamicFunctions::SetRecordEnchantmentCharge},\
|
||||
\
|
||||
{"SetRecordAutoCalc", RecordsDynamicFunctions::SetRecordAutoCalc},\
|
||||
{"SetRecordCharge", RecordsDynamicFunctions::SetRecordCharge},\
|
||||
{"SetRecordCost", RecordsDynamicFunctions::SetRecordCost},\
|
||||
{"SetRecordFlags", RecordsDynamicFunctions::SetRecordFlags},\
|
||||
{"SetRecordValue", RecordsDynamicFunctions::SetRecordValue},\
|
||||
{"SetRecordWeight", RecordsDynamicFunctions::SetRecordWeight},\
|
||||
\
|
||||
{"SetRecordArmorRating", RecordsDynamicFunctions::SetRecordArmorRating},\
|
||||
{"SetRecordHealth", RecordsDynamicFunctions::SetRecordHealth},\
|
||||
\
|
||||
{"SetRecordDamageChop", RecordsDynamicFunctions::SetRecordDamageChop},\
|
||||
{"SetRecordDamageSlash", RecordsDynamicFunctions::SetRecordDamageSlash},\
|
||||
{"SetRecordDamageThrust", RecordsDynamicFunctions::SetRecordDamageThrust},\
|
||||
{"SetRecordReach", RecordsDynamicFunctions::SetRecordReach},\
|
||||
{"SetRecordSpeed", RecordsDynamicFunctions::SetRecordSpeed},\
|
||||
\
|
||||
{"SetRecordKeyState", RecordsDynamicFunctions::SetRecordKeyState},\
|
||||
{"SetRecordScrollState", RecordsDynamicFunctions::SetRecordScrollState},\
|
||||
{"SetRecordSkillId", RecordsDynamicFunctions::SetRecordSkillId},\
|
||||
{"SetRecordText", RecordsDynamicFunctions::SetRecordText},\
|
||||
\
|
||||
{"SetRecordHair", RecordsDynamicFunctions::SetRecordHair},\
|
||||
{"SetRecordHead", RecordsDynamicFunctions::SetRecordHead},\
|
||||
{"SetRecordGender", RecordsDynamicFunctions::SetRecordGender},\
|
||||
{"SetRecordRace", RecordsDynamicFunctions::SetRecordRace},\
|
||||
{"SetRecordClass", RecordsDynamicFunctions::SetRecordClass},\
|
||||
{"SetRecordFaction", RecordsDynamicFunctions::SetRecordFaction},\
|
||||
\
|
||||
{"SetRecordLevel", RecordsDynamicFunctions::SetRecordLevel},\
|
||||
\
|
||||
{"SetRecordIdByIndex", RecordsDynamicFunctions::SetRecordIdByIndex},\
|
||||
{"SetRecordEnchantmentIdByIndex", RecordsDynamicFunctions::SetRecordEnchantmentIdByIndex},\
|
||||
\
|
||||
{"SetRecordEffectId", RecordsDynamicFunctions::SetRecordEffectId},\
|
||||
{"SetRecordEffectAttribute", RecordsDynamicFunctions::SetRecordEffectAttribute},\
|
||||
{"SetRecordEffectSkill", RecordsDynamicFunctions::SetRecordEffectSkill},\
|
||||
{"SetRecordEffectRangeType", RecordsDynamicFunctions::SetRecordEffectRangeType},\
|
||||
{"SetRecordEffectArea", RecordsDynamicFunctions::SetRecordEffectArea},\
|
||||
{"SetRecordEffectDuration", RecordsDynamicFunctions::SetRecordEffectDuration},\
|
||||
{"SetRecordEffectMagnitudeMax", RecordsDynamicFunctions::SetRecordEffectMagnitudeMax},\
|
||||
{"SetRecordEffectMagnitudeMin", RecordsDynamicFunctions::SetRecordEffectMagnitudeMin},\
|
||||
\
|
||||
{"SetRecordBodyPartType", RecordsDynamicFunctions::SetRecordBodyPartType},\
|
||||
{"SetRecordBodyPartIdForMale", RecordsDynamicFunctions::SetRecordBodyPartIdForMale},\
|
||||
{"SetRecordBodyPartIdForFemale", RecordsDynamicFunctions::SetRecordBodyPartIdForFemale},\
|
||||
\
|
||||
{"SetRecordInventoryItemId", RecordsDynamicFunctions::SetRecordInventoryItemId},\
|
||||
{"SetRecordInventoryItemCount", RecordsDynamicFunctions::SetRecordInventoryItemCount},\
|
||||
\
|
||||
{"AddRecord", RecordsDynamicFunctions::AddRecord},\
|
||||
{"AddRecordEffect", RecordsDynamicFunctions::AddRecordEffect},\
|
||||
{"AddRecordBodyPart", RecordsDynamicFunctions::AddRecordBodyPart},\
|
||||
{"AddRecordInventoryItem", RecordsDynamicFunctions::AddRecordInventoryItem},\
|
||||
\
|
||||
{"SendRecordDynamic", RecordsDynamicFunctions::SendRecordDynamic}
|
||||
|
||||
class RecordsDynamicFunctions
|
||||
{
|
||||
public:
|
||||
|
||||
/**
|
||||
* \brief Clear the data from the records stored on the server.
|
||||
*
|
||||
* \return void
|
||||
*/
|
||||
static void ClearRecords() noexcept;
|
||||
|
||||
/**
|
||||
* \brief Get the type of records in the read worldstate's dynamic records.
|
||||
*
|
||||
* \return The type of records (0 for SPELL, 1 for POTION, 2 for ENCHANTMENT,
|
||||
* 3 for NPC).
|
||||
*/
|
||||
static unsigned short GetRecordType() noexcept;
|
||||
|
||||
/**
|
||||
* \brief Get the number of records in the read worldstate's dynamic records.
|
||||
*
|
||||
* \return The number of records.
|
||||
*/
|
||||
static unsigned int GetRecordCount() noexcept;
|
||||
|
||||
/**
|
||||
* \brief Get the number of effects for the record at a certain index in the read
|
||||
* worldstate's current records.
|
||||
*
|
||||
* \param recordIndex The index of the record.
|
||||
* \return The number of effects.
|
||||
*/
|
||||
static unsigned int GetRecordEffectCount(unsigned int recordIndex) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Get the id of the record at a certain index in the read worldstate's
|
||||
* dynamic records of the current type.
|
||||
*
|
||||
* \param index The index of the record.
|
||||
* \return The id of the record.
|
||||
*/
|
||||
static const char *GetRecordId(unsigned int index) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Get the base id (i.e. the id this record should inherit default
|
||||
* values from) of the record at a certain index in the read worldstate's
|
||||
* dynamic records of the current type.
|
||||
*
|
||||
* \param index The index of the record.
|
||||
* \return The base id of the record.
|
||||
*/
|
||||
static const char *GetRecordBaseId(unsigned int index) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Get the subtype of the record at a certain index in the read worldstate's
|
||||
* dynamic records of the current type.
|
||||
*
|
||||
* \param index The index of the record.
|
||||
* \return The type of the record.
|
||||
*/
|
||||
static int GetRecordSubtype(unsigned int index) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Get the name of the record at a certain index in the read worldstate's
|
||||
* dynamic records of the current type.
|
||||
*
|
||||
* \param index The index of the record.
|
||||
* \return The name of the record.
|
||||
*/
|
||||
static const char *GetRecordName(unsigned int index) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Get the model of the record at a certain index in the read worldstate's
|
||||
* dynamic records of the current type.
|
||||
*
|
||||
* \param index The index of the record.
|
||||
* \return The model of the record.
|
||||
*/
|
||||
static const char *GetRecordModel(unsigned int index) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Get the icon of the record at a certain index in the read worldstate's
|
||||
* dynamic records of the current type.
|
||||
*
|
||||
* \param index The index of the record.
|
||||
* \return The icon of the record.
|
||||
*/
|
||||
static const char *GetRecordIcon(unsigned int index) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Get the script of the record at a certain index in the read worldstate's
|
||||
* dynamic records of the current type.
|
||||
*
|
||||
* \param index The index of the record.
|
||||
* \return The script of the record.
|
||||
*/
|
||||
static const char *GetRecordScript(unsigned int index) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Get the enchantment id of the record at a certain index in the read
|
||||
* worldstate's dynamic records of the current type.
|
||||
*
|
||||
* \param index The index of the record.
|
||||
* \return The enchantment id of the record.
|
||||
*/
|
||||
static const char *GetRecordEnchantmentId(unsigned int index) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Get the enchantment charge of the record at a certain index in
|
||||
* the read worldstate's dynamic records of the current type.
|
||||
*
|
||||
* \param index The index of the record.
|
||||
* \return The enchantment charge of the record.
|
||||
*/
|
||||
static int GetRecordEnchantmentCharge(unsigned int index) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Get the auto-calculation flag value of the record at a certain index in
|
||||
* the read worldstate's dynamic records of the current type.
|
||||
*
|
||||
* \param index The index of the record.
|
||||
* \return The auto-calculation flag value of the record.
|
||||
*/
|
||||
static int GetRecordAutoCalc(unsigned int index) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Get the charge of the record at a certain index in the read worldstate's
|
||||
* dynamic records of the current type.
|
||||
*
|
||||
* \param index The index of the record.
|
||||
* \return The charge of the record.
|
||||
*/
|
||||
static int GetRecordCharge(unsigned int index) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Get the cost of the record at a certain index in the read worldstate's
|
||||
* dynamic records of the current type.
|
||||
*
|
||||
* \param index The index of the record.
|
||||
* \return The cost of the record.
|
||||
*/
|
||||
static int GetRecordCost(unsigned int index) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Get the flags of the record at a certain index in the read worldstate's
|
||||
* dynamic records of the current type.
|
||||
*
|
||||
* \param index The index of the record.
|
||||
* \return The flags of the spell as an integer.
|
||||
*/
|
||||
static int GetRecordFlags(unsigned int index) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Get the value of the record at a certain index in the read worldstate's
|
||||
* dynamic records of the current type.
|
||||
*
|
||||
* \param index The index of the record.
|
||||
* \return The value of the record.
|
||||
*/
|
||||
static int GetRecordValue(unsigned int index) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Get the weight of the record at a certain index in the read worldstate's
|
||||
* dynamic records of the current type.
|
||||
*
|
||||
* \param index The index of the record.
|
||||
* \return The weight of the record.
|
||||
*/
|
||||
static double GetRecordWeight(unsigned int index) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Get the ID of the effect at a certain index in the read worldstate's
|
||||
* current records.
|
||||
*
|
||||
* \param recordIndex The index of the record.
|
||||
* \param effectIndex The index of the effect.
|
||||
* \return The ID of the effect.
|
||||
*/
|
||||
static unsigned int GetRecordEffectId(unsigned int recordIndex, unsigned int effectIndex) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Get the ID of the attribute modified by the effect at a certain index in the
|
||||
* read worldstate's current records.
|
||||
*
|
||||
* \param recordIndex The index of the record.
|
||||
* \param effectIndex The index of the effect.
|
||||
* \return The attribute ID for the effect.
|
||||
*/
|
||||
static int GetRecordEffectAttribute(unsigned int recordIndex, unsigned int effectIndex) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Get the ID of the skill modified by the effect at a certain index in the
|
||||
* read worldstate's current records.
|
||||
*
|
||||
* \param recordIndex The index of the record.
|
||||
* \param effectIndex The index of the effect.
|
||||
* \return The skill ID for the effect.
|
||||
*/
|
||||
static int GetRecordEffectSkill(unsigned int recordIndex, unsigned int effectIndex) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Get the range type of the effect at a certain index in the read worldstate's
|
||||
* current records (0 for self, 1 for touch, 2 for target).
|
||||
*
|
||||
* \param recordIndex The index of the record.
|
||||
* \param effectIndex The index of the effect.
|
||||
* \return The range of the effect.
|
||||
*/
|
||||
static unsigned int GetRecordEffectRangeType(unsigned int recordIndex, unsigned int effectIndex) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Get the area of the effect at a certain index in the read worldstate's current
|
||||
* records.
|
||||
*
|
||||
* \param recordIndex The index of the record.
|
||||
* \param effectIndex The index of the effect.
|
||||
* \return The area of the effect.
|
||||
*/
|
||||
static int GetRecordEffectArea(unsigned int recordIndex, unsigned int effectIndex) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Get the duration of the effect at a certain index in the read worldstate's current
|
||||
* records.
|
||||
*
|
||||
* \param recordIndex The index of the record.
|
||||
* \param effectIndex The index of the effect.
|
||||
* \return The duration of the effect.
|
||||
*/
|
||||
static int GetRecordEffectDuration(unsigned int recordIndex, unsigned int effectIndex) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Get the maximum magnitude of the effect at a certain index in the read
|
||||
* worldstate's current records.
|
||||
*
|
||||
* \param recordIndex The index of the record.
|
||||
* \param effectIndex The index of the effect.
|
||||
* \return The maximum magnitude of the effect.
|
||||
*/
|
||||
static int GetRecordEffectMagnitudeMax(unsigned int recordIndex, unsigned int effectIndex) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Get the minimum magnitude of the effect at a certain index in the read
|
||||
* worldstate's current records.
|
||||
*
|
||||
* \param recordIndex The index of the record.
|
||||
* \param effectIndex The index of the effect.
|
||||
* \return The minimum magnitude of the effect.
|
||||
*/
|
||||
static int GetRecordEffectMagnitudeMin(unsigned int recordIndex, unsigned int effectIndex) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set which type of temporary records stored on the server should have
|
||||
* their data changed via setter functions.
|
||||
*
|
||||
* \param type The type of records.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordType(unsigned int type) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the id of the temporary record stored on the server for the
|
||||
* currently specified record type.
|
||||
*
|
||||
* \param id The id of the record.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordId(const char* id) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the base id (i.e. the id this record should inherit default
|
||||
* values from) of the temporary record stored on the server for the
|
||||
* currently specified record type.
|
||||
*
|
||||
* \param baseId The baseId of the record.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordBaseId(const char* baseId) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the inventory base id (i.e. the id this record should inherit
|
||||
* its inventory contents from) of the temporary record stored on the server for
|
||||
* the currently specified record type.
|
||||
*
|
||||
* \param inventoryBaseId The inventoryBaseId of the record.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordInventoryBaseId(const char* inventoryBaseId) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the subtype of the temporary record stored on the server for
|
||||
* the currently specified record type.
|
||||
*
|
||||
* \param type The spell type.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordSubtype(unsigned int subtype) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the name of the temporary record stored on the server for the
|
||||
* currently specified record type.
|
||||
*
|
||||
* \param name The name of the record.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordName(const char* name) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the model of the temporary record stored on the server for the
|
||||
* currently specified record type.
|
||||
*
|
||||
* \param model The model of the record.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordModel(const char* model) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the icon of the temporary record stored on the server for the
|
||||
* currently specified record type.
|
||||
*
|
||||
* \param icon The icon of the record.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordIcon(const char* icon) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the script of the temporary record stored on the server for the
|
||||
* currently specified record type.
|
||||
*
|
||||
* \param script The script of the record.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordScript(const char* script) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the enchantment id of the temporary record stored on the server
|
||||
* for the currently specified record type.
|
||||
*
|
||||
* \param enchantmentId The enchantment id of the record.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordEnchantmentId(const char* enchantmentId) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the enchantment charge of the temporary record stored on the server
|
||||
* for the currently specified record type.
|
||||
*
|
||||
* \param enchantmentCharge The enchantmentCharge of the record.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordEnchantmentCharge(int enchantmentCharge) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the auto-calculation flag value of the temporary record stored
|
||||
* on the server for the currently specified record type.
|
||||
*
|
||||
* \param autoCalc The auto-calculation flag value of the record.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordAutoCalc(int autoCalc) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the charge of the temporary record stored on the server for the
|
||||
* currently specified record type.
|
||||
*
|
||||
* \param charge The charge of the record.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordCharge(int charge) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the cost of the temporary record stored on the server for the
|
||||
* currently specified record type.
|
||||
*
|
||||
* \param cost The cost of the record.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordCost(int cost) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the flags of the temporary record stored on the server for the
|
||||
* currently specified record type.
|
||||
*
|
||||
* \param flags The flags of the record.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordFlags(int flags) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the value of the temporary record stored on the server for the
|
||||
* currently specified record type.
|
||||
*
|
||||
* \param value The value of the record.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordValue(int value) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the weight of the temporary record stored on the server for the
|
||||
* currently specified record type.
|
||||
*
|
||||
* \param weight The weight of the record.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordWeight(double weight) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the armor rating of the temporary record stored on the server
|
||||
* for the currently specified record type.
|
||||
*
|
||||
* \param armorRating The armor rating of the record.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordArmorRating(int armorRating) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the health of the temporary record stored on the server for the
|
||||
* currently specified record type.
|
||||
*
|
||||
* \param health The health of the record.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordHealth(int health) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the chop damage of the temporary record stored on the server for the
|
||||
* currently specified record type.
|
||||
*
|
||||
* \param minDamage The minimum damage of the record.
|
||||
* \param maxDamage The maximum damage of the record.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordDamageChop(unsigned int minDamage, unsigned int maxDamage) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the slash damage of the temporary record stored on the server for the
|
||||
* currently specified record type.
|
||||
*
|
||||
* \param minDamage The minimum damage of the record.
|
||||
* \param maxDamage The maximum damage of the record.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordDamageSlash(unsigned int minDamage, unsigned int maxDamage) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the thrust damage of the temporary record stored on the server for the
|
||||
* currently specified record type.
|
||||
*
|
||||
* \param minDamage The minimum damage of the record.
|
||||
* \param maxDamage The maximum damage of the record.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordDamageThrust(unsigned int minDamage, unsigned int maxDamage) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the reach of the temporary record stored on the server for the
|
||||
* currently specified record type.
|
||||
*
|
||||
* \param reach The reach of the record.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordReach(double reach) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the speed of the temporary record stored on the server for the
|
||||
* currently specified record type.
|
||||
*
|
||||
* \param speed The speed of the record.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordSpeed(double speed) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set whether the temporary record stored on the server for the
|
||||
* currently specified record type is a key.
|
||||
*
|
||||
* Note: This is only applicable to Miscellaneous records.
|
||||
*
|
||||
* \param keyState Whether the record is a key.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordKeyState(bool keyState) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set whether the temporary record stored on the server for the
|
||||
* currently specified record type is a scroll.
|
||||
*
|
||||
* Note: This is only applicable to Book records.
|
||||
*
|
||||
* \param scrollState Whether the record is a scroll.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordScrollState(bool scrollState) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the skill ID of the temporary record stored on the server for the
|
||||
* currently specified record type.
|
||||
*
|
||||
* \param skillId The skill ID of the record.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordSkillId(int skillId) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the text of the temporary record stored on the server for the
|
||||
* currently specified record type.
|
||||
*
|
||||
* \param text The text of the record.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordText(const char* text) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the hair of the temporary record stored on the server for the
|
||||
* currently specified record type.
|
||||
*
|
||||
* \param hair The hair of the record.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordHair(const char* hair) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the head of the temporary record stored on the server for the
|
||||
* currently specified record type.
|
||||
*
|
||||
* \param hair The head of the record.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordHead(const char* head) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the gender of the temporary record stored on the server for the
|
||||
* currently specified record type (0 for female, 1 for male).
|
||||
*
|
||||
* \param hair The race of the record.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordGender(unsigned int gender) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the race of the temporary record stored on the server for the
|
||||
* currently specified record type.
|
||||
*
|
||||
* \param hair The race of the record.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordRace(const char* race) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the character class of the temporary record stored on the server
|
||||
* for the currently specified record type.
|
||||
*
|
||||
* \param hair The character class of the record.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordClass(const char* charClass) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the faction of the temporary record stored on the server for the
|
||||
* currently specified record type.
|
||||
*
|
||||
* \param faction The faction of the record.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordFaction(const char* faction) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the level of the temporary record stored on the server for the
|
||||
* currently specified record type.
|
||||
*
|
||||
* \param value The level of the record.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordLevel(int level) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the id of the record at a certain index in the records stored on the server.
|
||||
*
|
||||
* When resending a received RecordsDynamic packet, this allows you to set the server-generated
|
||||
* id of a record without having to clear and recreate the packet.
|
||||
*
|
||||
* \param index The index of the record.
|
||||
* \param id The id of the record.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordIdByIndex(unsigned int index, const char* id) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the enchantment id of the record at a certain index in the records stored on
|
||||
* the server.
|
||||
*
|
||||
* When resending a received RecordsDynamic packet, this allows you to set the server-generated
|
||||
* enchantment id of a record without having to clear and recreate the packet.
|
||||
*
|
||||
* \param index The index of the record.
|
||||
* \param enchantmentId The enchantment id of the record.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordEnchantmentIdByIndex(unsigned int index, const char* enchantmentId) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the ID of the temporary effect stored on the server.
|
||||
*
|
||||
* \param effectId The ID of the effect.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordEffectId(unsigned int effectId) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the ID of the attribute modified by the temporary effect stored on
|
||||
* the server.
|
||||
*
|
||||
* \param attributeId The ID of the attribute.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordEffectAttribute(int attributeId) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the ID of the skill modified by the temporary effect stored on the
|
||||
* server.
|
||||
*
|
||||
* \param skillId The ID of the skill.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordEffectSkill(int skillId) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the range type of the temporary effect stored on the server (0 for
|
||||
* self, 1 for touch, 2 for target).
|
||||
*
|
||||
* \param rangeType The range type of the effect.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordEffectRangeType(unsigned int rangeType) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the area of the temporary effect stored on the server.
|
||||
*
|
||||
* \param area The area of the effect.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordEffectArea(int area) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the duration of the temporary effect stored on the server.
|
||||
*
|
||||
* \param duration The duration of the effect.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordEffectDuration(int duration) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the maximum magnitude of the temporary effect stored on the server.
|
||||
*
|
||||
* \param magnitudeMax The maximum magnitude of the effect.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordEffectMagnitudeMax(int magnitudeMax) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the minimum magnitude of the temporary effect stored on the server.
|
||||
*
|
||||
* \param magnitudeMin The minimum magnitude of the effect.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordEffectMagnitudeMin(int magnitudeMin) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the type of the temporary body part stored on the server.
|
||||
*
|
||||
* \param partType The type of the body part.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordBodyPartType(unsigned int partType) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the id of the male version of the temporary body part stored on the
|
||||
* server.
|
||||
*
|
||||
* \param partId The id of the body part.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordBodyPartIdForMale(const char* partId) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the id of the female version of the temporary body part stored on the
|
||||
* server.
|
||||
*
|
||||
* \param partId The id of the body part.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordBodyPartIdForFemale(const char* partId) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the id of the of the temporary inventory item stored on the server.
|
||||
*
|
||||
* \param partId The id of the inventory item.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordInventoryItemId(const char* itemId) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Set the count of the of the temporary inventory item stored on the server.
|
||||
*
|
||||
* \param count The count of the inventory item.
|
||||
* \return void
|
||||
*/
|
||||
static void SetRecordInventoryItemCount(unsigned int count) noexcept;
|
||||
|
||||
/**
|
||||
* \brief Add a copy of the server's temporary record of the current specified
|
||||
* type to the stored records.
|
||||
*
|
||||
* In the process, the server's temporary record will automatically be cleared
|
||||
* so a new one can be set up.
|
||||
*
|
||||
* \return void
|
||||
*/
|
||||
static void AddRecord() noexcept;
|
||||
|
||||
/**
|
||||
* \brief Add a copy of the server's temporary effect to the temporary record
|
||||
* of the current specified type.
|
||||
*
|
||||
* In the process, the server's temporary effect will automatically be cleared
|
||||
* so a new one can be set up.
|
||||
*
|
||||
* \return void
|
||||
*/
|
||||
static void AddRecordEffect() noexcept;
|
||||
|
||||
/**
|
||||
* \brief Add a copy of the server's temporary body part to the temporary record
|
||||
* of the current specified type.
|
||||
*
|
||||
* In the process, the server's temporary body part will automatically be cleared
|
||||
* so a new one can be set up.
|
||||
*
|
||||
* \return void
|
||||
*/
|
||||
static void AddRecordBodyPart() noexcept;
|
||||
|
||||
/**
|
||||
* \brief Add a copy of the server's temporary inventory item to the temporary record
|
||||
* of the current specified type.
|
||||
*
|
||||
* In the process, the server's temporary inventory item will automatically be cleared
|
||||
* so a new one can be set up.
|
||||
*
|
||||
* Note: Any items added this way will be ignored if the record already has a valid
|
||||
* inventoryBaseId.
|
||||
*
|
||||
* \return void
|
||||
*/
|
||||
static void AddRecordInventoryItem() noexcept;
|
||||
|
||||
/**
|
||||
* \brief Send a RecordDynamic packet with the current specified record type.
|
||||
*
|
||||
* \param pid The player ID attached to the packet.
|
||||
* \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 SendRecordDynamic(unsigned short pid, bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept;
|
||||
|
||||
};
|
||||
|
||||
#endif //OPENMW_RECORDSDYNAMICAPI_HPP
|
||||
Loading…
Reference in New Issue