• Welcome to the Kancolle Wiki!
  • If you have any questions regarding site content, account registration, etc., please visit the KanColle Wiki Discord

Difference between revisions of "Module:Ship"

From Kancolle Wiki
Jump to navigation Jump to search
com>Ckwng
(Return a bare bones ShipData instead when module require fails.)
m (Undo revision 118188 by がか (talk))
Tag: Undo
 
(40 intermediate revisions by 3 users not shown)
Line 1: Line 1:
local Ship = {}
+
local U = require("Module:Core")
local ships = {}
+
local BaseData = require('Module:BaseData')
  
local ShipData = require('Module:ShipData')
+
local Ship = BaseData{
 +
  _ships = {},
 +
  _data_class = false,
 +
}
 +
 
 +
function Ship:_prepareShipData()
 +
  self._data_class = self._data_class or require('Module:ShipData')
 +
end
  
 
function Ship:get(stat, name, model)
 
function Ship:get(stat, name, model)
return self:create(name, model)[stat]()
+
  return self:create(name, model)[stat]()
 
end
 
end
  
 
function Ship:create(name, model)
 
function Ship:create(name, model)
if name == nil then
+
  self:_prepareShipData()
return ShipData()
+
  if name == nil then
end
+
    return self._data_class()
if model == nil then
+
  end
model = ""
+
  if model == nil then
end
+
    name, model = self:process_ship_key(name)
--check if we already have it
+
  end
if ships[name] and ships[name][model] then
+
  if not model then
return ships[name][model]
+
    model = ""
else
+
  end
--Catch a failed require
+
  -- check if we already have it
local success, ship_table = pcall(function () return require(mw.ustring.format('Module:%s', name)) end)
+
  if self._ships[name] and self._ships[name][model] then
--require succeeded
+
    return self._ships[name][model]
if success then
+
  else
ship_table = ship_table[model]
+
    local ship = self._data_class(self:get_table(name, model))
if not ship_table then
+
    if not self._ships[name] then
--create a ShipData with what we have
+
      self._ships[name] = {}
ship_table = {_name = name, _suffix = model}
+
    end
end
+
    self._ships[name][model] = ship
--require failed
+
    return ship
else
+
  end
--create a ShipData with what we have
+
end
ship_table = {_name = name, _suffix = model}
+
 
end
+
function Ship:process_ship_key_as_reference(reference, base)
local ship = ShipData(ship_table)
+
  name, model = self:process_ship_key(reference)
if not ships[name] then
+
  if #name == 0 then
ships[name] = {}
+
    name = base
end
+
  end
ships[name][model] = ship
+
  return name, model
return ship
+
end
end
+
 
 +
function Ship:create_from_reference(reference, base)
 +
  name, model = self:process_ship_key(reference)
 +
  if #name == 0 then
 +
    name = base:base_name()
 +
  end
 +
  return self(name, model)
 +
end
 +
 
 +
function Ship:get_table(name, model)
 +
  local success, ship_table = Ship.requireModule(name, self._enemy)
 +
  local ship_form_table
 +
  if success then
 +
    ship_form_table = ship_table[model]
 +
    if not ship_form_table and ship_table.seasonals then
 +
      ship_form_table = ship_table.seasonals[model] or U.ifindBy(
 +
        ship_table.seasonals,
 +
        function(data)
 +
          return data._suffix == model and (not data._name or data._name == name)
 +
        end
 +
      )
 +
      if ship_form_table and type(ship_form_table) ~= "string" then
 +
        ship_form_table._seasonal = true
 +
      end
 +
    end
 +
    if type(ship_form_table) == "string" then
 +
      ship_form_table = self:get_table(self:process_ship_key_as_reference(ship_form_table, name))
 +
    end
 +
  end
 +
  local id = tonumber(name)
 +
  if not ship_form_table then
 +
    ship_form_table = {
 +
        _name = not id and name or nil,
 +
        _suffix = not id and model or nil,
 +
        _api_id = id or nil,
 +
        _dummy = true
 +
    }
 +
  end
 +
  if ship_form_table._name == nil then
 +
    ship_form_table._name = name
 +
  end
 +
  if ship_form_table._suffix == nil then
 +
    ship_form_table._suffix = model
 +
  end
 +
  ship_form_table._key = model
 +
  if not id and name:sub(1, 5) == 'Vita:' then
 +
    ship_form_table._vita = true
 +
  end
 +
  return ship_form_table
 +
end
 +
 
 +
function Ship:process_ship_key(ship_key)
 +
  local split = string.find(ship_key, '/')
 +
  local ship_base_name, ship_suffix
 +
  if split == nil then
 +
    ship_base_name = ship_key
 +
  else
 +
    ship_base_name = split - 1 > 0 and string.sub(ship_key, 1, split - 1) or ''
 +
    ship_suffix = string.sub(ship_key, split + 1, -1)
 +
  end
 +
  return ship_base_name, ship_suffix
 +
