OpenMW
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
ESM::MagicEffect Struct Reference

#include <loadmgef.hpp>

Collaboration diagram for ESM::MagicEffect:

Classes

struct  MEDTstruct
 

Public Types

enum  Flags {
  TargetSkill = 0x1, TargetAttribute = 0x2, NoDuration = 0x4, NoMagnitude = 0x8,
  Harmful = 0x10, ContinuousVfx = 0x20, CastSelf = 0x40, CastTouch = 0x80,
  CastTarget = 0x100, UncappedDamage = 0x1000, NonRecastable = 0x4000, Unreflectable = 0x10000,
  CasterLinked = 0x20000, AllowSpellmaking = 0x200, AllowEnchanting = 0x400, NegativeLight = 0x800
}
 
enum  MagnitudeDisplayType {
  MDT_None, MDT_Feet, MDT_Level, MDT_Percentage,
  MDT_Points, MDT_TimesInt
}
 
enum  Effects {
  WaterBreathing = 0, SwiftSwim = 1, WaterWalking = 2, Shield = 3,
  FireShield = 4, LightningShield = 5, FrostShield = 6, Burden = 7,
  Feather = 8, Jump = 9, Levitate = 10, SlowFall = 11,
  Lock = 12, Open = 13, FireDamage = 14, ShockDamage = 15,
  FrostDamage = 16, DrainAttribute = 17, DrainHealth = 18, DrainMagicka = 19,
  DrainFatigue = 20, DrainSkill = 21, DamageAttribute = 22, DamageHealth = 23,
  DamageMagicka = 24, DamageFatigue = 25, DamageSkill = 26, Poison = 27,
  WeaknessToFire = 28, WeaknessToFrost = 29, WeaknessToShock = 30, WeaknessToMagicka = 31,
  WeaknessToCommonDisease = 32, WeaknessToBlightDisease = 33, WeaknessToCorprusDisease = 34, WeaknessToPoison = 35,
  WeaknessToNormalWeapons = 36, DisintegrateWeapon = 37, DisintegrateArmor = 38, Invisibility = 39,
  Chameleon = 40, Light = 41, Sanctuary = 42, NightEye = 43,
  Charm = 44, Paralyze = 45, Silence = 46, Blind = 47,
  Sound = 48, CalmHumanoid = 49, CalmCreature = 50, FrenzyHumanoid = 51,
  FrenzyCreature = 52, DemoralizeHumanoid = 53, DemoralizeCreature = 54, RallyHumanoid = 55,
  RallyCreature = 56, Dispel = 57, Soultrap = 58, Telekinesis = 59,
  Mark = 60, Recall = 61, DivineIntervention = 62, AlmsiviIntervention = 63,
  DetectAnimal = 64, DetectEnchantment = 65, DetectKey = 66, SpellAbsorption = 67,
  Reflect = 68, CureCommonDisease = 69, CureBlightDisease = 70, CureCorprusDisease = 71,
  CurePoison = 72, CureParalyzation = 73, RestoreAttribute = 74, RestoreHealth = 75,
  RestoreMagicka = 76, RestoreFatigue = 77, RestoreSkill = 78, FortifyAttribute = 79,
  FortifyHealth = 80, FortifyMagicka = 81, FortifyFatigue = 82, FortifySkill = 83,
  FortifyMaximumMagicka = 84, AbsorbAttribute = 85, AbsorbHealth = 86, AbsorbMagicka = 87,
  AbsorbFatigue = 88, AbsorbSkill = 89, ResistFire = 90, ResistFrost = 91,
  ResistShock = 92, ResistMagicka = 93, ResistCommonDisease = 94, ResistBlightDisease = 95,
  ResistCorprusDisease = 96, ResistPoison = 97, ResistNormalWeapons = 98, ResistParalysis = 99,
  RemoveCurse = 100, TurnUndead = 101, SummonScamp = 102, SummonClannfear = 103,
  SummonDaedroth = 104, SummonDremora = 105, SummonAncestralGhost = 106, SummonSkeletalMinion = 107,
  SummonBonewalker = 108, SummonGreaterBonewalker = 109, SummonBonelord = 110, SummonWingedTwilight = 111,
  SummonHunger = 112, SummonGoldenSaint = 113, SummonFlameAtronach = 114, SummonFrostAtronach = 115,
  SummonStormAtronach = 116, FortifyAttack = 117, CommandCreature = 118, CommandHumanoid = 119,
  BoundDagger = 120, BoundLongsword = 121, BoundMace = 122, BoundBattleAxe = 123,
  BoundSpear = 124, BoundLongbow = 125, ExtraSpell = 126, BoundCuirass = 127,
  BoundHelm = 128, BoundBoots = 129, BoundShield = 130, BoundGloves = 131,
  Corprus = 132, Vampirism = 133, SummonCenturionSphere = 134, SunDamage = 135,
  StuntedMagicka = 136, SummonFabricant = 137, SummonWolf = 138, SummonBear = 139,
  SummonBonewolf = 140, SummonCreature04 = 141, SummonCreature05 = 142, Length
}
 

