view Modules/Api.lua @ 75:8882af8f932c

Added tag release 2010-07-29 for changeset 71de6e86a1a4
author Asa Ayers <Asa.Ayers@Gmail.com>
date Thu, 29 Jul 2010 22:36:50 -0700
parents cd00b87fad31
children 63823b6b5e28
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

--@debug@
-- This is here so I have a second option in the menu and to serve as an example.
local function testDestination(data)
	ItemAuditor:Print('queue: '..data.recipeLink)
end

IAapi.RegisterQueueDestination('Echo', testDestination)
--@end-debug@