76561197969631737: removed unnecessary whitespace

2023-11-18T04:42:08Z

removed unnecessary whitespace

← Older revision		Revision as of 04:42, 18 November 2023
Line 23:		Line 23:
	<pre>		<pre>
	longDescription = GoodsData.getGoodDescription(goodName)		longDescription = GoodsData.getGoodDescription(goodName)

	inventoryCategory = GoodsData.getGoodCategory(goodName)		inventoryCategory = GoodsData.getGoodCategory(goodName)

	isEatable = GoodsData.isGoodEatable(goodName)		isEatable = GoodsData.isGoodEatable(goodName)

	isBurnable = GoodsData.isGoodBurnable(goodName)		isBurnable = GoodsData.isGoodBurnable(goodName)

	burnSeconds = GoodsData.getGoodBurnTime(goodName)		burnSeconds = GoodsData.getGoodBurnTime(goodName)

	amberSellValue, amberBuyValue = GoodsData.getGoodValue(goodName)		amberSellValue, amberBuyValue = GoodsData.getGoodValue(goodName)

	iconFilename = GoodsData.getGoodIcon(goodName)		iconFilename = GoodsData.getGoodIcon(goodName)
	</pre>		</pre>

76561197969631737: Copied luadoc into module/doc page

2023-11-16T23:57:04Z

Copied luadoc into module/doc page

New page

== Overview ==

Module for compiling goods (or resources as some call them) information
from wiki data sources. Restructures the flat data tables that are produced
from CsvUtils to make them more conducive to Lua methods that need to
display the information.

== Usage ==

The standard way of using this module is a call like the following:

<pre>
iconFilename = GoodsData.getGoodIcon(goodName)
</pre>

This will return a string corresponding to the filename of the good, including
the '''.png''' extension. It is preferable to call the getter methods with the
name of the good rather than retrieving the entire record for the good, so that
your code stays protected from any variations in this module. The getter
methods are all called with the plain-language name of the good, as spelled in
the game.

<pre>
longDescription = GoodsData.getGoodDescription(goodName)

inventoryCategory = GoodsData.getGoodCategory(goodName)

isEatable = GoodsData.isGoodEatable(goodName)

isBurnable = GoodsData.isGoodBurnable(goodName)

burnSeconds = GoodsData.getGoodBurnTime(goodName)

amberSellValue, amberBuyValue = GoodsData.getGoodValue(goodName)

iconFilename = GoodsData.getGoodIcon(goodName)
</pre>

As a last resort, or if you need to transform the data structure, you can
call the method <code>getAllDataForGood(displayName)</code>. This returns a whole record
from the data table corresponding to the requested display name.

The data table for goods has the following structure:

<pre>
goodsTable = {
["good1_ID"] = {
["id"] = "good1_ID",
["displayName"] = "Plain Language Name",
["description"] = "A long string with some HTML entities too.",
["category"] = "Inventory category",
["eatable"] = true or false if food
["canBeBurned"] = true or false if fuel and sacrifice
["burningTime"] = 99, number of seconds
["tradingSellValue"] = 99.99, in amber
["tradingBuyValue"] = 99.99, in amber
["iconName"] = "Icon_Resource_filename.png" including PNG extension
},
["good2_ID"] = {
...
},
["good3_ID"] = {
...
},
...
}
</pre>

Module:GoodsData/doc - Revision history

76561197969631737: removed unnecessary whitespace

76561197969631737: Copied luadoc into module/doc page