On Healing Hands - A Comprehensive WHM Guide (V2)

-------------------------------------------------------------------------------------------------------------------
-- Initialization function that defines sets and variables to be used.
-------------------------------------------------------------------------------------------------------------------

-- IMPORTANT: Make sure to also get the Mote-Include.lua file (and its supplementary files) to go with this.
send_command('unbind ^`')
send_command('unbind ^1')
send_command('unbind ^2')
send_command('unbind ^%numpad0')
send_command('unbind ^%numpad1')
send_command('unbind ^c')
send_command('unbind ^d')
send_command('unbind ^e')
send_command('unbind ^s')
send_command('bind ^` input /ma "Aurorastorm" <me>')
send_command('bind ^1 input /ja "Sublimation" <me>')
send_command('bind ^2 input /ja "Divine Caress" <me>;wait 1.2;input /ja "Accession" <me>')
send_command('bind ^%numpad0 input /ja "Penury" <me>')
send_command('bind ^%numpad1 input /ja "Celerity" <me>')
send_command('bind ^c input /ja "Divine Caress" <me>')
send_command('bind ^d input /ja "Divine Seal" <me>')
send_command('bind ^e input /ma "Esuna" <me>')
send_command('bind ^s input /ja "Sacrosanctity" <me>')




-- Initialization function for this job file.
function get_sets()
	-- Load and initialize the include file.
	include('Mote-Include.lua')
end

-- Setup vars that are user-independent.
function job_setup()
	state.Buff['Afflatus Solace'] = buffactive['Afflatus Solace'] or false
	state.Buff['Afflatus Misery'] = buffactive['Afflatus Misery'] or false
end

-- Setup vars that are user-dependent.  Can override this function in a sidecar file.
function user_setup()
	-- Options: Override default values
	options.OffenseModes = {'None', 'Normal'}
	options.DefenseModes = {'Normal'}
	options.WeaponskillModes = {'Normal'}
	options.CastingModes = {'Normal', 'Resistant', 'Dire'}
	options.IdleModes = {'Normal', 'PDT'}
	options.RestingModes = {'Normal'}
	options.PhysicalDefenseModes = {'PDT'}
	options.MagicalDefenseModes = {'MDT'}
	
	state.Defense.PhysicalMode = 'PDT'
	state.OffenseMode = 'None'


	-- Default macro set/book
	set_macro_page(2, 19)
end


