<>> Succubus Heart <<>
  >  Source Notes  <
(This document holds source information)

- Naming Conventions -

SuH / suh
	all Succubus Heart objects will prefix with this to ensure easy finding and reduce chances of overlapping with other mods.
ent/ and end/
	These are nodes I use in notepad++ and other text editors to create clamps for easy navigation

.E.    ; Effect
.S.    ; Script
.sex.  ; Sex Effect
.spell.; Succubus Spell
.pass. ; Succubus Passive
.T.    ; Spell Trigger
.SET.  ; Configurable Setting
.NPC.  ; Non-Playable Character
.PC.   ; Player Character
.PCS.  ; Player Character Stat
.dyna. ; Dynamic Script Element
.anim. ; Animation Event
.ing.  ; Ingredient
.com.  ; Common Use / General Use
.stat. ; Status State

r. ; Reference
v. ; Variable / Object
s. ; Script
f. ; Function

PC Mastery ; When the player is considered the Aggressor
PC Training ; When the player is considered Consentual
PC Submit ; When the player is considered the Victim
NPC Attacker ; When the NPC is considered the Aggressor
NPC Consent ; When the NPC is considered Consentual
NPC Victim ; When the NPC is considered the Victim

+ Quests +
	SuH_Main ; Handles MODupdate and primary animation triggers
		r. PlayerRef ; Ref. Player
		s. SuH_Main ; The Quest Script
			f. MODupdate ; Compares MODversion and updates the mod
			f. anim_NPC_Start ; Triggers when an NPC starts an act
			f. anim_NPC_Orgasm ; Triggers when an NPC orgasms
			f. anim_NPC_End ; Triggers when an NPC act ends
			f. anim_PC_Start ; Triggers when the PC starts an act
			f. anim_PC_Orgasm ; Triggers when the PC orgasms
			f. anim_PC_End ; Triggers when the PC act ends
		s. SuH_Main_Player ; On playerLoad run's update script
			s. SuH_Main ;ref
	SuH_MCM ; Creates and Handles the MCM
		r. PlayerRef ; Ref. Player
		s. SuH_MCM ; Quest Script
			f. OnConfigInit ; Runs initial function
				a. Pages ; Determines MCM Page # and Names
	SuH_Fun ; Handles Global Functions
		s. SuH_Fun ; Quest Script
			f. XPcalc ; Calculates XP gained
				(string aPreset, float aMOD, int XPearn, float lvlS, bool dReport)
				aPreset ; Effect Preset and Define (Used by default effects)
					PCmastery ; Mastery Act
					PCtraining ; Training Act
					PCsubmit ; Submit Act
					PCsperm ; Sperm Consume
					PCmilk ; Milk Consume
				aMOD ; Calculates an added percentage gain, will be overwritten by presets (Adds to inherited XPgain value)
				XPearn ; Sets XP earned, when using a preset this value adds to the default amount (set to 0 to use default)
				lvlS ; XPearn added per-character level, will be overwritten by presets (Set to 0 to disable)
				dReport ; Sends Notification for the player based on gain
					TRUE ; Send Report
					False ; Don't Send Report
			f. STATcalc ; Calculates Stats gained
				(Actor eChar,bool PCin, string aPreset,string Stat, bool drainC,float aMOD,float aEffect,bool dReport)
				eChar ; Character to effect
				PCin ; Is Player Involved?
					TRUE ; Player is involved
					FALSE ; Player is not involved
				aPreset
					PCmastery ; Mastery Act
					PCtraining ; Training Act
					PCsubmit ; Submit Act
					PCsperm ; Sperm Consume
					PCmilk ; Milk Consume
				Stat ; Stat Changed
					All ; Change Health, Magicka, Stamina
					Health ; Change Health
					Magicka ; Change Magicka
					Stamina ; Change Stamina
				drainC ; Is this a stat drain?
					TRUE ; Values will decrease stats
					FALSE ; Values will increase stats
				aMOD ; Calculates an added percentage gain or loss
				aEffect ; Overrides absorption/stat effects (set to 0 to use default)
				dReport ; Sends Notification for the player based on gain
					TRUE ; Send Report
					False ; Don't Send Report
			f. ANIMcalc ; Used to start animations through Succubus Heart (Applies gender locks)
				(string aPreset, actor[] sentActor, actor victimActor=none)
				aPreset ; Sets different modes for sorting
					0 ; Disabled
					Combat ; Used for Combat Seduction (inactive)
					Seduction ; Used for Seduction Spells (inactive)
				sentActor ; Array of actors in the act
				victimActor ; Actor that is considered victim (optional)
	SuH_SuQuest ; Handles Character Specific Succubus Effects not tied to spells
+ Common Scripts +
	Dynamic Scripts
		SuH_dyna_active ; Applies dynamic effects to NPCS (This manages all important script)
		SuH_dyna_applying ; Applues SuH_dyna_active to NPCS
		SuH_dyna_effect ; Used as dynamic cloaking to cover the surrounding area
		SuH_dyna_player ; Applies dynamic effects to the player (This manages all important script)
	SuH_comES_sperm ; Used to apply sperm effects
	SuH_comES_milk ; Used to apply milk effects
