WHM lua

-------------------------------------------------------------------------------------------------------------------
-- 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.

-- 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
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(4, 14)
end

-- Called when this job file is unloaded (eg: job change)
function file_unload()
	if binds_on_unload then
		binds_on_unload()
	end
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=gear.FastcastStaff,ammo="Incantor Stone",
		head="Piety Cap",neck="Orison Locket",ear2="Loquacious Earring",
		body="Marduk's Jubbah",hands="Piety Mitts",ring1="Prolix Ring",
		back="Swith Cape +1",waist="Witful Belt",legs="Piety Pantaloons",feet="Rostrum Pumps"}

	sets.precast.FC['Enhancing Magic'] = set_combine(sets.precast.FC, {waist="Siegel Sash"})

	sets.precast.FC.Stoneskin = set_combine(sets.precast.FC['Enhancing Magic'])

	sets.precast.FC['Healing Magic'] = set_combine(sets.precast.FC, {legs="Orison Pantaloons +2"})

	sets.precast.FC.StatusRemoval = sets.precast.FC['Healing Magic']

	sets.precast.FC.Cure = set_combine(sets.precast.FC['Healing Magic'], {main="Tamaxchi",sub="Genbu's Shield",body="Heka's Kalasiris",back="Pahtli Cape",waist="Cleric's Belt",feet="Litany Clogs"})

	sets.precast.FC.Curaga = sets.precast.FC.Cure

	-- Precast sets to enhance JAs
	sets.precast.JA.Benediction = {body="Piety Briault"}

	-- Waltz set (chr and vit)
	sets.precast.Waltz = {
		head="Nahtirah Hat",ear1="Roundel Earring",
		body="Vanir Cotehardie",hands="Yaoyotl Gloves",
		back="Refraction Cape",legs="Gendewitha Spats",feet="Gendewitha Galoshes"}


	-- 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 = {
		head="Nahtirah Hat",neck=gear.ElementalGorget,ear1="Bladeborn Earring",ear2="Steelflash Earring",
		body="Vanir Cotehardie",hands="Yaoyotl Gloves",ring1="Rajas Ring",ring2="K'ayres Ring",
		back="Refraction Cape",waist=gear.ElementalBelt,legs="Gendewitha Spats",feet="Gendewitha Galoshes"}

	sets.precast.WS['Flash Nova'] = {
		head="Nahtirah Hat",neck="Stoicheion Medal",ear1="Friomisi Earring",ear2="Hecate's Earring",
		body="Vanir Cotehardie",hands="Yaoyotl Gloves",ring1="Rajas Ring",ring2="Strendu Ring",
		back="Toro Cape",waist="Thunder Belt",legs="Gendewitha Spats",feet="Gendewitha Galoshes"}


	-- Midcast Sets

	sets.midcast.FastRecast = {
		head="Piety Cap",ear1="Gifted Earring",
		body="Piety Briault",hands="Piety Mitts",ring1="Prolix Ring",
		back="Swith Cape +1",waist="Witful Belt",legs="Piety Pantaloons",feet="Piety Duckbills"}

	-- Cure sets
	gear.default.obi_waist = "Cleric's Belt"
	gear.default.obi_back = "Orison Cape"

	sets.midcast.CureSolace = {main="Tamaxchi",sub="Genbu's Shield",ammo="Incantor Stone",
		head="Theophany Cap",neck="Orison Locket",ear2="Loquacious Earring",ear1="Orison Earring",
		body="Heka's Kalasiris",hands="Theophany Mitts",ring1="Prolix Ring",ring2="Sirona's Ring",
		back="Orison Cape",waist=gear.ElementalObi,legs="Piety Pantaloons",feet="Piety Duckbills"}

	sets.midcast.Cure = {main="Tamaxchi",sub="Genbu's Shield",ammo="Incantor Stone",
		head="Theophany Cap",neck="Orison Locket",ear2="Loquacious Earring",ear1="Orison Earring",
		body="Heka's Kalasiris",hands="Theophany Mitts",ring1="Prolix Ring",ring2="Sirona's Ring",
		back="Orison Cape",waist=gear.ElementalObi,legs="Piety Pantaloons",feet="Piety Duckbills"}

	sets.midcast.Curaga = {main="Tamaxchi",sub="Genbu's Shield",ammo="Incantor Stone",
		head="Theophany Cap",neck="Orison Locket",ear2="Loquacious Earring",ear1="Orison Earring",
		body="Heka's Kalasiris",hands="Theophany Mitts",ring1="Prolix Ring",ring2="Sirona's Ring",
		back="Orison Cape",waist=gear.ElementalObi,legs="Piety Pantaloons",feet="Piety Duckbills"}

	sets.midcast.CureMelee = {ammo="Incantor Stone",
		head="Theophany Cap",neck="Orison Locket",ear2="Loquacious Earring",ear1="Orison Earring",
		body="Vanir Cotehardie",hands="Theophany Mitts",ring1="Prolix Ring",ring2="Sirona's Ring",
		back="Tuilha Cape",waist=gear.ElementalObi,legs="Piety Pantaloons",feet="Piety Duckbills"}

	sets.midcast.Cursna = {main="Beneficus",sub="Genbu's Shield",
		head="Orison Cap +2",neck="Malison Medallion",
		body="Orison Bliaud +2",hands="Theophany Mitts",ring2="Ephedra Ring",ring1="Sirona's Ring",
		back="Swith Cape +1",waist="Witful Belt",legs="Theophany Pantaloons",feet="Orison Duckbills +2"}

	sets.midcast.StatusRemoval = {
		head="Orison Cap +2",legs="Orison Pantaloons +2"}

	-- 110 total Enhancing Magic Skill; caps even without Light Arts
	sets.midcast['Enhancing Magic'] = {main="Beneficus",sub="Genbu's Shield",
		head="Piety Cap",neck="Colossus's Torque",
		body="Heka's Kalasiris",hands="Theophany Mitts",
		back="Merciful Cape",waist="Olympus Sash",legs="Piety Pantaloons",feet="Orison Duckbills +2"}

	sets.midcast.Stoneskin = {
		head="Piety Cap",neck="Orison Locket",ear2="Loquacious Earring",
		body="Marduk's Jubbah",hands="Augur's Gloves",
		back="Swith Cape +1",waist="Siegel Sash",legs="Piety Pantaloons",feet="Piety Duckbills"}

	sets.midcast.Auspice = {hands="Augur's Gloves",feet="Orison Duckbills +2"}

	sets.midcast.BarElement = {main="Beneficus",sub="Genbu's Shield",
		head="Piety Cap",neck="Colossus's Torque",
		body="Orison Bliaud +2",hands="Augur's Gloves",
		back="Merciful Cape",waist="Olympus Sash",legs="Piety Pantaloons",feet="Orison Duckbills +2"}

	sets.midcast.Regen = {main="Tamaxchi",sub="Genbu's Shield",
		body="Piety Briault",hands="Orison Mitts +2",
		legs="Theophany Pantaloons"}

	sets.midcast.Protectra = {feet="Piety Duckbills"}

	sets.midcast.Shellra = {legs="Piety Pantaloons"}


	sets.midcast['Divine Magic'] = {main="Tamaxchi",sub="Genbu's Shield",
		head="Nefer Khat",neck="Colossus's Torque",ear1="Magnetic Earring",ear2="Loquacious Earring",
		body="Theophany Briault",hands="Piety Mitts",ring2="Mediator's Ring",ring1="Omega Ring",
		back="Altruistic Cape",waist=gear.ElementalObi,legs="Theophany Pantaloons",feet="Piety Duckbills"}

	sets.midcast['Dark Magic'] = {main="Tamaxchi", sub="Genbu's Shield",
		head="Nefer Khat",neck="Aesir Torque",ear1="Abyssal Earring",ear2="Loquacious Earring",
		body="Theophany Briault",hands="Piety Mitts",ring2="Mediator's Ring",ring1="Omega Ring",
		back="Merciful Cape",waist="Cleric's Belt",legs="Piety Pantaloons",feet="Piety Duckbills"}

	-- Custom spell classes
	sets.midcast.MndEnfeebles = {main="Tamaxchi", sub="Genbu's Shield",
		head="Theophany Cap",neck="Imbodla Necklace",ear1="Magnetic Earring",ear2="Loquacious Earring",
		body="Theophany Briault",hands="Piety Mitts",ring2="Mediator's Ring",ring1="Omega Ring",
		back="Altruistic Cape",waist="Cleric's Belt",legs="Piety Pantaloons",feet="Piety Duckbills"}

	sets.midcast.IntEnfeebles = {main="Tamaxchi", sub="Genbu's Shield",
		head="Theophany Cap",neck="Imbodla Necklace",ear1="Abyssal Earring",ear2="Loquacious Earring",
		body="Theophany Briault",hands="Piety Mitts",ring2="Mediator's Ring",ring1="Omega Ring",
		back="Altruistic Cape",waist="Cleric's Belt",legs="Piety Pantaloons",feet="Piety Duckbills"}


	-- Sets to return to when not performing an action.

	-- Resting sets
	sets.resting = {main=gear.Staff.HMP,
		body="Heka's Kalasiris",main="Boonwell Staff",hands="Serpentes Cuffs",
		waist="Cleric's Belt",legs="Nares Trews",head="Nefer Khat",neck="Eidolon Pendant",
		ear1="Relaxing Earring",ear2="Magnetic Earring",back="Vita Cape",ring1="Star Ring",ring2="Tamas Ring",
		feet="Serpentes Sabots"}


	-- Idle sets (default idle set not needed since the other three are defined, but leaving for testing purposes)
	sets.idle = {main="Terra's Staff", sub="Achaq Grip",ammo="Incantor Stone",
		head="Nefer Khat",neck="Orison Locket",ear1="Gifted Earring",ear2="Loquacious Earring",
		body="Heka's Kalasiris",hands="Serpentes Cuffs",ring1="Prolix Ring",ring2="Mediator's Ring",
		back="Pahtli Cape",waist="Cleric's Belt",legs="Nares Trews",feet="Serpentes Sabots"}

	sets.idle.PDT = {main="Terra's Staff", sub="Achaq Grip",ammo="Incantor Stone",
		head="Piety Cap",neck="Twilight Torque",ear1="Novia Earring",ear2="Medicine Earring",
		body="Piety Briault",hands="Piety Mitts",ring1="Jelly Ring",ring2="Kunaji Ring",
		back="Umbra Cape",waist="Witful Belt",legs="Piety Pantaloons",feet="Herald's Gaiters"}

	sets.idle.Town = {main="Terra's Staff", sub="Achaq Grip",ammo="Incantor Stone",
		head="Nefer Khat",neck="Orison Locket",ear1="Gifted Earring",ear2="Loquacious Earring",
		body="Heka's Kalasiris",hands="Serpentes Cuffs",ring1="Prolix Ring",ring2="Mediator's Ring",
		back="Pahtli Cape",waist="Cleric's Belt",legs="Nares Trews",feet="Herald's Gaiters"}

	sets.idle.Weak = {main="Terra's Staff", sub="Achaq Grip",ammo="Incantor Stone",
		head="Piety Cap",neck="Twilight Torque",ear1="Novia Earring",ear2="Medicine Earring",
		body="Piety Briault",hands="Piety Mitts",ring1="Jelly Ring",ring2="Kunaji Ring",
		back="Umbra Cape",waist="Witful Belt",legs="Piety Pantaloons",feet="Herald's Gaiters"}

	-- Defense sets

	sets.defense.PDT = {main=gear.Staff.PDT,sub="Achaq Grip",
		head="Gendewitha Caubeen",neck="Twilight Torque",
		body="Gendewitha Bliaut",hands="Gendewitha Gages",ring1="Dark Ring",ring2="Dark Ring",
		back="Umbra Cape",legs="Gendewitha Spats",feet="Gendewitha Galoshes"}

	sets.defense.MDT = {main=gear.Staff.PDT,sub="Achaq Grip",
		head="Nahtirah Hat",neck="Twilight Torque",
		body="Vanir Cotehardie",hands="Yaoyotl Gloves",ring1="Dark Ring",ring2="Shadow Ring",
		back="Tuilha Cape",legs="Bokwus Slops",feet="Gendewitha Galoshes"}

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

	-- 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 = {
		head="Nahtirah Hat",neck="Asperity Necklace",ear1="Bladeborn Earring",ear2="Steelflash Earring",
		body="Vanir Cotehardie",hands="Dynasty Mitts",ring1="Rajas Ring",ring2="K'ayres Ring",
		back="Umbra Cape",waist="Goading Belt",legs="Gendewitha Spats",feet="Gendewitha Galoshes"}


	-- Buff sets: Gear that needs to be worn to actively enhance a current player buff.
	sets.buff['Divine Caress'] = {hands="Orison Mitts +2",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

	if spell.skill == 'Healing Magic' then
		gear.default.obi_back = "Mending Cape"
	else
		gear.default.obi_back = "Toro Cape"
	end
end


-- Set eventArgs.handled to true if we don't want any automatic gear equipping to be done.
function job_midcast(spell, action, spellMap, eventArgs)
	if spell.action_type == 'Magic' then
		-- Default base equipment layer of fast recast.
		equip(sets.midcast.FastRecast)
	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 not spell.interrupted then
		if state.Buff[spell.name] ~= nil then
			state.Buff[spell.name] = true
		elseif spell.name == "Afflatus Misery" then
			state.Buff['Afflatus Solace'] = false
		end
	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


-------------------------------------------------------------------------------------------------------------------
-- 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)
	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.
-------------------------------------------------------------------------------------------------------------------