-- Define sets and vars used by this job file.
function init_gear_sets()
	--------------------------------------
	-- Start defining the sets
	--------------------------------------
	
	-- Precast Sets

	-- Fast cast sets for spells
	sets.precast.FC = {main="Queller rod",ammo="Sapience orb",
		head="Nahtirah Hat",neck="Orunmila's torque",ear1="Enchanter's earring +1",ear2="Loquacious Earring",
		body="Anhur Robe",hands="Fanatic gloves",ring1="Weather. ring",ring2="Prolix Ring",
		back="Swith Cape +1",waist="Witful Belt",legs="Artsieq hose",feet="Regal pumps +1"}
		
	sets.precast.FC['Enhancing Magic'] = set_combine(sets.precast.FC, {})

	sets.precast.FC.Stoneskin = set_combine(sets.precast.FC['Enhancing Magic'], {})
	
	sets.precast.FC.Arise = set_combine(sets.precast.FC, {legs="Ebers pant. +1"})
	sets.precast.FC.Raise = set_combine(sets.precast.FC, {legs="Ebers pant. +1"})
	
	sets.precast.FC['Healing Magic'] = set_combine(sets.precast.FC, {legs="Ebers Pant. +1"})

	sets.precast.FC.StatusRemoval = set_combine(sets.precast.FC, {legs="Ebers pant. +1"})

	sets.precast.FC.Cure = set_combine(sets.precast.FC['Healing Magic'], {main="Queller rod",ear2="Nourish. earring +2",legs="Ebers pant. +1"})

	sets.precast.FC.Curaga = sets.precast.FC.Cure
	
	-- Precast sets to enhance JAs
	sets.precast.JA.Benediction = {body="Piety Briault +1"}
	sets.precast.JA.Devotion = {}
	
	-- Waltz set (chr and vit)
	sets.precast.Waltz = {}
	
	
	-- Weaponskill sets

	-- Default set for any weaponskill that isn't any more specifically defined
	gear.default.weaponskill_neck = "Asperity Necklace"
	gear.default.weaponskill_waist = ""
	sets.precast.WS = {}
	
	sets.precast.WS['Flash Nova'] = {}
	

	-- Midcast Sets
	
	sets.midcast.FastRecast = {head="Nahtirah Hat",neck="Orunmila's torque",ear1="Enchanter's earring +1",ear2="Loquacious Earring",
		body="Anhur Robe",hands="Fanatic gloves",ring1="Weatherspoon ring",ring2="Prolix Ring",
		back="Swith Cape +1",waist="Witful Belt",legs="Telchine braconi",feet="Regal pumps +1"}
	
	-- Cure sets
	gear.default.obi_waist = "Pythia sash +1"
	gear.default.obi_weapon = "Queller rod"
	gear.default.grip = "Genbu's shield" -- not functioning --
	gear.default.obi_back = "Mending Cape"

	sets.midcast.CureSolace = {		
		main=gear.ElementalWeapon,
		sub=gear.ElementalGrip,
		ammo="Homiliary",
		head="Gende. Caubeen",
		neck="Nodens gorget",
		ear1="Glorious earring",
		ear2="Nourish. earring +1",
		body="Ebers bliaud +1",
		hands="Kaykaus cuffs",
		ring1="Kuchekula ring",
		ring2="Sirona's ring",
		back=gear.ElementalCape,
		waist=gear.ElementalObi,
		legs="Ebers pant. +1",
		feet="Kaykaus boots"}
		
	sets.midcast.Cure = {		
		main=gear.ElementalWeapon,
		sub=gear.ElementalGrip,
		ammo="Homiliary",
		head="Gende. Caubeen",
		neck="Nodens gorget",
		ear1="Glorious earring",
		ear2="Nourish. earring +1",
		body="Ebers bliaud +1",
		hands="Kaykaus cuffs",
		ring1="Kuchekula ring",
		ring2="Sirona's ring",
		back=gear.ElementalCape,
		waist=gear.ElementalObi,
		legs="Ebers pant. +1",
		feet="Kaykaus boots"}	

	sets.midcast.Curaga = {		
		main=gear.ElementalWeapon,
		sub=gear.ElementalGrip,
		ammo="Homiliary",
		head="Gende. caubeen",
		neck="Nodens gorget",
		ear1="Glorious earring",
		ear2="Nourish. earring +1",
		body="Ebers bliaud +1",
		hands="Kaykaus cuffs",
		ring1="Kuchekula ring",
		ring2="Sirona's ring",
		back=gear.ElementalCape,
		waist=gear.ElementalObi,
		legs="Ebers pant. +1",
		feet="Kaykaus boots"}

	sets.midcast.CureMelee = {main="Queller rod",
		head="Gende. caubeen",neck="Nodens gorget",ear1="Glorious earring",ear2="Nourishing earring +1",
		body="Ebers bliaud +1",hands="Kaykaus cuffs",ring1="Kuchekula ring",ring2="Sirona's ring",
		back="Mending Cape",waist=gear.ElementalObi,legs="Ebers pant. +1",feet="Kaykaus boots"}

	sets.midcast.Cursna = {main="Beneficus",ammo="Homiliary",
		head="Ebers cap +1",neck="Malison Medallion",
		body="ebers briault +1",hands="fanatic gloves",ring1="Haoma's Ring",ring2="Haoma's Ring",
		back="Mending Cape",legs="Theo. pant. +1"}

	sets.midcast.StatusRemoval = {
		head="Ebers cap +1",legs="Ebers Pant. +1"}

	-- 110 total Enhancing Magic Skill; caps even without Light Arts
	sets.midcast['Enhancing Magic'] = {		
		main="Beneficus",
		ammo="Homiliary",
		head="Befouled crown",
		neck="Enhancing torque",
		body="Anhur robe",
		back="Mending Cape",
		legs="piety pantaln. +1",
		feet="Ebers duckbills"}

	sets.midcast.Stoneskin = {ammo="Homiliary",head="Befouled crown",neck="Nodens gorget",body="Anhur robe",legs="piety pantaln. +1",feet="Ebers duckbills"}
		
	sets.midcast.Aquaveil = {main="Beneficus",head="Befouled crown",body="Anhur robe",back="Mending Cape",legs="piety pantaln. +1",feet="Ebers duckbills +1"}

	sets.midcast.Auspice = {main="Beneficus",head="Befouled crown",body="Anhur robe",back="Mending Cape",legs="piety pantaln. +1",feet="Ebers duckbills +1"}
	sets.midcast.Aurorastorm = {main="Beneficus",head="Befouled crown",body="Anhur robe",back="Mending Cape",legs="piety pantaln. +1",feet="Ebers duckbills +1"}
	
	sets.midcast.BarElement = {		
		main="Beneficus",
		sub="Genbu's Shield",
		ammo="Homiliary",
		head="Ebers cap +1",
		body="ebers briault +1",
		hands="ebers mitts +1",
		back="Mending Cape",
		legs="piety pantaln. +1",
		feet="Ebers duckbills"}

	sets.midcast.Haste = {}
	
	sets.midcast.Regen = {main="Bolelabunga",
		body="Piety briault +1",hands="Ebers mitts +1",legs="Theo. pant. +1"}

	sets.midcast.Protectra = {}

	sets.midcast.Shellra = {"piety pantaln. +1"}

	sets.midcast['Divine Magic'] = {}
		
	sets.midcast['Repose'] = {}
		
	sets.midcast['Elemental Magic'] = {}

	sets.midcast['Dark Magic'] = {}

	-- Custom spell classes
	sets.midcast.MndEnfeebles = {}

	sets.midcast.IntEnfeebles = {}

	
	-- Sets to return to when not performing an action.
	
	-- Resting sets
	sets.resting = {		
		main="Queller rod",
		sub="Genbu's shield",
		ammo="Homiliary",
		head="Befouled crown",
		neck="Twilight torque",
		ear1="Moonshade Earring",
		ear2="Nourishing earring +1",
		body="Witching robe",
		hands="Serpentes Cuffs",
		ring1="Weatherspoon ring",
		ring2="Defending Ring",
		back="Umbra cape",
		waist="Fucho-no-Obi",
		legs="Assid. Pants +1",
		feet="Serpentes Sabots"}
	

	-- Idle sets (default idle set not needed since the other three are defined, but leaving for testing purposes)
	sets.idle = {		
		main="Queller rod",
		sub="Genbu's shield",
		ammo="Homiliary",
		head="Befouled crown",
		neck="Twilight torque",
		ear1="Glorious Earring",
		ear2="Moonshade Earring",
		body="Witching robe",
		hands="Serpentes Cuffs",
		ring2="Defending ring",
		ring1="Weather. Ring",
		back="Umbra cape",
		waist="Fucho-no-Obi",
		legs="Assid. Pants +1",
		feet="Serpentes Sabots"}

	sets.idle.PDT = {		
		main="Queller rod",
		sub="Genbu's shield",
		ammo="Homiliary",
		head="Befouled crown",
		neck="Twilight torque",
		ear1="Glorious Earring",
		ear2="Moonshade Earring",
		body="Witching robe",
		hands="Serpentes Cuffs",
		ring2="Defending ring",
		ring1="Weather. Ring",
		back="Umbra cape",
		waist="Fucho-no-Obi",
		legs="Assid. Pants +1",
		feet="Serpentes Sabots"}

	sets.idle.Town = {		
		main="Queller rod",
		sub="Genbu's shield",
		ammo="Homiliary",
		head="Befouled crown",
		neck="Twilight torque",
		ear1="Glorious Earring",
		ear2="Moonshade Earring",
		body="Councilor's garb",
		hands="Serpentes Cuffs",
		ring2="Defending ring",
		ring1="Weather. Ring",
		back="Umbra cape",
		waist="Fucho-no-Obi",
		legs="Assid. Pants +1",
		feet="Herald's Gaiters"}
	
	sets.idle.Weak = {		
		main="Queller rod",
		sub="Genbu's shield",
		ammo="Homiliary",
		head="Befouled crown",
		neck="Twilight torque",
		ear1="Glorious Earring",
		ear2="Moonshade Earring",
		body="Witching robe",
		hands="Serpentes Cuffs",
		ring2="Defending ring",
		ring1="Weatherspoon Ring",
		back="Umbra cape",
		waist="Fucho-no-Obi",
		legs="Assid. Pants +1",
		feet="Serpentes Sabots"}
		
	-- Defense sets

	sets.defense.PDT = {		
		main="Queller rod",
		sub="Genbu's shield",
		ammo="Homiliary",
		head="Befouled crown",
		neck="Twilight torque",
		ear1="Moonshade Earring",
		ear2="Nourishing earring +1",
		body="Witching robe",
		hands="Serpentes Cuffs",
		ring2="Defending ring",
		ring1="Haoma's Ring",
		back="Umbra cape",
		waist="Fucho-no-Obi",
		legs="Assid. Pants +1",
		feet="Serpentes Sabots"}

	sets.defense.MDT = {		
		main="Queller rod",
		sub="Genbu's shield",
		ammo="Homiliary",
		head="Befouled crown",
		neck="Twilight torque",
		ear1="Moonshade Earring",
		ear2="Nourishing earring +1",
		body="Witching robe",
		hands="Serpentes Cuffs",
		ring2="Defending ring",
		ring1="Haoma's Ring",
		back="Umbra cape",
		waist="Fucho-no-Obi",
		legs="Assid. Pants +1",
		feet="Serpentes Sabots"}

	sets.Kiting = {feet="Herald's Gaiters"}

    sets.latent_refresh = {waist="Fucho-no-obi"}

	-- Engaged sets

	-- Variations for TP weapon and (optional) offense/defense modes.  Code will fall back on previous
	-- sets if more refined versions aren't defined.
	-- If you create a set with both offense and defense modes, the offense mode should be first.
	-- EG: sets.engaged.Dagger.Accuracy.Evasion
	
	-- Basic set for if no TP weapon is defined.
	sets.engaged = {}


	-- Buff sets: Gear that needs to be worn to actively enhance a current player buff.
	sets.buff['Divine Caress'] = {hands="Ebers mitts +1",back="Mending Cape"}
