Module:SpriteFile: Difference between revisions

From Modded Wiki
Jump to navigation Jump to search
added ability to use .gif files for Item Sprites
No edit summary
 
(12 intermediate revisions by 3 users not shown)
Line 18: Line 18:
local id = mw.text.trim( tostring( args[1] or '' ) )
local id = mw.text.trim( tostring( args[1] or '' ) )
local useGif = id:match("\\gif$")
if not args.keepcase then
    if useGif then
id = mw.ustring.lower( id ):gsub( '[%s%+]', '-' )
    id = id:gsub("\\gif$", "")
end
end
local mod = id:match( '([^:%]]+):' ) or "Minecraft"
local nameStart = ( id:find( ':' ) or id:find( '%]' ) or 0 ) + 1
if nameStart - 1 == #id then
nameStart = 1
end
local nameId = id:sub( nameStart, ( id:find( '[,%[]', nameStart ) or 0 ) - 1 )
local link = ( args.link or '' )
local link = ( args.link or '' )
Line 44: Line 51:
end
end
local name = args.name
local name = args.name or ''
if name == 'InvSprite' then
name = 'Invicon'
end
local file = ''
local fileExtension = useGif and '.gif' or '.png'
if mod == 'Minecraft' or mod == 'minecraft' then
    local file = name .. ' ' .. id .. fileExtension
file = name .. ' ' .. nameId .. '.png'
    local altText = file .. ': Sprite image for ' .. id .. ' in Minecraft'
else
    if link ~= '' then
file = name .. ' ' .. mod .. ' ' .. nameId .. '.png'
        altText = altText .. ' linking to ' .. link
end
    end
    if id == '' then
local altText = ''
        file = 'Grid Unknown.png'
if link == '' then
        altText = 'Unknown sprite image'
altText = file .. ': Sprite image for ' .. nameId .. ' in ' .. mod
    end
end
if id == '' then
file = 'Grid Unknown.png'
altText = 'Unknown sprite image'
end
local sprite = mw.html.create( 'span' ):addClass( 'sprite-file' )
local sprite = mw.html.create( 'span' ):addClass( 'sprite-file' )
local img = '[[File:' .. file .. '|' .. size .. '|link=' .. link .. '|alt=' .. altText .. '|class=pixel-image|' .. ( args.title or '' ) .. ']]'
local img = '[[File:' .. file .. '|' .. size .. '|link=' .. link .. '|alt=' .. altText .. '|class=pixel-image|' .. ( args.title or '' ) .. ']]'
Line 77: Line 92:
if args.title then
if args.title then
spriteText:attr( 'title', args.title )
spriteText:attr( 'title', args.title )
else
spriteText:attr( 'title', nameId )
end
end
if link ~= '' then
if link ~= '' then
Line 106: Line 123:
local link = args[1]
local link = args[1]
link = link and link:gsub("\\gif$", "")
if args[1] and not args.id then
if args[1] and not args.id then
        link = link:match('^(.-)%+') or link
link = args[1]:match( '^(.-)%+' ) or args[1]
    end
end
 
local text
    local text
if not args.notext then
    if not args.notext then
text = args.text or args[2] or ''
        text = args.text or args[2] or link
    end
if text == '' then
local nameStart = (link:find( ':' ) or 0 ) + 1
if nameStart - 1 == #link then
nameStart = 1
end
text = link:sub( nameStart, ( link:find( '[,%[]', nameStart ) or 0 ) - 1 )
end
end
args[1] = args.id or args[1]
args[1] = args.id or args[1]
    args.link = args.link or link
args.link = args.link or link
    args.text = text
args.text = text
 
    return p.sprite(args)
return p.sprite( args )
end
end


return p
return p

Latest revision as of 22:21, 19 May 2025

Documentation for this module may be created at Module:SpriteFile/doc

local p = {}

