Modded Wiki

Module:Inventory slot: Difference between revisions

← Older editNewer edit →
m It's always those last second changes that get me...
Rewrite for better readability; add i18n; improve performance; support subframes; improve randomness; support already parsed frames
Line 1: Line 1:
local p = {}
local p = {}


-- List of special prefixes which should be handled by
local i18n = {
-- other modules (such as being moved outside links)
filename = 'Invicon $1',
p.prefixes = {
legacyFilename = 'Grid $1.png',
'Any',
modLink = 'Mods/$1/$2',
'Matching',
moduleAliases = [[Module:Inventory slot/Aliases]],
'Damaged'
moduleInvIds = [[Module:InvSprite/IDs]],
moduleModIds = 'Module:InvSprite/Mods/$1/IDs',
moduleRandom = [[Module:Random]],
moduleSprite = [[Module:Sprite]],
-- List of special prefixes which should be handled by
-- other modules (such as being moved outside links)
prefixes = {
'Any',
'Matching',
'Damaged',
any = 'Any',
matching = 'Matching',
damaged = 'Damaged',
},
templateFileUrl = 'FileUrl',
}
}
p.i18n = i18n
p.prefixes = i18n.prefixes


local function mergeList( parentTable, content )
local random = require( i18n.moduleRandom ).random
if content[1] then
local sprite = require( i18n.moduleSprite ).sprite
-- Merge list into table
local aliases = mw.loadData( i18n.moduleAliases )
for _, v in ipairs( content ) do
local ids = mw.loadData( i18n.moduleInvIds ).ids
table.insert( parentTable, v )
local modIds = {}
end
local pageName = mw.title.getCurrentTitle().text
else
-- Add strings or tables to table
table.insert( parentTable, content )
end
end


-- Performs a simple recursive clone of a table's values
local function cloneTable( origTable )
local function cloneTable( origTable )
local newTable = {}
local newTable = {}
Line 32: Line 44:
end
end


function p.slot( f )
--[[Merges a list, or inserts a string
local args = f.args or f
or table into a table
if f == mw.getCurrentFrame() and args[1] == nil then
--]]
args = f:getParent().args
local function mergeList( parentTable, content )
local i = #parentTable + 1
if content[1] then
-- Merge list into table
for _, v in ipairs( content ) do
parentTable[i] = v
i = i + 1
end
else
-- Add strings or tables to table
parentTable[i] = content
end
end
 