end

-------------------------------------------------------------------------------------------------------------------
-- Job-specific hooks that are called to process player actions at specific points in time.
-------------------------------------------------------------------------------------------------------------------

-- Set eventArgs.handled to true if we don't want any automatic gear equipping to be done.
-- Set eventArgs.useMidcastGear to true if we want midcast gear equipped on precast.
function job_precast(spell, action, spellMap, eventArgs)
	if spell.english == "Paralyna" and buffactive.Paralyzed then
		-- no gear swaps if we're paralyzed, to avoid blinking while trying to remove it.
		eventArgs.handled = true
	end
	
	local map = spell_maps[spell.en]
 
    if map == 'Cure' and player.sub_job == "SCH" and not buffactive.Aurorastorm then
        add_to_chat(123,'Aurorastorm not active.')
		windower.play_sound('C:\\Program Files (x86)\\Windower4\\addons\\GearSwap\\data\\wav\\Chime.wav')
    end
	
	if map == 'Curaga' and player.sub_job == "SCH" and not buffactive.Aurorastorm then
        add_to_chat(123,'Aurorastorm not active.')
		windower.play_sound('C:\\Program Files (x86)\\Windower4\\addons\\GearSwap\\data\\wav\\Chime.wav')
    end
	
	if spell.skill == 'Healing Magic' then
		gear.default.obi_back = "Mending Cape"
		gear.default.obi_waist = "Pythia sash +1"
	else
		gear.default.obi_waist = "Eschan stone"
		gear.default.obi_back = "Toro Cape"
	end

	if state.Buff[spell.english] ~= nil then
		state.Buff[spell.english] = true
	end
