This documentation is transcluded from Module:ItemPorts/doc. Changes can be proposed in the talk page.
Module:ItemPorts 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:ItemPorts loads configuration from Module:ItemPorts/config.json.
This module can be configurated from the config.json subpage.
Module:ItemPorts loads messages from Module:ItemPorts/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.
| Function list |
|---|
require( 'strict' )
require( 'Module:Mw.html extension' );
local ItemPorts = {}
local metatable = {}
local methodtable = {}
metatable.__index = methodtable
local MODULE_NAME = 'Module:ItemPorts'
local config = mw.loadJsonData( MODULE_NAME .. '/config.json' )
local TNT = require( 'Module:Translate' ):new()
--- Wrapper function for Module:Translate.translate
---
--- @param key string The translation key
--- @param addSuffix boolean|nil 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, ... )
return TNT:translate( MODULE_NAME .. '/i18n.json', config, key, addSuffix, {...} ) or key
end
--- Creates the object that is used to query the SMW store
---
--- @param page string the item page containing data
--- @return table
local function makeSmwQueryObject( page )
return {
mw.ustring.format(
'[[-Has subobject::' .. page .. ']][[%s::+]]',
translate( 'SMW_ItemPortName' )
),
mw.ustring.format( '?%s#-=name', translate( 'SMW_ItemPortName' ) ),
mw.ustring.format( '?%s#-=display_name', translate( 'SMW_ItemPortDisplayName' ) ),
mw.ustring.format( '?%s#-=min_size', translate( 'SMW_ItemPortMinimumSize' ) ),
mw.ustring.format( '?%s#-=max_size', translate( 'SMW_ItemPortMaximumSize' ) ),
mw.ustring.format( '?%s#-=equipped_name', translate( 'SMW_EquippedItemName' ) ),
mw.ustring.format( '?%s#-=equipped_uuid', translate( 'SMW_EquippedItemUUID' ) ),
mw.ustring.format( 'sort=%s,%s', translate( 'SMW_ItemPortName' ), translate( 'SMW_ItemPortMaximumSize' ) ),
'order=asc,desc',
'limit=1000'
}
end
--- Queries the SMW Store
--- @return table|nil
function methodtable.getSmwData( self, page )
-- Cache multiple calls
if self.smwData ~= nil then
return self.smwData
end
local smwData = mw.smw.ask( makeSmwQueryObject( page ) )
if smwData == nil or smwData[ 1 ] == nil then
return nil
end
mw.logObject( smwData, 'getSmwData' )
self.smwData = smwData
return self.smwData
end
--- Generates wikitext needed for the template
--- @return string
function methodtable.out( self )
local smwData = self:getSmwData( self.page )
if smwData == nil then
local msg = mw.ustring.format( translate( 'error_no_itemports_found' ), self.page )
return require( 'Module:Hatnote' )._hatnote( msg, { icon = 'WikimediaUI-Error.svg' } )
end
local containerHtml = mw.html.create( 'div' ):addClass( 'template-itemPorts' )
-- FIXME: This does nothing since I don't know how to achieve this in Lua
-- When port.name equals to one of the value in blockedPortNames, skip the iteration.
-- local blockedPortNames = config.blocklist_itemport_name
for _, port in ipairs( smwData ) do
local size_text, title, subtitle
-- Use display_name if it is different, so that we use the same key as the game localization
if port.display_name and port.display_name ~= port.name and translate( 'itemPort_' .. port.display_name ) ~= 'itemPort_' .. port.display_name then
subtitle = translate( 'itemPort_' .. port.display_name )
else
subtitle = translate( 'itemPort_' .. port.name )
end
if port.min_size == port.max_size then
size_text = mw.ustring.format( 'S%d', port.min_size )
else
size_text = mw.ustring.format( 'S%d–%d', port.min_size, port.max_size )
end
if port.equipped_name ~= nil then
if port.equipped_name == '<= PLACEHOLDER =>' then
-- TODO: Display more specific name by getting the type of the item
title = translate( 'item_placeholder' )
else
title = mw.ustring.format( '[[%s]]', port.equipped_name )
end
else
title = 'No item equipped'
end
local portHtml = mw.html.create( 'div' ):addClass( 'template-itemPort' )
portHtml:tag( 'div' )
:addClass( 'template-itemPort-port' )
:tag( 'div' )
:addClass( 'template-itemPort-size' )
:wikitext( size_text )
portHtml:tag( 'div' )
:addClass( 'template-itemPort-item' )
:addClassIf( port.equipped_name, 'template-itemPort-item--hasItem' )
:tag( 'div' )
:addClass( 'template-itemPort-subtitle' )
:wikitext( subtitle )
:done()
:tag( 'div' )
:addClass( 'template-itemPort-title' )
:wikitext( title )
containerHtml:node( portHtml )
end
return tostring( containerHtml ) .. mw.getCurrentFrame():extensionTag{
name = 'templatestyles', args = { src = MODULE_NAME .. '/styles.css' }
}
end
--- New Instance
---
--- @return table ItemPorts
function ItemPorts.new( self, page )
local instance = {
page = page or nil
}
setmetatable( instance, metatable )
return instance
end
--- Parser call for generating the table
function ItemPorts.outputTable( frame )
local args = require( 'Module:Arguments' ).getArgs( frame )
local page = args[ 1 ] or mw.title.getCurrentTitle().rootText
local instance = ItemPorts:new( page )
local out = instance:out()
return out
end
--- For debugging use
---
--- @param page string page name on the wiki
--- @return string
function ItemPorts.test( page )
local instance = ItemPorts:new( page )
local out = instance:out()
return out
end
return ItemPorts