function p.sprite( f )
	local args = f
	if f == mw.getCurrentFrame() then
		args = require( 'Module:ProcessArgs' ).merge( true )
	else
		f = mw.getCurrentFrame()
	end
	
	-- Default settings
	local default = {
		scale = 1,
		size = 16,
		align = 'text-top'
	}
	
	local id = mw.text.trim( tostring( args[1] or '' ) )
	
	if not args.keepcase then
		id = mw.ustring.lower( id ):gsub( '[%s%+]', '-' )
	end
	
	local mod = id:match( '([^:%]]+):' ) or "Minecraft"

	local nameStart = ( id:find( ':' ) or id:find( '%]' ) or 0 ) + 1
	if nameStart - 1 == #id then
		nameStart = 1
	end
	local nameId = id:sub( nameStart, ( id:find( '[,%[]', nameStart ) or 0 ) - 1 )
	
	local link = ( args.link or '' )
	if mw.ustring.lower( link ) == 'none' then
		link = ''
	elseif link ~= '' then
		local linkPrefix = ( not link:find( '//' ) and args.linkprefix ) or ''
		link = linkPrefix .. link
	end
	
	local scale = args.scale or default.scale
	local height = ( args.height or args.size or default.size ) * scale
	local width = ( args.width or args.size or default.size ) * scale
	local size = width .. 'x' .. height .. 'px'
	
	local styles = {}
	if height ~= default.size then
		styles[#styles + 1] = 'height:' .. height .. 'px'
	end
	if width ~= default.size then
		styles[#styles + 1] = 'width:' .. width .. 'px'
	end
	
	local name = args.name or ''
	if name == 'InvSprite' then
		name = 'Invicon'
	end
	local file = ''
	
	if mod == 'Minecraft' or mod == 'minecraft' then
		file = name .. ' ' .. nameId .. '.png'
	else
		file = name .. ' ' .. mod .. ' ' .. nameId .. '.png'
	end
	
	local altText = ''
	if link == '' then
		altText = file .. ': Sprite image for ' .. nameId .. ' in ' .. mod
	end
	if id == '' then
		file = 'Grid Unknown.png'
		altText = 'Unknown sprite image'
	end
	local sprite = mw.html.create( 'span' ):addClass( 'sprite-file' )
	local img = '[[File:' .. file .. '|' .. size .. '|link=' .. link .. '|alt=' .. altText .. '|class=pixel-image|' .. ( args.title or '' ) .. ']]'
	sprite:node( img )
	
	local align = args.align or default.align
	if align ~= default.align then
		styles[#styles + 1] = '--vertical-align:' .. align
	end
	styles[#styles + 1] = args.css
	
	sprite:cssText( table.concat( styles, ';' ) )
	
	local root
	local spriteText
	if args.text then
		if not args['wrap'] then
			root = mw.html.create( 'span' ):addClass( 'nowrap' )
		end
		spriteText = mw.html.create( 'span' ):addClass( 'sprite-text' ):wikitext( args.text )
		if args.title then
			spriteText:attr( 'title', args.title )
		else
			spriteText:attr( 'title', nameId )
		end
		if link ~= '' then
			-- External link
			if link:find( '//' ) then
				spriteText = '[' .. link .. ' ' .. tostring( spriteText ) .. ']'
			else
				spriteText = '[[' .. link .. '|' .. tostring( spriteText ) .. ']]'
			end
		end
	end
	
	if not root then
		root = mw.html.create( '' )
	end
	root:node( sprite )
	if spriteText then
		root:node( spriteText )
	end
	
	return tostring( root )
end

function p.link( f )
	local args = f
	if f == mw.getCurrentFrame() then
		args = require( 'Module:ProcessArgs' ).merge( true )
	end
	
	local link = args[1]
	if args[1] and not args.id then
		link = args[1]:match( '^(.-)%+' ) or args[1]
	end
	local text
	if not args.notext then
		text = args.text or args[2] or ''
		
		if text == '' then
			local nameStart = (link:find( ':' ) or 0 ) + 1
			if nameStart - 1 == #link then
				nameStart = 1
			end
			text = link:sub( nameStart, ( link:find( '[,%[]', nameStart ) or 0 ) - 1 )
		end
	end
	
	args[1] = args.id or args[1]
	args.link = args.link or link
	args.text = text
	
	return p.sprite( args )
end

return p