end

function job_post_midcast(spell, action, spellMap, eventArgs)
	-- Apply Divine Caress boosting items as highest priority over other gear, if applicable.
	if spellMap == 'StatusRemoval' and buffactive['Divine Caress'] then
		equip(sets.buff['Divine Caress'])
	end
end


-- Return true if we handled the aftercast work.  Otherwise it will fall back
-- to the general aftercast() code in Mote-Include.
function job_aftercast(spell, action, spellMap, eventArgs)
	if state.Buff[spell.english] ~= nil then
		state.Buff[spell.english] = not spell.interrupted or buffactive[spell.english]
	end
end


-------------------------------------------------------------------------------------------------------------------
-- Customization hooks for idle and melee sets, after they've been automatically constructed.
-------------------------------------------------------------------------------------------------------------------

-- Custom spell mapping.
function job_get_spell_map(spell, default_spell_map)
	if spell.action_type == 'Magic' then
		if (default_spell_map == 'Cure' or default_spell_map == 'Curaga') and player.status == 'Engaged' then
			return "CureMelee"
		elseif default_spell_map == 'Cure' and state.Buff['Afflatus Solace'] then
			return "CureSolace"
		elseif spell.skill == "Enfeebling Magic" then
			if spell.type == "WhiteMagic" then
				return "MndEnfeebles"
			else
				return "IntEnfeebles"
			end
		end
	end
