Developer notes
This page contains some information about the Vampiric Hunger mod for other modders.
IMPORTANT: Never load this mod without Vampire Embrace in the Construction Set otherwise you will ruin the esp file when saving!
Also never load Vampiric Hunger Extended without Vampiric Hunger Base.
Global variables (Vampiric Hunger Base)
VH_Bloodlevel | The player's current blood level. 0 is the minimum, VH_Setting_MaxSunDamage is the maximum which is 3000. |
VH_ChoosedContainer | Used when there is a need to remove a blood potion from the player's inventory. 1 indicates the glass tube, 2 indicates the retort, 3 indicates the bottle and 4 indicates the goblet. |
VH_Dialog_Equipment | Only used in dialogs. Used to check the player's blood stocking equipment. When the victim doesn't have enough health it's value is -1, when the player doesn't have empty glasses, it's value is 0, when the player can only use a glass tube it's value is 1, when the player can only use a retort it's value is 2, when the player can only use a bottle it's value is 3, when the player can only use a glass tube and a retort it's value is 4, when the player can only use a glass tube and a bottle it's value is 5, when the player can only use a retort and a bottle it's value is 6 and when the player can use everything it's value is 7. |
VH_DisableFire | This variable tells the local flame scripts to disable themselves. |
VH_DrinkedPackedBlood | When the player drinks a blood potion this variable will get set to the amount of points the player's blood level increase. |
VH_Exist | When this variable is 1 then this mod is active. |
VH_Ext_CustomSunDamage | Set this variable to 1 when your custom vampire clan has it's own sun damage spell. This way Vampiric Hunger won't try to remove the "vampire sun damage" spell and replace it with VH_Sun_Damage. |
VH_Ext_RemovePenalties | If you set this variable to 1, Vampiric Hunger III will run the VH_DecHunger3 script to remove the hunger penalties. |
VH_Ext_SetSunProtection | You can change this variable to protect the player from sunlight for some hours. |
VH_Fire_X | Indicates the X location of the fire column. |
VH_Fire_Y | Indicates the Y location of the fire column. |
VH_InPuzzleCenter | When 1 the player is in Vivec, Puzzle Cannal, Center cell. Used for disabling and enabling the water breathing ability. |
VH_IsRestoring | When one of the 3 scripts VH_DecHunger, VH_DecHunger2, VH_DecHunger3 is running this variable is 1, otherwise it is 0. |
VH_FlameIsActive | When this variable is 0 there is a visible fire column that follows the player. Only readable. Used for communicate with VH-E's detection script. |
VH_Level_Agi | This variable contains the level of the player's agility drain curse. |
VH_Level_Spd | This variable contains the level of the player's speed drain curse. |
VH_Level_Str | This variable contains the level of the player's strength drain curse. |
VH_Level_Will | This variable contains the level of the player's willpower drain curse. |
VH_NewDay | In every new day it's value will get set to 1 for 1 frame. |
VH_NewHour | In every new hour it's value will get set to 1 for 1 frame. |
VH_NoBurningVisual | When 1 there won't be fire effect when the player burns from the sunlight. Especially created for the Nasgiel Armor. |
VH_OKToUseCattle | Only used in dialogs. When the player made the quests that allows him to use the cattles of his vampire clan this variable will be set to 1. |
VH_PCIndoor | 1 when the player is in an interior cell. The open areas in Mournhold count as outdoor areas for this variable. |
VH_PCUnderWater | 1 when the player is underwater in an outdoor cell. In interior cells this variable doesn't change. |
VH_PlayerHasVampireBonus | When 1 the player has a vampire attribute bonus and can't get another one until this variable will be 0 again. |
VH_ProtectedFromSunlight | When the player is protected from the sunlight this variable is 1. Don't set it to 1 manually. |
VH_Setting_BloodDecrease | Indicates the amount of blood the player loses every hour. Don't change it. |
VH_Setting_BloodIncrease | Indicates the amount of blood the player gains when he drinks blood. Don't change it. |
VH_Setting_DontWakeUpThePlayer | When 1 the mod won't wake up the player when he is starving. |
VH_Setting_FallToTheGround | When 1 the player will fall to the ground when he is hungry and his fatigue reaches 0. |
VH_Setting_GetMagickaWithBlood | When 0 the player won't get magicka when he drinks blood. |
VH_Setting_HealthLossAmount | The amount of health the player loses in every hour when he is starving. The default value is 3 and it means the player loses his current health / 3 in every hour. |
VH_Setting_MagickaIncrease | Indicates the amount of magicka the player gains when he drinks blood. |
VH_Setting_MaxBloodLevel | Indicates the maximum number of the player's blood level. It's value is 3000. Don't change this number. |
VH_Setting_MaxDays | Indicates the number of days the player has to live as a vampire to lower his blood need to minimum. |
VH_Setting_MaxDrinks | Indicates the number of drinks the player has to make in order to maximize the blood that he gains from a drink. |
VH_Setting_NoBurningVisual | When 1 there won't be the fire column effect when the player is burning from the sunlight. |
VH_Setting_NoFatigueDamage | When 1 the player's fatigue won't decrease faster when he is starving. |
VH_Setting_NoHunger | When 1 the mod's hunger feature is disabled. |
VH_Setting_NoIcon | When 1 the little blood hunger indicating icon won't show up on the screen. The default value is 0 but the MGE Addon automaticaly sets it to 1 because it's role gets replaced by the blood meter. |
VH_Setting_NoMagickaBurn | When 1 the player won't lose magicka when he is burning from the sunlight. |
VH_Setting_NoStarvingWeekness | When 1 the player's abilities won't decrease when he is starving. |
VH_Setting_NoStocking | When 1 the blood stocking feature of the mod will be completely disabled. |
VH_Setting_NoSunDamage | When 1 the whole sun damage feature will get disabled. |
VH_Setting_NoVampAbilities | When 1 the player won't get bonus to his abilities when he drinks vampire blood. |
VH_Setting_Shatter | When 0 the blood potions always shatter when the player drinks them. 2 means never. 1 means the chance will gradually decrease. |
VH_Setting_SunMessage | When 1 you can see a warning message at 5 AM about you should take cover. |
VH_Setting_SunDamageFactor | It can increase or decrease the player's damage from the sunlight. Default value is 1. When it's 0.5 the player's damage will get doubled when it's 2 the player's damage will be the half of the original. |
VH_Shatter | The chance that a blood potion shatters when the player drinks it. |
VH_SunArmorFactor | It is specially made for the Nasgiel Armor. It's function is similar to the VH_Setting_SunDamageFactor variable. |
VH_ThereIsADagger | Only used in dialogs. When the player has a raised dagger in his hand this variable will be 1. |
VH_VampDaysPassed | Indicates how many days have passed since the player became a vampire or the mod was installed. |
VH_Version | Contains Vampiric Hunger's current version. |
Global variables (Vampiric Hunger Extended)
VH_Attack | Only used in dialogs. When this variable is 2 and the player fail to feed or embrace an NPC all nearby NPCs will attack the player. When this variable is 1 then only the victim will attack the player and when this variable is 0 nobody will attack the player. This variable's value depends from the choices in the dialog. It's maximum value is stored in the VH_Setting_AttackType variable. |
VH_Charmed | Only used in dialogs. When the NPC is under the Vampire Dazzle or Vampire Charm spell effect this variable will be 1. |
VH_Checked | Only used in dialogs. Indicates that the NPC's charm spell status or visibility status was checked. Once the menu is closed it will reset to 0. |
VH_DisableTimedDummy | When this variable is 1 and there is a "Timed Dummy" in the cell the "Timed Dummy" will get deleted. "Timed Dummies" are used by the VH_KnownVampireCheck script. When the player is not in an originally ingame town and the player becomes a known vampire in that cell a "Timed Dummy" will be placed there. |
VH_Ext_DontHaveFireWeakness | Set this variable to 1 when VH_Ext_CustomSunDamage is 1 and your custom sun damage spell doesn't contain weakness to fire. |
VH_Ext_SunDmgSpellFlag | Remove your custom sun damage spell when it's value is 1 and reapply it when it's 2. |
VH_ForceType | When the crime based detection system is active this variable will transfer information from the dialog to the force feeding script. |
VH_KnownVampireDaysRemain | When the player is in an originally ingame town this variable shows the number of the remaining days till the player's known vampire status will get reset. |
VH_KnownVampireDaysRemain2 | When the player is not in an originally ingame town this variable shows the number of the remaining days till the player's known vampire status will get reset. |
VH_LevelTooHigh | Only used in dialogs. When this variable is 0 a warning message will get triggered when the player tries to force drinking from an NPC who is 10 levels greater than the player. After the message the variable immediately switches to 1 and will remain 1 until the dialog gets closed. |
VH_NotWerewolfAttack | When this variable is 1 and the PCKnownWerewolf variable becomes 1 then this and the PCKnownWerewolf variable will be reset to 0 after 5 seconds. Used for making the nearby NPCs attack the player. |
VH_Option_NPCHate | In place of the emb_option_npchate variable. |
VH_PCKnownVampire | When the player becomes a known vampire this variable will become 1. When the player leaves the area where he became a known vampire this variable will get reset to 0. When he comes back this variable will be 1 again. You can read this variable's value but changing it is useless. |
VH_Setting_AttackType | This is the maximum value of VH_Attack variable. Default value is 2. |
VH_Setting_ChanceOfBetrayal | This is the chance that the player will become a known vampire and will get attacked when he fail to feed or embrace. Original value is 75%. |
VH_Setting_FlameDetectChance | This is the chance that NPCs will make you a known vampire when they detect you burning from the sunlight. Default value is 75%. |
VH_Setting_KnownVampireTime | The number of the maximum days people remember about the player's vampire status. Original value is 30 days. |
VH_Setting_WatchCheckType | 0 means the selected detection technique is the GetDetected system, means the Crime Based system. |
VH_SunDmgType | Used to communicate between the crimeNPC and the script that restores the player vampirism spell effect. |
VH_ThereIsATimedDummy | If there is a "Timed Dummy" in the current cell then this variable is 1. "Timed Dummies" are used by the VH_KnownVampireCheck script. When the player is not in an originally ingame town and the player becomes a known vampire in that cell a "Timed Dummy" will be placed there. |
VH_TimedDummyID | Contains the ID number of the "Timmed Dummy" in the current cell. |
VH_TutorialStatus | 1 when the tutorial is over. |
VH_Watched | Only used in dialogs. When the player can be seen by NPCs other than the one the player speaks to this variable will be set to 1. |
VH_Exist
You can use this global variable to check Vampiric Hunger's presence. Simply create a VH_Exist global variable in your mod. It's type should be short and it's starting value must be 0. When you check this variable's value from a script and it's 1 then Vampiric Hunger is active.
emb_option_npchate and VH_Option_NPCHate
In Vampire Embrace it is possible to change the way NPCs treat you when you are a vampire with the help of the emb_option_npchate global variable. See Vampire Embrace's readme for more information about the values. Vampiric Hunger uses this variable to change the behavior of the NPCs depending from your known vampire status. VH_Option_NPCHate's initial value is 0 and this is the value that will be active when you are in a region where you are a known vampire. It is possible to change the VH_Option_NPCHate variable from the console to make permanent changes.
Sun damage script
You can use the VH_Ext_SetSunProtection global variable to protect the player from sunlight for a certain hours. Simply declare this global short variable in your mod and if you wan't to protect the player from the sunlight for 6 hours then set this variable to 6. Don't decrease this variable, Vampiric Hunger will do it.
Creating custom vampire clans.
You can find the example mod and it's readme in the VH Clan Example.zip file.
All vampire spells always succeed.
Name |
Type |
Effects |
Range |
Area |
Duration |
Min |
Max |
Cost |
Available for |
Requirements |
Vampire Blood Magic |
Spells |
Forfity Maximum Magicka |
Self |
0 |
90 |
8 |
8 |
720 blood points |
Aundae |
25 days |
Telekinesis |
Self |
0 |
90 |
35 |
35 |
|||||
Detect Animal |
Self |
0 |
90 |
350 |
350 |
|||||
Detect Enchantment |
Self |
0 |
90 |
350 |
350 |
|||||
Detect Key |
Self |
0 |
90 |
350 |
350 |
|||||
Aundae Bloodline |
Abilities |
Forfity Maximum Magicka |
Self |
0 |
- |
5 |
5 |
0 |
Aundae |
15 days |
Vampire Blood Magic |
Spells |
Paralyze |
Touch |
0 |
120 |
- |
- |
720 blood points |
Berne |
25 days |
Forfity Fatigue |
Self |
0 |
120 |
1 |
1 |
|||||
Vampire Cloak of Shadows |
Spells |
Invisibility |
Self |
0 |
60 |
- |
- |
45 |
Berne |
15 days |
Vampire Blood Magic |
Spells |
Forfity Attack |
Self |
0 |
60 |
50 |
50 |
720 blood points |
Quarra |
25 days |
Forfity Health |
Self |
0 |
60 |
100 |
100 |
|||||
Forfity Speed |
Self |
0 |
60 |
75 |
75 |
|||||
Vampire Eye |
Spells |
Night Eye |
Self |
0 |
120 |
50 |
50 |
10 |
Quarra |
15 days |
Vampirism |
Abilities |
Water Breathing |
Self |
0 |
- |
- |
- |
0 |
All |
5 days |
Vampire Strengthen Companion 1. |
Spells |
Fortify Attack |
Touch |
0 |
60 |
5 |
5 |
9 + 100 blood points |
All |
10 days |
Shield |
Touch |
0 |
60 |
10 |
10 |
|||||
Fortify Fatigue |
Self |
0 |
1 |
1 |
1 |
|||||
Vampire Strengthen Companion 2. |
Spells |
Fortify Attack |
Touch |
0 |
60 |
10 |
10 |
13 + 125 blood points |
All |
10 Vampire Strengthen Companion 1. casts |
Shield |
Touch |
0 |
60 |
20 |
20 |
|||||
Fortify Fatigue |
Self |
0 |
1 |
1 |
1 |
|||||
Vampire Strengthen Companion 3. |
Spells |
Fortify Attack |
Touch |
0 |
60 |
15 |
15 |
17 + 150 blood points |
All |
15 Vampire Strengthen Companion 2. casts |
Shield |
Touch |
0 |
60 |
30 |
30 |
|||||
Fortify Fatigue |
Self |
0 |
1 |
1 |
1 |
|||||
Vampire Strengthen Companion 4. |
Spells |
Fortify Attack |
Touch |
0 |
60 |
20 |
20 |
21 + 175 blood points |
All |
20 Vampire Strengthen Companion 3. casts |
Shield |
Touch |
0 |
60 |
40 |
40 |
|||||
Fortify Fatigue |
Self |
0 |
1 |
1 |
1 |
|||||
Vampire Strengthen Companion 5. |
Spells |
Fortify Attack |
Touch |
0 |
60 |
25 |
25 |
25 + 200 blood points |
All |
25 Vampire Strengthen Companion 4. casts |
Shield |
Touch |
0 |
60 |
50 |
50 |
|||||
Fortify Fatigue |
Self |
0 |
1 |
1 |
1 |
|||||
Vampire's Kiss |
Spells |
Damage Health |
Touch |
0 |
1 |
1 |
10 |
4 |
All |
None |
Restore Health |
Self |
0 |
1 |
1 |
10 |
|||||
Vampire Touch |
Spells |
Absorb Health |
Touch |
0 |
1 |
10 |
30 |
8 |
All |
30 "Vampire's Kiss" casts |
Forfity Fatigue |
Self |
0 |
1 |
1 |
1 |
|||||
Vampire Rage |
Spells |
Absorb Health |
Touch |
30 |
5 |
10 |
30 |
25 |
All |
50 "Vampire Touch" casts |
Vampire Calm Mortal |
Spells |
Calm Humanoid |
Touch |
0 |
45 |
100 |
100 |
5 |
All |
10 days |
Forfity Fatigue |
Self |
0 |
1 |
1 |
1 |
|||||
Vampire Command Beast |
Spells |
Command Creature |
Touch |
0 |
60 |
10 |
10 |
50 |
All |
10 "Vampire Calm Mortal" casts |
Forfity Fatigue |
Self |
0 |
1 |
1 |
1 |
|||||
Vampire Command Mortal |
Spells |
Command Humanoid |
Touch |
0 |
60 |
10 |
10 |
50 |
All |
15 "Vampire Command Beast" casts |
Vampire Dazzle Mortal |
Spells |
Charm |
Touch |
0 |
10 |
1 |
1 |
30 |
All |
The Vampiric Hunger Extended mod |
Forfity Fatigue |
Self |
0 |
1 |
1 |
1 |
|||||
Vampire Charm Mortal |
Spells |
Charm |
Touch |
0 |
30 |
20 |
50 |
15 |
All |
15 "Vampire Dazzle" casts or nothing when Vampiric Hunger Extended is not active. |