Records Dynamic functions¶
-
class RecordsDynamicFunctions¶
Public Static Functions
-
static void ClearRecords() noexcept¶
Clear the data from the records stored on the server.
- Returns
void
-
static unsigned short GetRecordType() noexcept¶
Get the type of records in the read worldstate’s dynamic records.
- Returns
The type of records (0 for SPELL, 1 for POTION, 2 for ENCHANTMENT, 3 for NPC).
-
static unsigned int GetRecordCount() noexcept¶
Get the number of records in the read worldstate’s dynamic records.
- Returns
The number of records.
-
static unsigned int GetRecordEffectCount(unsigned int recordIndex) noexcept¶
Get the number of effects for the record at a certain index in the read worldstate’s current records.
- Parameters
recordIndex – The index of the record.
- Returns
The number of effects.
-
static const char *GetRecordId(unsigned int index) noexcept¶
Get the id of the record at a certain index in the read worldstate’s dynamic records of the current type.
- Parameters
index – The index of the record.
- Returns
The id of the record.
-
static const char *GetRecordBaseId(unsigned int index) noexcept¶
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.
- Parameters
index – The index of the record.
- Returns
The base id of the record.
-
static int GetRecordSubtype(unsigned int index) noexcept¶
Get the subtype of the record at a certain index in the read worldstate’s dynamic records of the current type.
- Parameters
index – The index of the record.
- Returns
The type of the record.
-
static const char *GetRecordName(unsigned int index) noexcept¶
Get the name of the record at a certain index in the read worldstate’s dynamic records of the current type.
- Parameters
index – The index of the record.
- Returns
The name of the record.
-
static const char *GetRecordModel(unsigned int index) noexcept¶
Get the model of the record at a certain index in the read worldstate’s dynamic records of the current type.
- Parameters
index – The index of the record.
- Returns
The model of the record.
-
static const char *GetRecordIcon(unsigned int index) noexcept¶
Get the icon of the record at a certain index in the read worldstate’s dynamic records of the current type.
- Parameters
index – The index of the record.
- Returns
The icon of the record.
-
static const char *GetRecordScript(unsigned int index) noexcept¶
Get the script of the record at a certain index in the read worldstate’s dynamic records of the current type.
- Parameters
index – The index of the record.
- Returns
The script of the record.
-
static const char *GetRecordEnchantmentId(unsigned int index) noexcept¶
Get the enchantment id of the record at a certain index in the read worldstate’s dynamic records of the current type.
- Parameters
index – The index of the record.
- Returns
The enchantment id of the record.
-
static int GetRecordEnchantmentCharge(unsigned int index) noexcept¶
Get the enchantment charge of the record at a certain index in the read worldstate’s dynamic records of the current type.
- Parameters
index – The index of the record.
- Returns
The enchantment charge of the record.
-
static int GetRecordAutoCalc(unsigned int index) noexcept¶
Get the auto-calculation flag value of the record at a certain index in the read worldstate’s dynamic records of the current type.
- Parameters
index – The index of the record.
- Returns
The auto-calculation flag value of the record.
-
static int GetRecordCharge(unsigned int index) noexcept¶
Get the charge of the record at a certain index in the read worldstate’s dynamic records of the current type.
- Parameters
index – The index of the record.
- Returns
The charge of the record.
-
static int GetRecordCost(unsigned int index) noexcept¶
Get the cost of the record at a certain index in the read worldstate’s dynamic records of the current type.
- Parameters
index – The index of the record.
- Returns
The cost of the record.
-
static int GetRecordFlags(unsigned int index) noexcept¶
Get the flags of the record at a certain index in the read worldstate’s dynamic records of the current type.
- Parameters
index – The index of the record.
- Returns
The flags of the spell as an integer.
-
static int GetRecordValue(unsigned int index) noexcept¶
Get the value of the record at a certain index in the read worldstate’s dynamic records of the current type.
- Parameters
index – The index of the record.
- Returns
The value of the record.
-
static double GetRecordWeight(unsigned int index) noexcept¶
Get the weight of the record at a certain index in the read worldstate’s dynamic records of the current type.
- Parameters
index – The index of the record.
- Returns
The weight of the record.
-
static unsigned int GetRecordQuantity(unsigned int index) noexcept¶
Get the quantity of the record at a certain index in the read worldstate’s dynamic records of the current type.
- Parameters
index – The index of the record.
- Returns
The brewed count of the record.
-
static unsigned int GetRecordEffectId(unsigned int recordIndex, unsigned int effectIndex) noexcept¶
Get the ID of the effect at a certain index in the read worldstate’s current records.
- Parameters
recordIndex – The index of the record.
effectIndex – The index of the effect.
- Returns
The ID of the effect.
-
static int GetRecordEffectAttribute(unsigned int recordIndex, unsigned int effectIndex) noexcept¶
Get the ID of the attribute modified by the effect at a certain index in the read worldstate’s current records.
- Parameters
recordIndex – The index of the record.
effectIndex – The index of the effect.
- Returns
The attribute ID for the effect.
-
static int GetRecordEffectSkill(unsigned int recordIndex, unsigned int effectIndex) noexcept¶
Get the ID of the skill modified by the effect at a certain index in the read worldstate’s current records.
- Parameters
recordIndex – The index of the record.
effectIndex – The index of the effect.
- Returns
The skill ID for the effect.
-
static unsigned int GetRecordEffectRangeType(unsigned int recordIndex, unsigned int effectIndex) noexcept¶
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).
- Parameters
recordIndex – The index of the record.
effectIndex – The index of the effect.
- Returns
The range of the effect.
-
static int GetRecordEffectArea(unsigned int recordIndex, unsigned int effectIndex) noexcept¶
Get the area of the effect at a certain index in the read worldstate’s current records.
- Parameters
recordIndex – The index of the record.
effectIndex – The index of the effect.
- Returns
The area of the effect.
-
static int GetRecordEffectDuration(unsigned int recordIndex, unsigned int effectIndex) noexcept¶
Get the duration of the effect at a certain index in the read worldstate’s current records.
- Parameters
recordIndex – The index of the record.
effectIndex – The index of the effect.
- Returns
The duration of the effect.
-
static int GetRecordEffectMagnitudeMax(unsigned int recordIndex, unsigned int effectIndex) noexcept¶
Get the maximum magnitude of the effect at a certain index in the read worldstate’s current records.
- Parameters
recordIndex – The index of the record.
effectIndex – The index of the effect.
- Returns
The maximum magnitude of the effect.
-
static int GetRecordEffectMagnitudeMin(unsigned int recordIndex, unsigned int effectIndex) noexcept¶
Get the minimum magnitude of the effect at a certain index in the read worldstate’s current records.
- Parameters
recordIndex – The index of the record.
effectIndex – The index of the effect.
- Returns
The minimum magnitude of the effect.
-
static void SetRecordType(unsigned int type) noexcept¶
Set which type of temporary records stored on the server should have their data changed via setter functions.
- Parameters
type – The type of records.
- Returns
void
-
static void SetRecordId(const char *id) noexcept¶
Set the id of the temporary record stored on the server for the currently specified record type.
- Parameters
id – The id of the record.
- Returns
void
-
static void SetRecordBaseId(const char *baseId) noexcept¶
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.
- Parameters
baseId – The baseId of the record.
- Returns
void
-
static void SetRecordInventoryBaseId(const char *inventoryBaseId) noexcept¶
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.
- Parameters
inventoryBaseId – The inventoryBaseId of the record.
- Returns
void
-
static void SetRecordSubtype(unsigned int subtype) noexcept¶
Set the subtype of the temporary record stored on the server for the currently specified record type.
- Parameters
subtype – The spell type.
- Returns
void
-
static void SetRecordName(const char *name) noexcept¶
Set the name of the temporary record stored on the server for the currently specified record type.
- Parameters
name – The name of the record.
- Returns
void
-
static void SetRecordModel(const char *model) noexcept¶
Set the model of the temporary record stored on the server for the currently specified record type.
- Parameters
model – The model of the record.
- Returns
void
-
static void SetRecordIcon(const char *icon) noexcept¶
Set the icon of the temporary record stored on the server for the currently specified record type.
- Parameters
icon – The icon of the record.
- Returns
void
-
static void SetRecordScript(const char *script) noexcept¶
Set the script of the temporary record stored on the server for the currently specified record type.
- Parameters
script – The script of the record.
- Returns
void
-
static void SetRecordEnchantmentId(const char *enchantmentId) noexcept¶
Set the enchantment id of the temporary record stored on the server for the currently specified record type.
- Parameters
enchantmentId – The enchantment id of the record.
- Returns
void
-
static void SetRecordEnchantmentCharge(int enchantmentCharge) noexcept¶
Set the enchantment charge of the temporary record stored on the server for the currently specified record type.
- Parameters
enchantmentCharge – The enchantmentCharge of the record.
- Returns
void
-
static void SetRecordAutoCalc(int autoCalc) noexcept¶
Set the auto-calculation flag value of the temporary record stored on the server for the currently specified record type.
- Parameters
autoCalc – The auto-calculation flag value of the record.
- Returns
void
-
static void SetRecordCharge(int charge) noexcept¶
Set the charge of the temporary record stored on the server for the currently specified record type.
- Parameters
charge – The charge of the record.
- Returns
void
-
static void SetRecordCost(int cost) noexcept¶
Set the cost of the temporary record stored on the server for the currently specified record type.
- Parameters
cost – The cost of the record.
- Returns
void
-
static void SetRecordFlags(int flags) noexcept¶
Set the flags of the temporary record stored on the server for the currently specified record type.
- Parameters
flags – The flags of the record.
- Returns
void
-
static void SetRecordValue(int value) noexcept¶
Set the value of the temporary record stored on the server for the currently specified record type.
- Parameters
value – The value of the record.
- Returns
void
-
static void SetRecordWeight(double weight) noexcept¶
Set the weight of the temporary record stored on the server for the currently specified record type.
- Parameters
weight – The weight of the record.
- Returns
void
-
static void SetRecordQuality(double quality) noexcept¶
Set the item quality of the temporary record stored on the server for the currently specified record type.
- Parameters
quality – The quality of the record.
- Returns
void
-
static void SetRecordUses(int uses) noexcept¶
Set the number of uses of the temporary record stored on the server for the currently specified record type.
- Parameters
uses – The number of uses of the record.
- Returns
void
-
static void SetRecordTime(int time) noexcept¶
Set the time of the temporary record stored on the server for the currently specified record type.
- Parameters
time – The time of the record.
- Returns
void
-
static void SetRecordRadius(int radius) noexcept¶
Set the radius of the temporary record stored on the server for the currently specified record type.
- Parameters
radius – The radius of the record.
- Returns
void
-
static void SetRecordColor(unsigned int red, unsigned int green, unsigned int blue) noexcept¶
Set the color of the temporary record stored on the server for the currently specified record type.
- Parameters
red – The red value of the record.
green – The green value of the record.
blue – The blue value of the record.
- Returns
void
-
static void SetRecordArmorRating(int armorRating) noexcept¶
Set the armor rating of the temporary record stored on the server for the currently specified record type.
- Parameters
armorRating – The armor rating of the record.
- Returns
void
-
static void SetRecordHealth(int health) noexcept¶
Set the health of the temporary record stored on the server for the currently specified record type.
- Parameters
health – The health of the record.
- Returns
void
-
static void SetRecordDamageChop(unsigned int minDamage, unsigned int maxDamage) noexcept¶
Set the chop damage of the temporary record stored on the server for the currently specified record type.
- Parameters
minDamage – The minimum damage of the record.
maxDamage – The maximum damage of the record.
- Returns
void
-
static void SetRecordDamageSlash(unsigned int minDamage, unsigned int maxDamage) noexcept¶
Set the slash damage of the temporary record stored on the server for the currently specified record type.
- Parameters
minDamage – The minimum damage of the record.
maxDamage – The maximum damage of the record.
- Returns
void
-
static void SetRecordDamageThrust(unsigned int minDamage, unsigned int maxDamage) noexcept¶
Set the thrust damage of the temporary record stored on the server for the currently specified record type.
- Parameters
minDamage – The minimum damage of the record.
maxDamage – The maximum damage of the record.
- Returns
void
-
static void SetRecordReach(double reach) noexcept¶
Set the reach of the temporary record stored on the server for the currently specified record type.
- Parameters
reach – The reach of the record.
- Returns
void
-
static void SetRecordSpeed(double speed) noexcept¶
Set the speed of the temporary record stored on the server for the currently specified record type.
- Parameters
speed – The speed of the record.
- Returns
void
-
static void SetRecordKeyState(bool keyState) noexcept¶
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.
- Parameters
keyState – Whether the record is a key.
- Returns
void
-
static void SetRecordScrollState(bool scrollState) noexcept¶
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.
- Parameters
scrollState – Whether the record is a scroll.
- Returns
void
-
static void SetRecordSkillId(int skillId) noexcept¶
Set the skill ID of the temporary record stored on the server for the currently specified record type.
- Parameters
skillId – The skill ID of the record.
- Returns
void
-
static void SetRecordText(const char *text) noexcept¶
Set the text of the temporary record stored on the server for the currently specified record type.
- Parameters
text – The text of the record.
- Returns
void
-
static void SetRecordHair(const char *hair) noexcept¶
Set the hair of the temporary record stored on the server for the currently specified record type.
- Parameters
hair – The hair of the record.
- Returns
void
-
static void SetRecordHead(const char *head) noexcept¶
Set the head of the temporary record stored on the server for the currently specified record type.
- Parameters
head – The head of the record.
- Returns
void
-
static void SetRecordGender(unsigned int gender) noexcept¶
Set the gender of the temporary record stored on the server for the currently specified record type (0 for female, 1 for male).
- Parameters
gender – The gender of the record.
- Returns
void
-
static void SetRecordRace(const char *race) noexcept¶
Set the race of the temporary record stored on the server for the currently specified record type.
- Parameters
race – The race of the record.
- Returns
void
-
static void SetRecordClass(const char *charClass) noexcept¶
Set the character class of the temporary record stored on the server for the currently specified record type.
- Parameters
charClass – The character class of the record.
- Returns
void
-
static void SetRecordFaction(const char *faction) noexcept¶
Set the faction of the temporary record stored on the server for the currently specified record type.
- Parameters
faction – The faction of the record.
- Returns
void
-
static void SetRecordScale(double scale) noexcept¶
Set the scale of the temporary record stored on the server for the currently specified record type.
- Parameters
scale – The scale of the record.
- Returns
void
-
static void SetRecordBloodType(int bloodType) noexcept¶
Set the blood type of the temporary record stored on the server for the currently specified record type.
- Parameters
bloodType – The blood type of the record.
- Returns
void
-
static void SetRecordVampireState(bool vampireState) noexcept¶
Set the vampire state of the temporary record stored on the server for the currently specified record type.
- Parameters
vampireState – The vampire state of the record.
- Returns
void
-
static void SetRecordLevel(int level) noexcept¶
Set the level of the temporary record stored on the server for the currently specified record type.
- Parameters
level – The level of the record.
- Returns
void
-
static void SetRecordMagicka(int magicka) noexcept¶
Set the magicka of the temporary record stored on the server for the currently specified record type.
- Parameters
magicka – The magicka of the record.
- Returns
void
-
static void SetRecordFatigue(int fatigue) noexcept¶
Set the fatigue of the temporary record stored on the server for the currently specified record type.
- Parameters
fatigue – The fatigue of the record.
- Returns
void
-
static void SetRecordSoulValue(int soulValue) noexcept¶
Set the soul value of the temporary record stored on the server for the currently specified record type.
- Parameters
soulValue – The soul value of the record.
- Returns
void
-
static void SetRecordAIFight(int aiFight) noexcept¶
Set the AI fight value of the temporary record stored on the server for the currently specified record type.
- Parameters
aiFight – The AI fight value of the record.
- Returns
void
-
static void SetRecordAIFlee(int aiFlee) noexcept¶
Set the AI flee value of the temporary record stored on the server for the currently specified record type.
- Parameters
aiFlee – The AI flee value of the record.
- Returns
void
-
static void SetRecordAIAlarm(int aiAlarm) noexcept¶
Set the AI alarm value of the temporary record stored on the server for the currently specified record type.
- Parameters
aiAlarm – The AI alarm value of the record.
- Returns
void
-
static void SetRecordAIServices(int aiServices) noexcept¶
Set the AI services value of the temporary record stored on the server for the currently specified record type.
- Parameters
aiServices – The AI services value of the record.
- Returns
void
-
static void SetRecordSound(const char *sound) noexcept¶
Set the sound of the temporary record stored on the server for the currently specified record type.
- Parameters
sound – The sound of the record.
- Returns
void
-
static void SetRecordVolume(double volume) noexcept¶
Set the volume of the temporary record stored on the server for the currently specified record type.
- Parameters
volume – The volume of the record.
- Returns
void
-
static void SetRecordMinRange(double minRange) noexcept¶
Set the minimum range of the temporary record stored on the server for the currently specified record type.
- Parameters
minRange – The minimum range of the record.
- Returns
void
-
static void SetRecordMaxRange(double maxRange) noexcept¶
Set the maximum range of the temporary record stored on the server for the currently specified record type.
- Parameters
maxRange – The maximum range of the record.
- Returns
void
-
static void SetRecordOpenSound(const char *sound) noexcept¶
Set the opening sound of the temporary record stored on the server for the currently specified record type.
- Parameters
sound – The opening sound of the record.
- Returns
void
-
static void SetRecordCloseSound(const char *sound) noexcept¶
Set the closing sound of the temporary record stored on the server for the currently specified record type.
- Parameters
sound – The closing sound of the record.
- Returns
void
-
static void SetRecordScriptText(const char *scriptText) noexcept¶
Set the script text of the temporary record stored on the server for the currently specified record type.
- Parameters
scriptText – The script text of the record.
- Returns
void
-
static void SetRecordIntegerVariable(int intVar) noexcept¶
Set the integer variable of the temporary record stored on the server for the currently specified record type.
- Parameters
intVar – The integer variable of the record.
- Returns
void
-
static void SetRecordFloatVariable(double floatVar) noexcept¶
Set the float variable of the temporary record stored on the server for the currently specified record type.
- Parameters
floatVar – The float variable of the record.
- Returns
void
-
static void SetRecordStringVariable(const char *stringVar) noexcept¶
Set the string variable of the temporary record stored on the server for the currently specified record type.
- Parameters
stringVar – The string variable of the record.
- Returns
void
-
static void SetRecordIdByIndex(unsigned int index, const char *id) noexcept¶
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.
- Parameters
index – The index of the record.
id – The id of the record.
- Returns
void
-
static void SetRecordEnchantmentIdByIndex(unsigned int index, const char *enchantmentId) noexcept¶
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.
- Parameters
index – The index of the record.
enchantmentId – The enchantment id of the record.
- Returns
void
-
static void SetRecordEffectId(unsigned int effectId) noexcept¶
Set the ID of the temporary effect stored on the server.
- Parameters
effectId – The ID of the effect.
- Returns
void
-
static void SetRecordEffectAttribute(int attributeId) noexcept¶
Set the ID of the attribute modified by the temporary effect stored on the server.
- Parameters
attributeId – The ID of the attribute.
- Returns
void
-
static void SetRecordEffectSkill(int skillId) noexcept¶
Set the ID of the skill modified by the temporary effect stored on the server.
- Parameters
skillId – The ID of the skill.
- Returns
void
-
static void SetRecordEffectRangeType(unsigned int rangeType) noexcept¶
Set the range type of the temporary effect stored on the server (0 for self, 1 for touch, 2 for target).
- Parameters
rangeType – The range type of the effect.
- Returns
void
-
static void SetRecordEffectArea(int area) noexcept¶
Set the area of the temporary effect stored on the server.
- Parameters
area – The area of the effect.
- Returns
void
-
static void SetRecordEffectDuration(int duration) noexcept¶
Set the duration of the temporary effect stored on the server.
- Parameters
duration – The duration of the effect.
- Returns
void
-
static void SetRecordEffectMagnitudeMax(int magnitudeMax) noexcept¶
Set the maximum magnitude of the temporary effect stored on the server.
- Parameters
magnitudeMax – The maximum magnitude of the effect.
- Returns
void
-
static void SetRecordEffectMagnitudeMin(int magnitudeMin) noexcept¶
Set the minimum magnitude of the temporary effect stored on the server.
- Parameters
magnitudeMin – The minimum magnitude of the effect.
- Returns
void
-
static void SetRecordBodyPartType(unsigned int partType) noexcept¶
Set the body part type of the temporary body part stored on the server (which then needs to be added to ARMOR or CLOTHING records) or set the body part type of the current record if it’s a BODYPART.
- Parameters
partType – The type of the body part.
- Returns
void
-
static void SetRecordBodyPartIdForMale(const char *partId) noexcept¶
Set the id of the male version of the temporary body part stored on the server.
- Parameters
partId – The id of the body part.
- Returns
void
-
static void SetRecordBodyPartIdForFemale(const char *partId) noexcept¶
Set the id of the female version of the temporary body part stored on the server.
- Parameters
partId – The id of the body part.
- Returns
void
-
static void SetRecordInventoryItemId(const char *itemId) noexcept¶
Set the id of the of the temporary inventory item stored on the server.
- Parameters
itemId – The id of the inventory item.
- Returns
void
-
static void SetRecordInventoryItemCount(unsigned int count) noexcept¶
Set the count of the of the temporary inventory item stored on the server.
- Parameters
count – The count of the inventory item.
- Returns
void
-
static void AddRecord() noexcept¶
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.
- Returns
void
-
static void AddRecordEffect() noexcept¶
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.
- Returns
void
-
static void AddRecordBodyPart() noexcept¶
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.
- Returns
void
-
static void AddRecordInventoryItem() noexcept¶
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.
- Returns
void
-
static void SendRecordDynamic(unsigned short pid, bool sendToOtherPlayers, bool skipAttachedPlayer) noexcept¶
Send a RecordDynamic packet with the current specified record type.
- Parameters
pid – The player ID attached to the packet.
sendToOtherPlayers – Whether this packet should be sent to players other than the player attached to the packet (false by default).
skipAttachedPlayer – Whether the packet should skip being sent to the player attached to the packet (false by default).
- Returns
void
-
static void ClearRecords() noexcept¶