Module:Item/Food

Module documentation[view][edit][history][purge]

This documentation is transcluded from Module:Item/Food/doc. Changes can be proposed in the talk page.

Module:Item/Food is shared across the Star Citizen Wikis.

This module is shared across the Star Citizen Wikis. Any changes should also be relayed to the GitHub repository.

Module:Item/Food loads messages from Module:Item/Food/i18n.json.

This module is designed to be language-neutral. All of the messages are saved in the i18n.json subpage.

This module is unused.

This module is neither invoked by a template nor required/loaded by another module. If this is in error, make sure to add {{Documentation}}/{{No documentation}} to the calling template's or parent's module documentation.

Module:Item/Food requires Module:Common/SMW, Module:Translate, and strict.

Module:Item/Food loads data from Module:Item/Food/data.json and Module:Item/config.json.

ExpandFunction list
L 32 — translate L 36 — multilingualIfActive L 61 — methodtable.addSmwProperties L 87 — methodtable.addSmwAskProperties L 97 — methodtable.addInfoboxData L 125 — Food.new

---

require( 'strict' )

local Food = {}


local metatable = {}
local methodtable = {}

metatable.__index = methodtable


local TNT = require( 'Module:Translate' ):new()
local data = mw.loadJsonData( 'Module:Item/Food/data.json' )
-- Intentionally re-use the config from Module:Item
local config = mw.loadJsonData( 'Module:Item/config.json' )


local lang
if config.module_lang then
    lang = mw.getLanguage( config.module_lang )
else
    lang = mw.getContentLanguage()
end


--- FIXME: This should go to somewhere else, like Module:Common
--- Calls TNT with the given key
---
--- @param key string The translation key
--- @param addSuffix boolean Adds a language suffix if config.smw_multilingual_text is true
--- @return string If the key was not found in the .tab page, the key is returned
local function translate( key, addSuffix, ... )
    addSuffix = addSuffix or false
    local success, translation

    local function multilingualIfActive( input )
        if addSuffix and config.smw_multilingual_text == true then
            return string.format( '%s@%s', input, config.module_lang or mw.getContentLanguage():getCode() )
        end

        return input
    end

    if config.module_lang ~= nil then
        success, translation = pcall( TNT.formatInLanguage, config.module_lang, 'Module:Item/Food/i18n.json', key or '', ... )
    else
        success, translation = pcall( TNT.format, 'Module:Item/Food/i18n.json', key or '', ... )
    end

    if not success or translation == nil then
        return multilingualIfActive( key )
    end

    return multilingualIfActive( translation )
end


--- Adds the properties valid for this item to the SMW Set object
---
--- @param smwSetObject table
function methodtable.addSmwProperties( self, smwSetObject )
    local smwCommon = require( 'Module:Common/SMW' )

    smwCommon.addSmwProperties(
        self.apiData,
        self.frameArgs,
        smwSetObject,
        translate,
        config,
        data,
        'Item/Food'
    )

    --- Not sure if size matters, not like there is a S12 Double Dog
    --- FIXME: SMW_Size is from Module:Item, I made a duplicated entry in Module:Item/Food/i18n.json to make this work
    smwSetObject[ translate( 'SMW_Size' ) ] = nil

    --- We only know whether the item is single use or not
    if smwSetObject[ translate( 'SMW_Uses' ) ] == true then
        smwSetObject[ translate( 'SMW_Uses' ) ] = 1
    else
        smwSetObject[ translate( 'SMW_Uses' ) ] = nil
    end
end


function methodtable.addSmwAskProperties( self, smwAskObject )
    require( 'Module:Common/SMW' ).addSmwQueryParams(
        smwAskObject,
        translate,
        config,
        data
    )
end


function methodtable.addInfoboxData( self, infobox, smwData )
    infobox:renderSection( {
        title = translate( 'LBL_Usage' ),
		content = {
            infobox:renderItem( {
				label = translate( 'LBL_Effects' ),
				data = infobox.tableToCommaList( smwData[ translate( 'SMW_Effects' ) ] ),
                colspan = 2
			} ),
            infobox:renderItem( {
				label = translate( 'LBL_NutritionalDensityRating' ),
				data = smwData[ translate( 'SMW_NutritionalDensityRating' ) ],
			} ),
            infobox:renderItem( {
				label = translate( 'LBL_HydrationEfficacyIndex' ),
				data = smwData[ translate( 'SMW_HydrationEfficacyIndex' ) ],
			} ),
            infobox:renderItem( {
				label = translate( 'LBL_ConsumptionCount' ),
				data = smwData[ translate( 'SMW_ConsumptionCount' ) ],
			} )
		},
		col = 4
	} )
end


--- New Instance
function Food.new( self, apiData, frameArgs )
    local instance = {
        apiData = apiData,
        frameArgs = frameArgs
    }

    setmetatable( instance, metatable )

    return instance
end


return Food