-- Creates the HTML for an item
local function makeItem( frame, i, args )
local item = mw.html.create( 'span' ):addClass( 'invslot-item' )
if args.imgclass then
item:addClass( args.imgclass )
end
if frame.name == '' then
item:tag( 'br' )
return item
end
end
local category
local title = frame.title or mw.text.trim( args.title or '' )
local mod = frame.mod
local name = frame.name or ''
local num = frame.num
local description = frame.text
args[1] = mw.text.trim( args[1] or '' )
local img, idData
if mod then
-- Comment this next line out if you're not using aliases
local modData = modIds[mod]
local aliases = mw.loadData( 'Module:Inventory slot/Aliases' )
if not modData and mw.title.new( i18n.moduleModIds:gsub( '%$1', mod ) ).exists then
modData = mw.loadData( i18n.moduleModIds:gsub( '%$1', mod ) )
local modAliases = args.modaliases or ''
modIds[mod] = modData
if modAliases ~= '' then
end
modAliases = mw.loadData( 'Module:' .. modAliases )
if modData and modData[name] then
idData = modData[name]
else
img = i18n.legacyFilename:gsub( '%$1', name .. ' (' .. mod .. ')' )
end
elseif ids[name] then
idData = ids[name]
elseif name:match( '\.gif$' ) or name:match( '\.png$' ) then
img = i18n.filename:gsub( '%$1', name )
-- Remove file extension from name
name = name:sub( 0, -5 )
else
else
modAliases = nil
img = i18n.legacyFilename:gsub( '%$1', name )
end
end
local randomise
local link = args.link or ''
if args.class == 'invslot-large' then
if link == '' then
randomise = false
if mod then
link = i18n.modLink:gsub( '%$1', mod ):gsub( '%$2', name )
else
link = name:gsub( '^' .. i18n.prefixes.damaged .. ' ', '' )
end
elseif link:lower() == 'none' then
link = nil
end
end
local frames = {}
if link == pageName then
for frameText in mw.text.gsplit( args[1], '%s*;%s*' ) do
link = nil
local frame = p.makeFrame( frameText, args.mod )
end
local formattedTitle
local plainTitle
if title == '' then
plainTitle = name
elseif title:lower() ~= 'none' then
plainTitle = title:gsub( '\\\\', '\' ):gsub( '\\&', '&' )
local id = frame.name
local formatPattern = '&[0-9a-fk-or]'
if frame.mod then
if plainTitle:match( formatPattern ) then
id = frame.mod .. ':' .. id
formattedTitle = title
plainTitle = plainTitle:gsub( formatPattern, '' )
end
end
local alias
if plainTitle == '' then
if modAliases and modAliases[id] then
plainTitle = name
alias = modAliases[id]
else
elseif aliases and aliases[id] then
plainTitle = plainTitle:gsub( '\', '\\' ):gsub( '&', '&' )
alias = aliases[id]
end
end
elseif link then
if alias then
if img then
mergeList( frames, p.getAlias( alias, frame ) )
formattedTitle = ''
else
else
table.insert( frames, frame )
plainTitle = ''
end
end
-- Randomise starting frame for "Any *" aliases, as long as the alias is the only frame
end
-- and this isn't an output slot
if randomise ~= false and frame.name:match( '^Any ' ) then
item:attr{
randomise = true
['data-minetip-title'] = formattedTitle,
else
['data-minetip-text'] = description
randomise = false
}
if img then
-- & is re-escaped because mw.html treats attributes
-- as plain text, but MediaWiki doesn't
local escapedTitle = ( plainTitle or '' ):gsub( '&', '&' )
item:addClass( 'invslot-item-image' )
:wikitext( '[[File:', img, '|32x32px|link=', link or '', '|', escapedTitle, ']]' )
else
local image
if mod then
image = args.spritesheet or mod .. 'Sprite.png'
end
if link then
item:wikitext( '[[', link, '|' )
end
local image, spriteCat = sprite{
iddata = idData, title = plainTitle,
image = image, settings = 'InvSprite'
}
item:node( image )
category = spriteCat
end
if num and num > 1 and num < 1000 then
if img and link then
item:wikitext( '[[', link, '|' )
end
local number = item
:tag( 'span' )
:addClass( 'invslot-stacksize' )
:attr{ title = plainTitle }
:wikitext( num )
if numStyle then
number:cssText( numStyle )
end
if img and link then
item:wikitext( ']]' )
end
end
end
end
local sprite
if idData and link then
local ids = mw.loadData( [[Module:InvSprite/IDs]] ).ids
item:wikitext( ']]' )
local modIds = {}
end
local animated = #frames > 1
local pageName = mw.title.getCurrentTitle().text
item:wikitext( category )
return item
end
 
-- Main entry point
function p.slot( f )
local args = f.args or f
if f == mw.getCurrentFrame() and args[1] == nil then
args = f:getParent().args
end
if not args.parsed then
args[1] = mw.text.trim( args[1] or '' )
end
local modData = {
aliases = args.modaliases or '',
default = args.mod
}
if modData.aliases ~= '' then
modData.aliases = mw.loadData( 'Module:' .. modData.aliases )
else
modData.aliases = nil
end
if args.mod == '' then
modData.default = nil
end
local frames
if args.parsed then
frames = args[1]
elseif args[1] ~= '' then
local randomise = args.class == 'invslot-large' and 'never' or nil
frames = p.parseFrameText( args[1], randomise, false, modData )
end
local animated = frames and #frames > 1
local imgClass = args.imgclass
local imgClass = args.imgclass
local numStyle = args.numstyle
local numStyle = args.numstyle
Line 100: Line 236:
if args.style then
if args.style then
body:cssText( args.style )
body:cssText( args.style )
end
if ( args.default or '' ) ~= '' then
body:css( 'background-image', f:expandTemplate{ name = i18n.templateFileUrl, args = { args.default .. '.png' } } )
end
end
if ( args.default or '' ) ~= '' then
--mw.logObject( frames )
body:css( 'background-image', '{{FileUrl|' .. args.default .. '.png}}' )
if not frames then
body:tag( 'br' )
return tostring( body )
end
end
local activeFrame = randomise and math.random( #frames ) or 1
local activeFrame = frames.randomise == true and random( #frames ) or 1
for i, frame in ipairs( frames ) do
for i, frame in ipairs( frames ) do
local item
local item
if frame ~= '' or frame.name == '' and animated then
-- Table is a list, must contain subframes
item = body:tag( 'span' ):addClass( 'invslot-item' )
if frame[1] then
if imgClass then
item = body:tag( 'span' ):addClass( 'animated-subframe' )
item:addClass( imgClass )
local subActiveFrame = frame.randomise and random( #frame ) or 1
for sI, sFrame in ipairs( frame ) do
local sItem = makeItem( sFrame, sI, args )
item:node( sItem )
if sI == subActiveFrame then
sItem:addClass( 'animated-active' )
end
end
end
else
item = makeItem( frame, i, args )
body:node( item )
end
if i == activeFrame and animated then
item:addClass( 'animated-active' )
end
end
return tostring( body )
end
--[[Parses the frame text into a table of frames and subframes,
expanding aliases (and optionally retaining a reference), and
deciding if the slot can be randomised
--]]
function p.parseFrameText( framesText, randomise, aliasReference, modData )
local frames = { randomise = randomise }
local subframes = {}
local subframe
local expandedAliases
local splitFrames = mw.text.split( mw.text.trim( framesText ), '%s*;%s*' )
for _, frameText in ipairs( splitFrames ) do
frameText = frameText:gsub( '^%s*{%s*', function()
subframe = true
return ''
end )
if subframe then
frameText = frameText:gsub( '%s*}%s*$', function()
subframe = 'last'
return ''
end )
end
end
local frame = p.makeFrame( frameText, modData and modData.default )
if frame == '' or frame.name == '' then
local newFrame = frame
( item or body ):tag( 'br' )
if aliases or modData.aliases then
else
local id = frame.name
local category
if frame.mod then
local title = frame.title or mw.text.trim( args.title or '' )
id = frame.mod .. ':' .. id
local mod = frame.mod
end
local name = frame.name
local num = frame.num
local description = frame.text
local img, idData
local alias = modData and modData.aliases and modData.aliases[id] or
if mod then
aliases and aliases[id]
local modData = modIds[mod]
if alias then
if not modData and mw.title.new( 'Module:InvSprite/Mods/' .. mod .. '/IDs' ).exists then
newFrame = p.getAlias( alias, frame )
modData = mw.loadData( 'Module:InvSprite/Mods/' .. mod .. '/IDs' )
if aliasReference then
modIds[mod] = modData
local curFrame = #frames + 1
local aliasData = { frame = frame, length = #newFrame }
if subframe then
if not subframes.aliasReference then
subframes.aliasReference = {}
end
subframes.aliasReference[#subframes + 1] = aliasData
else
if not expandedAliases then
expandedAliases = {}
end
expandedAliases[curFrame] = aliasData
end
end
end
if modData and modData[name] then
end
idData = modData[name]
end
else
img = 'Grid ' .. name .. ' (' .. mod .. ').png'
if subframe then
end
mergeList( subframes, newFrame )
elseif ids[name] then
-- Randomise starting frame for "Any *" aliases, as long as the alias is the only subframe
idData = ids[name]
if frames.randomise ~= 'never' and subframes.randomise == nil and
elseif name:match( '\.gif$' ) or name:match( '\.png$' ) then
frame.name:match( '^' .. i18n.prefixes.any .. ' ' ) then
img = 'Invicon ' .. name
subframes.randomise = true
name = name:sub( 0, -5 )
else
else
img = 'Grid ' .. name .. '.png'
subframes.randomise = false
end
end
if frames.randomise ~= 'never' then
local link = args.link or ''
frames.randomise = false
if link == '' then
if mod then
link = 'Mods/' .. mod .. '/' .. name
else
link = name:gsub( '^Damaged ', '' )
end
elseif link:lower() == 'none' then
link = nil
end
end
if link == pageName then
if subframe == 'last' then
link = nil
-- No point having a subframe containing a single frame,
end
-- or the subframe being the only frame
if #subframes == 1 or #splitFrames == i and #frames == 0 then
local formattedTitle
mergeList( frames, subframes )
local plainTitle
if title == '' then
plainTitle = name
elseif title:lower() ~= 'none' then
plainTitle = title:gsub( '\\\\', '&#92;' ):gsub( '\\&', '&#38;' )
local formatPattern = '&[0-9a-fk-or]'
if plainTitle:match( formatPattern ) then
formattedTitle = title
plainTitle = plainTitle:gsub( formatPattern, '' )
end
if plainTitle == '' then
plainTitle = name
else
plainTitle = plainTitle:gsub( '&#92;', '\\' ):gsub( '&#38;', '&' )
end
elseif link then
if img then
formattedTitle = ''
else
else
plainTitle = ''
table.insert( frames, subframes )
end
end
subframes = {}
subframe = nil
end
end
else
item:attr{
-- Randomise starting frame for "Any *" aliases, as long as the alias is the only frame
['data-minetip-title'] = formattedTitle,
if frames.randomise == nil and frame.name:match( '^' .. i18n.prefixes.any .. ' ' ) then
['data-minetip-text'] = description
frames.randomise = true
}
elseif frames.randomise ~= 'never' then
frames.randomise = false
if img then
-- & is re-escaped because mw.html treats attributes
-- as plain text, but MediaWiki doesn't
local escapedTitle = ( plainTitle or '' ):gsub( '&', '&#38;' )
item:addClass( 'invslot-item-image' )
:wikitext( '[[File:', img, '|32x32px|link=', link or '', '|', escapedTitle, ']]' )
else
if not sprite then
sprite = require( [[Module:Sprite]] ).sprite
end
local image
if mod then
image = args.spritesheet or mod .. 'Sprite.png'
end
if link then
item:wikitext( '[[', link, '|' )
end
local image, spriteCat = sprite{
iddata = idData, title = plainTitle,
image = image, settings = 'InvSprite'
}
item:node( image )
category = spriteCat
end
if num and num > 1 and num < 1000 then
if img and link then
item:wikitext( '[[', link, '|' )
end
local number = item
:tag( 'span' )
:addClass( 'invslot-stacksize' )
:attr{ title = plainTitle }
:wikitext( num )
if numStyle then
number:cssText( numStyle )
end
if img and link then
item:wikitext( ']]' )
end
end
if idData and link then
item:wikitext( ']]' )
end
end
mergeList( frames, newFrame )
item:wikitext( category )
end
if i == activeFrame and animated and item then
item:addClass( 'animated-active' )
end
end
end
end
return tostring( body )
frames.aliasReference = expandedAliases
return frames
end
end


function p.getAlias( alias, parentFrame )
--[[Returns a new table with the parts of the parent frame
local aliasFrames
added to the alias
if type( alias ) == 'string' then
--]]
aliasFrames = {}
function p.getAlias( aliasFrames, parentFrame )
for frameText in mw.text.gsplit( alias, '%s*;%s*' ) do
-- If alias is just a name, return the parent frame with the new name
table.insert( aliasFrames, p.makeFrame( frameText ) )
end
else
aliasFrames = alias
end
-- If alias is just a name, return the original frame with the new name
if type( aliasFrames ) == 'string' then
if type( aliasFrames ) == 'string' then
local aliasParts = mw.clone( parentFrame )
local expandedFrame = mw.clone( parentFrame )
aliasParts.name = aliasFrames
expandedFrame.name = aliasFrames
return aliasParts
return { expandedFrame }
end
end
Line 274: Line 382:
local expandedFrames = {}
local expandedFrames = {}
for i, aliasFrame in ipairs( aliasFrames ) do
for i, aliasFrame in ipairs( aliasFrames ) do
local aliasParts
local expandedFrame
if type( aliasFrame ) == 'string' then
if type( aliasFrame ) == 'string' then
aliasParts = { name = aliasFrame }
expandedFrame = { name = aliasFrame }
else
else
aliasParts = cloneTable( aliasFrame )
expandedFrame = cloneTable( aliasFrame )
end
end
aliasParts.title = parentFrame.title or aliasParts.title
expandedFrame.title = parentFrame.title or expandedFrame.title
aliasParts.mod = parentFrame.mod or aliasParts.mod
expandedFrame.mod = parentFrame.mod or expandedFrame.mod
aliasParts.num = parentFrame.num or aliasParts.num
expandedFrame.num = parentFrame.num or expandedFrame.num
aliasParts.text = parentFrame.text or aliasParts.text
expandedFrame.text = parentFrame.text or expandedFrame.text
expandedFrames[i] = aliasParts
expandedFrames[i] = expandedFrame
end
end
return expandedFrames
return expandedFrames
end
end
function p.expandAlias( parentFrame, alias )
function p.expandAlias( parentFrame, alias )
return p.getAlias( alias, parentFrame )
return p.getAlias( alias, parentFrame )
Line 315: Line 424:
end
end


-- Splits up the frame text into its parts
function p.makeFrame( frameText, mod )
function p.makeFrame( frameText, mod )
-- Simple frame with no parts
-- Simple frame with no parts
Retrieved from "https://modded.wiki/w/Module:Inventory_slot"