end
 +
 
 +
function Ship:get_module(name, isEnemy)
 +
  if not name then
 +
    return nil
 +
  end
 +
  name = self:process_ship_key(name)
 +
  return string.format('Module:Data/%s/%s', isEnemy and 'Enemy' or 'Ship', name)
 +
end
 +
 
 +
function Ship.requireModule(name, is_enemy)
 +
  local success, ship_table
 +
  if not is_enemy then
 +
success, ship_table = U.requireModule('Data/Ship/' .. name)
 +
  end
 +
  if not success then
 +
    success, ship_table = U.requireModule('Data/Enemy/' .. name)
 +
  end
 +
  return success, ship_table
 
end
 
end
  
function Ship:get_module(name)
+
function Ship:extend(data)
if name == nil then
+
  data = data or {}
return nil
+
  setmetatable(data, data)
end
+
  data.__index = self
return mw.ustring.format('Module:%s', name)
+
  data.__call = self.__call
 +
  return data
 
end
 
end
  

Latest revision as of 13:21, 2 November 2021

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

local U = require("Module:Core")
local BaseData = require('Module:BaseData')

local Ship = BaseData{
  _ships = {},
  _data_class = false,
}

function Ship:_prepareShipData()
  self._data_class = self._data_class or require('Module:ShipData')
end

function Ship:get(stat, name, model)
  return self:create(name, model)[stat]()
end

function Ship:create(name, model)
  self:_prepareShipData()
  if name == nil then
    return self._data_class()
  end
  if model == nil then
    name, model = self:process_ship_key(name)
  end
  if not model then
    model = ""
  end
  -- check if we already have it
  if self._ships[name] and self._ships[name][model] then
    return self._ships[name][model]
  else
    local ship = self._data_class(self:get_table(name, model))
    if not self._ships[name] then
      self._ships[name] = {}
    end
    self._ships[name][model] = ship
    return ship
  end
end

function Ship:process_ship_key_as_reference(reference, base)
  name, model = self:process_ship_key(reference)
  if #name == 0 then
    name = base
  end
  return name, model
end

function Ship:create_from_reference(reference, base)
  name, model = self:process_ship_key(reference)
  if #name == 0 then
    name = base:base_name()
  end
  return self(name, model)
end

function Ship:get_table(name, model)
  local success, ship_table = Ship.requireModule(name, self._enemy)
  local ship_form_table
  if success then
    ship_form_table = ship_table[model]
    if not ship_form_table and ship_table.seasonals then
      ship_form_table = ship_table.seasonals[model] or U.ifindBy(
        ship_table.seasonals,
        function(data)
          return data._suffix == model and (not data._name or data._name == name)
        end
      )
      if ship_form_table and type(ship_form_table) ~= "string" then
        ship_form_table._seasonal = true
      end
    end
    if type(ship_form_table) == "string" then
      ship_form_table = self:get_table(self:process_ship_key_as_reference(ship_form_table, name))
    end
  end
  local id = tonumber(name)
  if not ship_form_table then
    ship_form_table = {
        _name = not id and name or nil,
        _suffix = not id and model or nil,
        _api_id = id or nil,
        _dummy = true
    }
  end
  if ship_form_table._name == nil then
    ship_form_table._name = name
  end
  if ship_form_table._suffix == nil then
    ship_form_table._suffix = model
  end
  ship_form_table._key = model
  if not id and name:sub(1, 5) == 'Vita:' then
    ship_form_table._vita = true
  end
  return ship_form_table
end

function Ship:process_ship_key(ship_key)
  local split = string.find(ship_key, '/')
  local ship_base_name, ship_suffix
  if split == nil then
    ship_base_name = ship_key
  else
    ship_base_name = split - 1 > 0 and string.sub(ship_key, 1, split - 1) or ''
    ship_suffix = string.sub(ship_key, split + 1, -1)
  end
  return ship_base_name, ship_suffix
end

function Ship:get_module(name, isEnemy)
  if not name then
    return nil
  end
  name = self:process_ship_key(name)
  return string.format('Module:Data/%s/%s', isEnemy and 'Enemy' or 'Ship', name)
end

function Ship.requireModule(name, is_enemy)
  local success, ship_table
  if not is_enemy then
	success, ship_table = U.requireModule('Data/Ship/' .. name)
  end
  if not success then
    success, ship_table = U.requireModule('Data/Enemy/' .. name)
  end
  return success, ship_table
end

function Ship:extend(data)
  data = data or {}
  setmetatable(data, data)
  data.__index = self
  data.__call = self.__call
  return data
end

Ship.__call = Ship.create
setmetatable(Ship, Ship)

return Ship