Public Member Functions

MagnitudeDisplayType getMagnitudeDisplayType () const
 
void load (ESMReader &esm, bool &isDeleted)
 
void save (ESMWriter &esm, bool isDeleted=false) const
 
void blank ()
 Set record to default state (does not touch the ID/index). More...
 

Static Public Member Functions

static std::string getRecordType ()
 Return a string descriptor for this record type. Currently used for debugging / error logs only. More...
 
static const std::string & effectIdToString (short effectID)
 
static short effectStringToId (const std::string &effect)
 
static short getResistanceEffect (short effect)
 Returns the effect that provides resistance against effect (or -1 if there's none) More...
 
static short getWeaknessEffect (short effect)
 Returns the effect that induces weakness against effect (or -1 if there's none) More...
 
static std::string indexToId (int index)
 

Public Attributes

std::string mId
 
MEDTstruct mData
 
std::string mIcon
 
std::string mParticle
 
std::string mCasting
 
std::string mHit
 
std::string mArea
 
std::string mBolt
 
std::string mCastSound
 
std::string mBoltSound
 
std::string mHitSound
 
std::string mAreaSound
 
std::string mDescription
 
int mIndex
 

Static Public Attributes

static unsigned int sRecordId = REC_MGEF
 
static const std::map< short,
std::string > 
sNames = genNameMap()
 

Member Enumeration Documentation

Enumerator
WaterBreathing 
SwiftSwim 
WaterWalking 
Shield 
FireShield 
LightningShield 
FrostShield 
Burden 
Feather 
Jump 
Levitate 
SlowFall 
Lock 
Open 
FireDamage 
ShockDamage 
FrostDamage 
DrainAttribute 
DrainHealth 
DrainMagicka 
DrainFatigue 
DrainSkill 
DamageAttribute 
DamageHealth 
DamageMagicka 
DamageFatigue 
DamageSkill 
Poison 
WeaknessToFire 
WeaknessToFrost 
WeaknessToShock 
WeaknessToMagicka 
WeaknessToCommonDisease 
WeaknessToBlightDisease 
WeaknessToCorprusDisease 
WeaknessToPoison 
WeaknessToNormalWeapons 
DisintegrateWeapon 
DisintegrateArmor 
Invisibility 
Chameleon 
Light 
Sanctuary 
NightEye 
Charm 
Paralyze 
Silence 
Blind 
Sound 
CalmHumanoid 
CalmCreature 
FrenzyHumanoid 
FrenzyCreature 
DemoralizeHumanoid 
DemoralizeCreature 
RallyHumanoid 
RallyCreature 
Dispel 
Soultrap 
Telekinesis 
Mark 
Recall 
DivineIntervention 
AlmsiviIntervention 
DetectAnimal 
DetectEnchantment 
DetectKey 
SpellAbsorption 
Reflect 
CureCommonDisease 
CureBlightDisease 
CureCorprusDisease 
CurePoison 
CureParalyzation 
RestoreAttribute 
RestoreHealth 
RestoreMagicka 
RestoreFatigue 
RestoreSkill 
FortifyAttribute 
FortifyHealth 
FortifyMagicka 
FortifyFatigue 
FortifySkill 
FortifyMaximumMagicka 
AbsorbAttribute 
AbsorbHealth 
AbsorbMagicka 
AbsorbFatigue 
AbsorbSkill 
ResistFire 
ResistFrost 
ResistShock 
ResistMagicka 
ResistCommonDisease 
ResistBlightDisease 
ResistCorprusDisease 
ResistPoison 
ResistNormalWeapons 
ResistParalysis 
RemoveCurse 
TurnUndead 
SummonScamp 
SummonClannfear 
SummonDaedroth 
SummonDremora 
SummonAncestralGhost 
SummonSkeletalMinion 
SummonBonewalker 
SummonGreaterBonewalker 
SummonBonelord 
SummonWingedTwilight 
SummonHunger 
SummonGoldenSaint 
SummonFlameAtronach 
SummonFrostAtronach 
SummonStormAtronach 
FortifyAttack 
CommandCreature 
CommandHumanoid 
BoundDagger 
BoundLongsword 
BoundMace 
BoundBattleAxe 
BoundSpear 
BoundLongbow 
ExtraSpell 
BoundCuirass 
BoundHelm 
BoundBoots 
BoundShield 
BoundGloves 
Corprus 
Vampirism 
SummonCenturionSphere 
SunDamage 
StuntedMagicka 
SummonFabricant 
SummonWolf 
SummonBear 
SummonBonewolf 
SummonCreature04 
SummonCreature05 
Length 
Enumerator
TargetSkill 
TargetAttribute 
NoDuration 
NoMagnitude 
Harmful 
ContinuousVfx 
CastSelf 
CastTouch 
CastTarget 
UncappedDamage 
NonRecastable 
Unreflectable 
CasterLinked 
AllowSpellmaking 
AllowEnchanting 
NegativeLight 
Enumerator
MDT_None 
MDT_Feet 
MDT_Level 
MDT_Percentage 
MDT_Points 
MDT_TimesInt 

Member Function Documentation

void ESM::MagicEffect::blank ( )

Set record to default state (does not touch the ID/index).

Here is the caller graph for this function:

const std::string & ESM::MagicEffect::effectIdToString ( short  effectID)
static

Here is the caller graph for this function:

short ESM::MagicEffect::effectStringToId ( const std::string &  effect)
static

Here is the caller graph for this function:

MagicEffect::MagnitudeDisplayType ESM::MagicEffect::getMagnitudeDisplayType ( ) const

Here is the caller graph for this function:

static std::string ESM::MagicEffect::getRecordType ( )
inlinestatic

Return a string descriptor for this record type. Currently used for debugging / error logs only.

short ESM::MagicEffect::getResistanceEffect ( short  effect)
static

Returns the effect that provides resistance against effect (or -1 if there's none)

Here is the caller graph for this function:

short ESM::MagicEffect::getWeaknessEffect ( short  effect)
static

Returns the effect that induces weakness against effect (or -1 if there's none)

Here is the caller graph for this function:

std::string ESM::MagicEffect::indexToId ( int  index)
static

Here is the caller graph for this function:

void ESM::MagicEffect::load ( ESMReader esm,
bool isDeleted 
)

Here is the call graph for this function:

void ESM::MagicEffect::save ( ESMWriter esm,
bool  isDeleted = false 
) const

Here is the call graph for this function:

Member Data Documentation

std::string ESM::MagicEffect::mArea
std::string ESM::MagicEffect::mAreaSound
std::string ESM::MagicEffect::mBolt
std::string ESM::MagicEffect::mBoltSound
std::string ESM::MagicEffect::mCasting
std::string ESM::MagicEffect::mCastSound
MEDTstruct ESM::MagicEffect::mData
std::string ESM::MagicEffect::mDescription
std::string ESM::MagicEffect::mHit
std::string ESM::MagicEffect::mHitSound
std::string ESM::MagicEffect::mIcon
std::string ESM::MagicEffect::mId
int ESM::MagicEffect::mIndex
std::string ESM::MagicEffect::mParticle
const std::map< short, std::string > ESM::MagicEffect::sNames = genNameMap()
static
unsigned int ESM::MagicEffect::sRecordId = REC_MGEF
static

The documentation for this struct was generated from the following files: