Melvor Idle

Module:ItemEconomy/Sandbox: Difference between revisions

Module Discussion

Module:ItemEconomy/Sandbox (view source)

Revision as of 01:12, 18 March 2024

2,112 bytes added ,  18 March
no edit summary
No edit summary
No edit summary
 
(3 intermediate revisions by the same user not shown)
Line 24: Line 24:
}
}


-- Make constructor so external modules can more easily use the
--- Constructor function for creating new ItemEconomy instances.
-- ItemEconomy object, should they desire
-- @return ItemEconomy An instance of the ItemEconomy class.
function ItemEconomy:new()
function ItemEconomy:new()
     local newObj = {}
     local newObj = {}
Line 33: Line 33:
end
end


local function verifyEconomyValues(itemEconomy)
--- Verifies and updates the economy values of the ItemEconomy instance.
-- Set default values if some are nil
-- If any economy value is nil, it sets a default value.
itemEconomy.inputsPerAction = itemEconomy.inputsPerAction or 1
-- If any economy value is out of range, clamp it to the nearest valid range.
itemEconomy.outputsPerAction = itemEconomy.outputsPerAction or 1
-- @return ItemEconomy Returns a verified copy of the ItemEconomy object.
     itemEconomy.preservationChance = itemEconomy.preservationChance or 0
function ItemEconomy:getVerifiedEconomy()
     itemEconomy.duplicationChance = itemEconomy.duplicationChance or 0
local cpy = {}
     itemEconomy.extraItemChance = itemEconomy.extraItemChance or 0
    -- Set default values if some are nil
     itemEconomy.extraItemAmount = itemEconomy.extraItemAmount or 0
    cpy.inputsPerAction = self.inputsPerAction or 1
     itemEconomy.flatExtraItems = itemEconomy.flatExtraItems or 0
    cpy.outputsPerAction = self.outputsPerAction or 1
     itemEconomy.extraBaseItemChance = itemEconomy.extraBaseItemChance or 0
     cpy.preservationChance = self.preservationChance or 0
     itemEconomy.extraBaseItems = itemEconomy.extraBaseItems or 0
     cpy.duplicationChance = self.duplicationChance or 0
     cpy.extraItemChance = self.extraItemChance or 0
     cpy.extraItemAmount = self.extraItemAmount or 0
     cpy.flatExtraItems = self.flatExtraItems or 0
     cpy.extraBaseItemChance = self.extraBaseItemChance or 0
     cpy.extraBaseItems = self.extraBaseItems or 0
      
      
     -- Clamp economy values
     -- Clamp economy values (clamp the verified copy values)
     itemEconomy.preservationChance = number.clamp(itemEconomy.preservationChance, 0, 80) / 100
     cpy.preservationChanceP = number.clamp(cpy.preservationChance, 0, 80) / 100
     itemEconomy.duplicationChance = number.clamp(itemEconomy.duplicationChance, 0, 100) / 100
     cpy.duplicationChanceP = number.clamp(cpy.duplicationChance, 0, 100) / 100
     itemEconomy.extraItemChance = number.clamp(itemEconomy.extraItemChance, 0, 100) / 100
     cpy.extraItemChanceP = number.clamp(cpy.extraItemChance, 0, 100) / 100
     itemEconomy.extraBaseItemChance = number.clamp(itemEconomy.extraBaseItemChance, 0, 100) / 100
     cpy.extraBaseItemChanceP = number.clamp(cpy.extraBaseItemChance, 0, 100) / 100
      
      
     return itemEconomy
     return setmetatable(cpy, getmetatable(self))
end
end


--- Estimates the output multiplier of a crafting process based on ItemEconomy values.
--- Calculates a ratio between input to output.
-- @param itemEconomy (table) The ItemEconomy object containing ItemEconomy values.
-- @param itemEconomy (table) The ItemEconomy object containing ItemEconomy values.
-- @return (number) The estimated output multiplier of the crafting process.
-- @return (number) The output ratio of the crafting process.
function p.estimatedOutputMultiplier(itemEconomy)
function p.estimatedOutputMultiplier(itemEconomy)
return p.estimatedOutput(nil, inputPerAction, outputPerAction, itemEconomy)
local minOutput = p.estimatedOutput(nil, itemEconomy)
return minOutput / itemEconomy.inputsPerAction
end
end


Line 66: Line 72:
-- @return (number) The estimated output of the crafting process.
-- @return (number) The estimated output of the crafting process.
function p.estimatedOutput(inputAmount, itemEconomy)
function p.estimatedOutput(inputAmount, itemEconomy)
eco = verifyEconomyValues(itemEconomy)
local eco = itemEconomy:getVerifiedEconomy()


-- Equal inputAmount to inputsPerAction to get 1 baseAction
-- Equal inputAmount to inputsPerAction to get 1 baseAction
inputAmount = inputAmount or eco.inputsPerAction
inputAmount = inputAmount or eco.inputsPerAction
baseActions = math.floor(inputAmount / eco.inputsPerAction)
local baseActions = inputAmount / eco.inputsPerAction
-- Can't craft with what you don't have...
if inputAmount < eco.inputsPerAction then
return 0
end
-- Calculate the effective actions taken.
-- Calculate the effective actions taken.
local totalActions = baseActions / (1 - eco.preservationChance)
local totalActions = baseActions / (1 - eco.preservationChanceP)
-- Calculates extra items that can't be doubled.
-- Calculates extra items that can't be doubled.
local extraItems = (totalActions * eco.extraItemChance * eco.extraItemAmount) + (totalActions * eco.flatExtraItems)
local extraItems = (totalActions * eco.extraItemChanceP * eco.extraItemAmount) + (totalActions * eco.flatExtraItems)
-- Calculates extra items that CAN be doubled.
-- Calculates extra items that CAN be doubled.
local baseItems = (eco.outputsPerAction + eco.extraBaseItemChance * eco.extraBaseItems)
local baseItems = (eco.outputsPerAction + eco.extraBaseItemChanceP * eco.extraBaseItems)
-- Total output
-- Total output
return (totalActions * baseItems * (1 + eco.duplicationChance)) + extraItems
return (totalActions * baseItems * (1 + eco.duplicationChanceP)) + extraItems
end
end


function p.estimatedInput(outputAmount, preservationChance, duplicationChance, extraItemChance)
--- Calculates a ratio between output to input.
-- @param itemEconomy (table) The ItemEconomy object containing ItemEconomy values.
-- @return (number) The input ratio of the crafting process.
function p.estimatedInputMultiplier(itemEconomy)
-- I'm fairly certain that the following holds true in any case.
return 1 / p.estimatedOutputMultiplier(itemEconomy)
end


--- Estimates the input required for a given output amount in a crafting process based on ItemEconomy values.
-- This function provides a detailed breakdown of the calculation process.
-- @param outputAmount The total amount of output items desired.
-- @param itemEconomy The ItemEconomy object containing ItemEconomy values.
-- @return The estimated input required for the given output amount.
function p.estimatedInput(outputAmount, itemEconomy)
-- Again, fairly certain Input is just 1 / Output.
-- Replace with p.estimatedInputVerbose is this ever isn't the case.
local inputMultiplier =  1 / p.estimatedOutputMultiplier(itemEconomy)
return math.max(outputAmount * inputMultiplier, itemEconomy.inputsPerAction)
end
end


--
function p.estimatedInputVerbose(outputAmount, itemEconomy)
-- Calculates if equipping the Ring Of Wealth will result in more items for the player.
local eco = itemEconomy:getVerifiedEconomy()
-- PreservationChance (number from 0 - 80)
 
-- DuplicationChance (number from 0 - 100)
outputAmount = outputAmount or eco.outputsPerAction
-- ExtraItemChance (number from 0 - ?)
local preserveAmount = outputAmount * eco.inputsPerAction * (1 - eco.preservationChanceP)
--
local duplicateAmount = eco.outputsPerAction + eco.outputsPerAction * eco.duplicationChanceP
function p.ringOfWealthHasEffect(preservationChance, duplicationChance, extraItemChance)
local extraBaseItems = eco.extraBaseItemChanceP * eco.extraBaseItems + eco.extraBaseItemChanceP * eco.extraBaseItems * eco.duplicationChanceP
local extraItems = eco.extraItemChanceP * eco.extraItemAmount
 
-- Total input required for given output.
local actualInput = preserveAmount / (duplicateAmount + extraBaseItems + extraItems + eco.flatExtraItems)
return math.max(actualInput, eco.inputsPerAction)
end
 
--- Calculates if equipping the Ring Of Wealth will result in more items for the player.
-- @param itemEconomy The ItemEconomy object containing ItemEconomy values.
-- @return TRUE if the Ring of Wealth is more beneficial than harmful.
function p.ringOfWealthHasEffect(itemEconomy)
local rowEco = itemEconomy:getVerifiedEconomy()
-- Apply Ring of Wealth buffs.
rowEco.preservationChance = rowEco.preservationChance - 3
rowEco.duplicationChance = rowEco.duplicationChance + 7
local rowMultiplier = p.estimatedOutputMultiplier(rowEco)
local playerMultiplier = p.estimatedOutputMultiplier(itemEconomy)
return rowMultiplier > playerMultiplier
end
end


p.ItemEconomy = ItemEconomy
p.ItemEconomy = ItemEconomy


-- Test stuff....
function p.Test()
local eco = ItemEconomy:new()
eco.flatExtraItems = 0
eco.preservationChance = 0
eco.duplicationChance = 50
eco.extraBaseItems = 1
eco.extraBaseItemChance = 100
return p.estimatedOutput(1000, eco)
end
return p
return p
Ricewind
964

edits

Retrieved from "https://wiki.melvoridle.com/w/Special:MobileDiff/66371...66376"