+ Global Variables +
	SuH_MODupdate ; MOD version
	SuH_PCSabsorbhealth ; Health Absorption Level (Player)
	SuH_PCSabsorbmagicka ; Magicka Absorption Level (Player)
	SuH_PCSabsorbstamina ; Stamina Absorption Level (Player)
	SuH_PCSspermhealth ; Sperm Health Gain Level (Player)
	SuH_PCSspermmagicka ; Sperm Magicka Gain Level (Player)
	SuH_PCSspermstamina ; Sperm Stamina Gain Level (Player)
	SuH_PCSmilkhealth ; Milk Health Gain Level (Player)
	SuH_PCSmilkmagicka ; Milk Magicka Gain Level (Player)
	SuH_PCSmilkstamina ; Milk Stamina Gain Level (Player)
	SuH_PCScaphealth ; Health Cap (Player)
	SuH_PCScapmagicka ; Magicka Cap (Player)
	SuH_PCScapstamina ; Stamina Cap (Player)
	SuH_PCSforce ; Force Collected which converts to SP
	SuH_PCSxp ; Heart XP
	SuH_PCSsp ; Heart SP
	SuH_PCSxpgain ; XP gain multiplier
	SuH_PCSxpearn ; Base XP earn value
	SuH_PCSspearned ; Total SP earned (Spent and un-Spent)
	SuH_SETallowdrainkill ; Setting, allow stat drain to kill targets
		1 = TRUE ; Kill targets if their Health drops below 1
		0 = FALSE ; Targets won't die from drain
	SuH_PCSdesire ; Gained over time and unlocks seduction spells (consumed during acts)
	SuH_PCSstacksex ; Sex Stacks increased with sex acts
	SuH_PCSstacksperm ; Sperm stacks increased by consuming sperm
	SuH_PCSstackmilk ; Sperm stacks increased by consuming milk
	SuH_PCSstackmaxsex ; Max Sex Stack obtainable
	SuH_PCSstackmaxsperm ; Max Sperm Stacks obtainable
	SuH_PCSstackmaxmilk ; Max Milk Stacks obtainable
	SuH_SETallowmalehomo ; Allows male homosexuals within Succubus Heart
		1 = TRUE ; Homosexual animations can be triggered by Succubus Heart
		0 = FALSE ; Homosexual animations won't be triggered by Succubus Heart
	SuH_SETallowfemalehomo ; Allows female homosexuals within Succubus Heart
		1 = TRUE ; Homosexual animations can be triggered by Succubus Heart
		0 = FALSE ; Homosexual animations won't be triggered by Succubus Heart
	SuH_SETcombatseduction ; Allows Combat Seduction (combat triggered animations)
		1 = TRUE ; Hits will trigger combat seduction checks
		0 = FALSE ; Hits won't trigger combat seduction checks
	SuH_SETnpc2npchealth ;Determines Health value where combat seduction triggers below
	SuH_SETnpc2pchealth ;Determines Health value where combat seduction triggers below
	SuH_SETpc2npchealth ;Determines Health value where combat seduction triggers below
+ Added Faction +
	SuH_Tracker ; Used in MODevents and dyna spells to capture animation events
+ Spells +
	SuH_sex_PCmastery
		SuH_sexE_PCmastery ; Applies PC Mastery effect
			s. SuH_sexES_PCmastery
				f. SuH_Fun.XPcalc
				f. SuH_Fun.STATcalc
	SuH_sex_PCtraining
		SuH_sexE_PCtraining ; Applies PC Traning Effect
			s. SuH_sexES_PCtraining
				f. SuH_Fun.XPcalc
				f. SuH_Fun.STATcalc
	SuH_sex_PCsubmit
		SuH_sexE_PCsubmit ; Applies PC Submit Effect
			s. SuH_sexES_PCsubmit
				f. SuH_Fun.XPcalc
				f. SuH_Fun.STATcalc
	SuH_sex_NPCattacker
		SuH_sexE_NPCattacker
			SuH_sexES_NPCattacker
	SuH_sex_NPCconsent
		SuH_sexE_NPCconsent
			SuH_sexES_NPCconsent
	SuH_sex_NPCvictim
		SuH_sexE_NPCvictim
			SuH_sexES_NPCvictim
+ ingredients +

Gameplay Objects

+ ingredients +
	SuH_ing_sperm ; General Sperm
	SuH_ing_milk ; General Milk
+ Spells +
	Sexual Enrage ; Sexual Enrage [Base] "Forces the target to rape the caster"
		SuH_spell_sexualenrage
			SuH_spellE_sexualenrage
				SuH_spellES_sexualenrage
	Focus Shot ; (Quick Damage Spell)
		[Base] ; 500 XP ("Consume 5 Max Stamina and deal 5 damage to the target")
		SuH_spell_focusshot_base
			SuH_spellE_focusshot_base
				SuH_spellES_focusshot_base
		[Drain] ; 3000 XP ("Consume 5 Max Stamina and deal 3 damage to the target while absorbing 1 health")
		SuH_spell_focusshot_drain
			SuH_spellE_focusshot_drain
				SuH_spellES_focusshot_drain
	Unnamed ; (High Damage Spell)
	
	Intimate Touch ; (Silent Touch Spell)
	
	Vital Drain ; (Draining Spell)
	
	Cursed Blood ; (Debuff / Cripple Skill)
	
	Unnamed ; (Recovery Spell)
	
Planned Objects

; [][][] Fill