Module:Jump points

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

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

Module:Jump points loads configuration from Module:Jump points/config.json.

This module can be configurated from the config.json subpage.

Module:Jump points loads messages from Module:Jump points/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:Jump points requires Module:Common, Module:Starmap, and Module:Translate.

Module:Jump points loads data from Module:Jump points/config.json.

Function list
L 60 — exists L 65 — JumpPoints.main L 130 — JumpPoints.test L 176 — StringUtil.clean L 184 — StringUtil.lowerFirst

---

-- Code bundled using https://github.com/ari-party/scribunto-bundler
-- Find module source code at https://github.com/ari-party/sct-module-jump-points
local _bundler_load, _bundler_register = (function(superRequire)
    local loadingPlaceholder = { [{}] = true }

    local register
    local modules = {}

    local load
    local loaded = {}

    ---@param name string
    ---@param body function
    register = function(name, body)
        if not modules[name] then
            modules[name] = body
        end
    end

    ---@param name string
    ---@return any
    load = function(name)
        local loadedModule = loaded[name]

        if loadedModule then
            if loadedModule == loadingPlaceholder then
                return nil
            end
        else
            if not modules[name] then
                if not superRequire then
                    local identifier = type(name) == 'string' and '\"' .. name .. '\"' or tostring(name)
                    error('Tried to require ' .. identifier .. ', but no such module has been registered')
                else
                    return superRequire(name)
                end
            end

            loaded[name] = loadingPlaceholder
            loadedModule = modules[name]()
            loaded[name] = loadedModule
        end

        return loadedModule
    end

    return load, register
end)(require)

_bundler_register('bundler_main', function()
    local JumpPoints = {}

local config = mw.loadJsonData( 'Module:Jump points/config.json' )
local Starmap = require( 'Module:Starmap' )
local t = _bundler_load("jf3ffit_xZz7x9bGp9eHd")
local stringUtil = _bundler_load("_XQt31IWCZw6yESgwQW4U")

---@param page string
---@return boolean
local function exists( page )
    return not not mw.smw.ask( { page } )
end

---@param frame table https://www.mediawiki.org/wiki/Extension:Scribunto/Lua_reference_manual#Frame_object
function JumpPoints.main( frame )
    local parent = frame:getParent()
    local args = parent.args

    local systemName = args[ 1 ] or string.gsub( mw.title.getCurrentTitle().text, ' system$', '' )
    if not systemName then return t( 'error_invalid_args' ) end

    local children = Starmap.systemObjects( systemName )
    if not children then return t( 'error_no_data' ) end

    local missingPages = false
    local hasJumppoints = false

    local wikitable = '{| class="wikitable"\n' ..
        '!' .. t( 'lbl_jumpgate' ) .. '\n' ..
        '!' .. t( 'lbl_direction' ) .. '\n' ..
        '!' .. t( 'lbl_size' ) .. '\n' ..
        '!' .. t( 'lbl_destination' ) .. '\n'

    for _, object in ipairs( children ) do
        if object.type == 'JUMPPOINT' then
            hasJumppoints = true

            local exitObject = object.tunnel.exit
            -- Make sure the exit is not the current object
            if exitObject.code == object.code then exitObject = object.tunnel.entry end

            local exitLink = '[[' .. stringUtil.clean( stringUtil.removeParentheses( exitObject.designation ) ) .. ']]'

            if not missingPages then missingPages = not exists( exitLink ) end

            wikitable = wikitable .. '|-\n' ..
                -- From this system
                '|[[' .. stringUtil.clean( stringUtil.removeParentheses( object.designation ) ) .. ']]\n' ..
                -- Direction
                '|' .. t( 'val_direction_' .. string.lower( object.tunnel.direction ) ) .. '\n' ..
                -- Size
                '|' .. t( 'val_size_' .. string.lower( object.tunnel.size ) ) .. '\n' ..
                -- Path to target system's gate
                '|' .. exitLink .. ', ' ..
                stringUtil.lowerFirst(
                    stringUtil.clean(
                        Starmap.inSystem(
                            Starmap.findStructure( 'system',
                                Starmap.findStructure( 'object', exitObject.code ).star_system.code
                            )
                        )
                    )
                ) .. '\n'
        end
    end

    wikitable = wikitable .. '|}'

    if missingPages and config.missing_jumppoint_category then
        wikitable = wikitable .. '[[Category:' .. config.missing_jumppoint_category .. ']]'
    end

    if hasJumppoints then
        return wikitable
    else
        return string.format( t( 'lbl_none' ), systemName )
    end
end

function JumpPoints.test( page )
    return JumpPoints.main( {
        getParent = function ()
            return {
                args = { page }
            }
        end
    } )
end

return JumpPoints

end)

_bundler_register('jf3ffit_xZz7x9bGp9eHd', function()
    local TNT = require( 'Module:Translate' ):new()
local config = mw.loadJsonData( 'Module:Jump points/config.json' )

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

--- Wrapper function for Module:Translate.translate
---@param key string The translation key
---@param addSuffix? boolean Adds a language suffix if config.smw_multilingual_text is true
---@return string value If the key was not found in the .tab page, the key is returned
return function ( key, addSuffix, ... )
    return TNT:translate( 'Module:Jump points/i18n.json', config, key, addSuffix, { ... } ) or key
end

end)

_bundler_register('_XQt31IWCZw6yESgwQW4U', function()
    local Common = require( 'Module:Common' )

local StringUtil = {
    removeParentheses = Common.removeParentheses
}

--- Replace obnoxious characters
---@param str string Input string
---@return string
function StringUtil.clean( str )
    local apostrophe = string.gsub( str, '’', '\'' )
    return apostrophe
end

--- Lower first character
---@param str string Input string
---@return string
function StringUtil.lowerFirst( str )
    return string.lower( string.sub( str, 1, 1 ) ) .. string.sub( str, 2 )
end

return StringUtil

end)

return _bundler_load('bundler_main')