view Modules/Api.lua @ 97:028c02f1d47f

Ticket 29 - Changed the Insufficient COD alert to use a case-insensitive comparison on character names.
author Asa Ayers <Asa.Ayers@Gmail.com>
date Sat, 14 Aug 2010 06:23:41 -0700
parents 1fbbe3b53f6e
children
line wrap: on
line source
local ItemAuditor = select(2, ...)

local Crafting = ItemAuditor:GetModule("Crafting")

IAapi = {}

--[[
	You can register a callback here to influence which items will get crafted and how many.
	The decider function needs to return the number of items the user should have in their
	inventory. If the number owned is less than the highest decided number, that item will
	be queued to be crafted unless any decider vetos the item.
	
	There is no way to unregister your decider but it can be overwritten with a function that simply returns 0.
	
	Please make sure your decider runs as fast as possible, It will be called at least once
	for every tradeskill being considered.
	
	I find the (non) word "Decider" to be amusing, so I used it.
	
	ItemAuditor will veto any item that costs more to create than it will sell for, It will also
	queue one of every item that is profitable. If you simply wanted to increase that to 5 of every
	profitable item you could use this:
	
	IAapi.RegisterCraftingDecider('Five', function() return 5 end)
]]
function IAapi.RegisterCraftingDecider(name, decider, optionsTable)
	assert(type(name) == 'string', 'name must be a string to identify your addon. This will be displayed to the user.')
	assert(type(decider) == 'function', 'decider must be a function.')
	assert(optionsTable == nil or type(optionsTable) == 'table')
	Crafting.RegisterCraftingDecider(name, decider, optionsTable)
end

function IAapi.RegisterQueueDestination(name, destination)
	assert(type(name) == 'string', 'name must be a string to identify your addon. This will be displayed to the user.')
	assert(type(destination) == 'function', 'destination must be a function that will be called for each item when exporting the queue.')
	
	Crafting.RegisterQueueDestination(name, destination)
end

function IAapi.UnRegisterQueueDestination(name)
	assert(type(name) == 'string', 'name must be the string that was used to register your addon.')
	Crafting.UnRegisterQueueDestination(name)
end

function IAapi.GetItemCost(link)
	assert(link, 'usage: IAapi.GetItemCost(itemLink)')
	return ItemAuditor:GetItemCost(link)
end



local function registerLoadedAddons()
	return ItemAuditor_RegisterAPI and ItemAuditor_RegisterAPI()
end
registerLoadedAddons()


-- This is here so I have a second option in the menu and to serve as an example of
-- how to register your addon with ItemAuditor.
--@debug@
local function RegisterWithItemAuditor()
	local function testDestination(data)
		-- Replace this with a call to the methods you need in your addon
		ItemAuditor:Print('queue: '..data.recipeLink)
	end
	-- Replace Echo with the name of your addon so it can be selected from /ia options
	IAapi.RegisterQueueDestination('Echo', testDestination)
end

if IAapi then
	RegisterWithItemAuditor()
else
	-- make sure to save any other addon's function
	local original = ItemAuditor_RegisterAPI
	-- this should not be local so it replaces (or creates) the global function
	function ItemAuditor_RegisterAPI()
		RegisterWithItemAuditor()
		-- if original has a value (function), this will run it
		return original and original()
	end
end




--@end-debug@