end


function customize_idle_set(idleSet)
    if player.mpp < 51 then
        idleSet = set_combine(idleSet, sets.latent_refresh)
    end
	return idleSet
end


-------------------------------------------------------------------------------------------------------------------
-- General hooks for other events.
-------------------------------------------------------------------------------------------------------------------

-- Called when a player gains or loses a buff.
-- buff == buff gained or lost
-- gain == true if the buff was gained, false if it was lost.
function job_buff_change(buff, gain)
	if state.Buff[buff] ~= nil then
		state.Buff[buff] = gain
	end
end


-------------------------------------------------------------------------------------------------------------------
-- User code that supplements self-commands.
-------------------------------------------------------------------------------------------------------------------

-- Called by the 'update' self-command.
function job_update(cmdParams, eventArgs)
	if cmdParams[1] == 'user' and not areas.Cities:contains(world.area) then
		local needsArts = 
			player.sub_job:lower() == 'sch' and
			not buffactive['Light Arts'] and
			not buffactive['Addendum: White'] and
			not buffactive['Dark Arts'] and
			not buffactive['Addendum: Black']
			
		if not buffactive['Afflatus Solace'] and not buffactive['Afflatus Misery'] then
			if needsArts then
				send_command('@input /ja "Afflatus Solace" <me>;wait 1.2;input /ja "Light Arts" <me>')
			else
				send_command('@input /ja "Afflatus Solace" <me>')
			end
		end
	end
end


-- Handle notifications of general user state change.
function job_state_change(stateField, newValue, oldValue)
	if stateField == 'OffenseMode' then
		if newValue == 'Normal' then
			disable('main','sub')
		else
			enable('main','sub')
		end
	elseif stateField == 'Reset' then
		if state.OffenseMode == 'None' then
			enable('main','sub')
		end
	end
end


-- Function to display the current relevant user state when doing an update.
-- Return true if display was handled, and you don't want the default info shown.
function display_current_job_state(eventArgs)
	local defenseString = ''
	if state.Defense.Active then
		local defMode = state.Defense.PhysicalMode
		if state.Defense.Type == 'Magical' then
			defMode = state.Defense.MagicalMode
		end

		defenseString = 'Defense: '..state.Defense.Type..' '..defMode..', '
	end
	
	local meleeString = ''
	if state.OffenseMode == 'Normal' then
		meleeString = 'Melee: Weapons locked, '
	end

	add_to_chat(122,'Casting ['..state.CastingMode..'], '..meleeString..'Idle ['..state.IdleMode..'], '..defenseString..
		'Kiting: '..on_off_names[state.Kiting])

	eventArgs.handled = true
end

-------------------------------------------------------------------------------------------------------------------
-- Utility functions specific to this job.
-------------------------------------------------------------------------------------------------------------------