Module:GameShortened: Difference between revisions

From Inkipedia, the Splatoon wiki
(split main and callable)
(add Side Order)
Line 6: Line 6:
     local S3 = "S3"
     local S3 = "S3"
     local OE = "OE"
     local OE = "OE"
    local SO = "SO"
     local abbrev = {
     local abbrev = {
         ['S'] = S,
         ['S'] = S,
Line 17: Line 18:
         ['OE'] = OE,
         ['OE'] = OE,
         ['Octo Expansion'] = OE,
         ['Octo Expansion'] = OE,
        ['SO'] = SO,
        ['Side Order'] = SO,
     }
     }
      
      

Revision as of 16:32, 14 September 2023

Helper template that transforms the game argument into the shortened S form. For template chaining and code reduction. Will also help us when new game/expansions/formats are created.

If the game is not matched, the default argument is used instead if specified, otherwise "S".

Usage

game Named or first positional, optional The game that the cost belongs to. The following values are handled:
  • Octo Expansion -> OE
  • Side Order -> SO
  • Salmon Run -> SR
  • Splatoon -> S
  • Splatoon 1 -> S
  • Splatoon 2 -> S2
  • Splatoon 3 -> S3
  • OE -> OE
  • SO -> SO
  • SR -> SR
  • S -> S
  • S2 -> S2
  • S3 -> S3

If game is not specified, the default argument will be used instead.

default Named or second positional, optional If the game argument was not matched, uses this instead.
  • Defaults to "S".
Typical usage

{{GameShortened|<game>|<default>}}

{{GameShortened|Octo Expansion}} -> OE

Chained in another template that has the game parameter

{{GameShortened|{{{game|}}}}} -> S

Using the default parameter

{{GameShortened|Splatoon 3|S}} -> S3

{{GameShortened|game=Splatoon 2|default=Splatoon}} -> S2

In files

[[File:{{GameShortened|Splatoon 3}}_Icon_Big_Run.svg|link=Big Run|30px]] ->

[[File:{{GameShortened|game=Splatoon 2|default=Splatoon 3}}_Splatfest_Logo.svg|link=Splatfest|30px]] ->

See Also


local p = {}

function p.getGame(arg, default)
    local S1 = "S"
    local S2 = "S2"
    local S3 = "S3"
    local OE = "OE"
    local SO = "SO"
    local abbrev = {
        ['S'] = S,
        ['S1'] = S,
        ['Splatoon'] = S,
        ['Splatoon 1'] = S,
        ['S2'] = S2,
        ['Splatoon 2'] = S2,
        ['S3'] = S3,
        ['Splatoon 3'] = S3,
        ['OE'] = OE,
        ['Octo Expansion'] = OE,
        ['SO'] = SO,
        ['Side Order'] = SO,
    }
    
    -- return the abbreviation from the game arg.
    -- If arg is nil then a default will be used.
    return abbrev[arg] or default or "S"
end

-- main to extract arg from frame
function p.main(frame)
	local args = frame:getParent().args
    local arg = args['game'] or args[1]
    local default = args['default'] or args[2]
    return p.getGame(arg, default)
end

return p