ARK: Survival Evolved Wiki
Register
(Undo revision 536293 by Alexrmski (talk))
Tag: Undo
No edit summary
 
(40 intermediate revisions by the same user not shown)
Line 1: Line 1:
  +
local Utility = require('Module:Utility')
  +
 
local p = {}
 
local p = {}
  +
  +
  +
function copyClipboard( contents )
 
return '<span class="copy-clipboard"><span class="copy-content" style="font-family:Courier,monospace;">' .. contents .. '</span></span>'
  +
end
  +
  +
  +
function getExampleShortCommand( isEntity, identifier )
 
if isEntity then
  +
return 'cheat summon ' .. identifier
 
else
  +
return 'cheat gfi ' .. identifier .. ' 1 0 0'
  +
end
  +
end
  +
  +
  +
function getExampleBPCommand( isEntity, identifier, short )
  +
if isEntity then
 
return 'cheat SpawnDino {{BlueprintPath|' .. identifier .. '}} 500 0 0 35'
  +
else
 
return 'cheat giveitem {{BlueprintPath|' .. identifier .. '}} 1 0 0'
  +
end
  +
end
  +
  +
  +
function getTekgramUnlockCommand( bp )
  +
return 'cheat unlockengram {{BlueprintPath|' .. bp .. '}}'
  +
end
  +
  +
function getIdBasedItemCommand( identifier )
  +
return 'cheat giveitemnum ' .. identifier .. ' 1 0 0'
  +
end
  +
  +
  +
function makeCommandSet (isEntity, blueprintPath, entityClassName, shortItemName, tekgramBP, itemId)
 
local OR = '<br/><b>or</b><br/>'
  +
  +
local commands = ''
  +
local canShowSummon = isEntity and entityClassName ~= nil
  +
local canShowGFI = not isEntity and shortItemName ~= nil
  +
  +
-- ID-based item command
  +
if not isEntity and itemId then
  +
commands = copyClipboard(getIdBasedItemCommand(itemId))
 
if blueprintPath or shortItemName then
 
commands = commands .. OR
  +
end
  +
end
  +
 
-- Loose, short commands
  +
if canShowSummon then
  +
commands = commands .. copyClipboard(getExampleShortCommand(true, entityClassName))
 
elseif canShowGFI then
  +
commands = commands .. copyClipboard(getExampleShortCommand(false, shortItemName))
  +
end
  +
 
-- "or" between the two forms
 
if blueprintPath and (canShowSummon or canShowGFI) then
  +
commands = commands .. OR
  +
end
  +
 
-- Strict, BP-reliant command
  +
if blueprintPath then
  +
commands = commands .. copyClipboard(getExampleBPCommand(isEntity, blueprintPath))
  +
end
  +
  +
if tekgramBP then
  +
commands = commands .. '<br/><b>Unlock [[Tekgram]]</b><br/>'
  +
.. copyClipboard(getTekgramUnlockCommand(tekgramBP))
  +
end
  +
  +
return commands
  +
end
  +
  +
  +
function guardStringArgument( args, name )
  +
local v = args[name] or nil
  +
if v ~= nil then
  +
v = mw.text.trim(v)
  +
if #v == 0 then
  +
v = nil
  +
end
  +
end
  +
return v
  +
end
  +
   
 
function p.spawnCommand( f )
 
function p.spawnCommand( f )
Line 6: Line 94:
   
 
-- Infobox arguments
 
-- Infobox arguments
local blueprintPath = parentArgs.blueprintPath or nil
+
local blueprintPath = guardStringArgument(parentArgs, 'blueprintpath')
local entityClassName = parentArgs.entityId or nil
+
local entityClassName = guardStringArgument(parentArgs, 'entityId')
local shortItemName = parentArgs.gfi or nil
+
local shortItemName = guardStringArgument(parentArgs, 'gfi')
local isBaseClassIncomplete = parentArgs.incompleteBaseClass == 'yes' or false
+
local tekgram = guardStringArgument(parentArgs, 'tekgram')
  +
local itemId = guardStringArgument(parentArgs, 'itemid')
  +
local incompleteBaseClassArg = parentArgs.incompleteBaseClass or parentArgs.incompleteData or args.baseClassIsTemplate
  +
local isBaseClassIncomplete = incompleteBaseClassArg ~= nil and incompleteBaseClassArg:lower() == 'yes' or false
  +
local baseNote = guardStringArgument(parentArgs, 'spawncommandnote')
  +
  +
-- Check if type is specified
  +
if args.type == nil then
  +
return 'error: "type" has to be specified (creature or item) for spawn command section to be generated'
  +
end
 
 
 
-- Own hardcoded arguments
 
-- Own hardcoded arguments
local isEntity = args.type == 'creature' or entityClassName ~= nil
+
local isEntity = args.type == 'creature'
 
local captionLinkTarget = args.linkTarget or ''
 
local captionLinkTarget = args.linkTarget or ''
  +
local variantOrderList = args.variantOrder or ''
  +
  +
-- Fill in info from variables set by Dv if creature
  +
if isEntity then
  +
if blueprintPath == nil then
  +
blueprintPath = f:preprocess('{{#var:blueprintpath}}')
  +
end
  +
if entityClassName == nil then
  +
entityClassName = f:preprocess('{{#var:entityId}}')
  +
end
  +
-- Reduce to null if empty.
  +
if blueprintPath == '' then
  +
blueprintPath = nil
  +
end
  +
if entityClassName == '' then
  +
entityClassName = nil
  +
end
  +
end
  +
  +
-- Remove object descriptor elements from the blueprint path if one is valid.
  +
if blueprintPath ~= nil then
  +
blueprintPath = Utility.getUnqualifiedBlueprintPath(blueprintPath)
  +
end
  +
  +
-- Auto-generate class name for entities
  +
if isEntity and entityClassName == nil and blueprintPath ~= nil then
  +
entityClassName = Utility.getBlueprintClassName(blueprintPath, true)
  +
end
 
 
 
-- Display flags
 
-- Display flags
Line 23: Line 148:
 
 
 
-- Main class
 
-- Main class
if not isBaseClassIncomplete and (blueprintPath or entityId or shortItemName) then
+
if (not isBaseClassIncomplete) and (blueprintPath or entityId or shortItemName) then
  +
commands = makeCommandSet(isEntity, blueprintPath, entityClassName, shortItemName, tekgram, itemId)
-- Loose, short commands
 
if canShowSummon then
+
if baseNote ~= nil then
  +
commands = baseNote .. '\n' .. commands
commands = '<span class="copy-clipboard"><span class="copy-content" style="font-family:Courier,monospace;">admincheat summon ' .. entityClassName .. '</span></span>'
 
elseif canShowGFI then
 
commands = '<span class="copy-clipboard"><span class="copy-content" style="font-family:Courier,monospace;">admincheat gfi ' .. shortItemName .. ' 1 0 0</span></span>'
 
 
end
 
end
  +
end
  +
  +
-- Initialize variants from variantOrderList
  +
-- We use an external list provided by the template to retain order of the variants.
  +
local variants = {}
  +
local variantOrder = {}
  +
if variantOrderList ~= '' then
  +
for _, variantName in ipairs(mw.text.split(variantOrderList, ';')) do
  +
if variants[variantName] == nil then
  +
variants[variantName] = {}
  +
table.insert(variantOrder, variantName)
  +
end
  +
end
  +
end
  +
  +
-- Collect variants (and their details) from arguments
  +
for argName, argValue in pairs(parentArgs) do
  +
argName = mw.text.trim(argName)
  +
local variantName = nil
  +
local isBP = false
 
 
  +
-- Detect if this parameter is a BP/short ID
-- "or" between the two forms
 
  +
if mw.ustring.find(argName, 'blueprintpath ', 0, true) == 1 then
if blueprintPath and (canShowSummon or canShowGFI) then
 
  +
variantName = mw.ustring.sub(argName, 14)
commands = commands .. '<br/><b>or</b><br/>'
 
  +
isBP = true
  +
elseif isEntity and mw.ustring.find(argName, 'entityId ', 0, true) == 1 then
  +
variantName = mw.ustring.sub(argName, 9)
  +
elseif (not isEntity) and mw.ustring.find(argName, 'gfi ', 0, true) == 1 then
  +
variantName = mw.ustring.sub(argName, 4)
 
end
 
end
 
 
  +
if variantName ~= nil then
-- Strict, BP-reliant command
 
  +
variantName = mw.text.trim(variantName)
if blueprintPath then
 
  +
if #variantName > 0 then
commands = commands .. '<span class="copy-clipboard"><span class="copy-content" style="font-family:Courier,monospace;">admincheat '
 
  +
-- Ensure the variant is initialized.
if isEntity then
 
  +
if variants[variantName] == nil then
commands = commands .. 'SpawnDino {{BlueprintPath|' .. blueprintPath .. '}} 500 0 0 35'
 
  +
variants[variantName] = {}
else
 
  +
table.insert(variantOrder, variantName)
commands = commands .. 'giveitem {{BlueprintPath|' .. blueprintPath .. '}} 1 0 0'
 
  +
end
  +
  +
-- Save the value.
  +
if isBP then
  +
local tempVariantBP = mw.text.trim(argValue)
  +
if tempVariantBP ~= nil then
  +
-- Remove object descriptor from the blueprint path.
  +
tempVariantBP = Utility.getUnqualifiedBlueprintPath(tempVariantBP)
  +
end
  +
variants[variantName]['bp'] = tempVariantBP
  +
else
  +
variants[variantName]['short'] = mw.text.trim(argValue)
  +
end
 
end
 
end
  +
end
commands = commands .. '</span></span>'
 
  +
end
  +
  +
-- Generate commands for variants
  +
local firstRendered = isBaseClassIncomplete
  +
for index, variantName in ipairs(variantOrder) do
  +
local spawnInfo = variants[variantName]
  +
-- Auto-generate class name for entities
  +
if isEntity and spawnInfo.bp and not spawnInfo.short then
  +
spawnInfo.short = Utility.getBlueprintClassName(spawnInfo.bp, true)
  +
end
  +
  +
if spawnInfo.bp or spawnInfo.short then
  +
if not firstRendered then
  +
commands = commands .. '<br/>'
  +
end
  +
firstRendered = false
  +
commands = commands .. '<span style="font-size:1.1em;font-weight:bold;">Variant ' .. variantName .. '</span><br/>'
  +
commands = commands .. makeCommandSet(isEntity, spawnInfo.bp, spawnInfo.short, spawnInfo.short)
 
end
 
end
 
end
 
end
   
 
-- Return nothing if no command was generated
 
-- Return nothing if no command was generated
if commands then
+
if #commands == 0 then
 
return ''
 
return ''
 
end
 
end
Line 57: Line 236:
 
.. '<div class="info-arkitex info-X1-100">'
 
.. '<div class="info-arkitex info-X1-100">'
 
.. '<div style="text-align:left; padding:0 8px 0 8px;" class="mw-collapsible mw-collapsed">' .. "'''[[" .. captionLinkTarget .. "|Spawn Command]]'''"
 
.. '<div style="text-align:left; padding:0 8px 0 8px;" class="mw-collapsible mw-collapsed">' .. "'''[[" .. captionLinkTarget .. "|Spawn Command]]'''"
.. '<div class="mw-collapsible-content" style="text-align:left;font-size:0.8em;word-wrap:break-word;width:310px">'
+
.. '<div class="mw-collapsible-content" style="text-align:left;font-size:0.8em;word-wrap:break-word;width:310px">'
.. commands
+
.. commands
  +
.. '</div>'
 
.. '</div>'
 
.. '</div>'
 
.. '</div>'
 
.. '</div>'
Line 65: Line 245:
 
return f:preprocess(out)
 
return f:preprocess(out)
 
end
 
end
  +
   
 
return p
 
return p

Latest revision as of 14:18, 27 December 2021

Documentation for this module may be created at Module:Infobox spawn command section/doc

local Utility = require('Module:Utility')

local p = {}


function copyClipboard( contents )
	return '<span class="copy-clipboard"><span class="copy-content" style="font-family:Courier,monospace;">' .. contents .. '</span></span>'
end


function getExampleShortCommand( isEntity, identifier )
	if isEntity then
		return 'cheat summon ' .. identifier
	else
		return 'cheat gfi ' .. identifier .. ' 1 0 0'
	end
end


function getExampleBPCommand( isEntity, identifier, short )
	if isEntity then
		return 'cheat SpawnDino {{BlueprintPath|' .. identifier .. '}} 500 0 0 35'
	else
		return 'cheat giveitem {{BlueprintPath|' .. identifier .. '}} 1 0 0'
	end
end


function getTekgramUnlockCommand( bp )
	return 'cheat unlockengram {{BlueprintPath|' .. bp .. '}}'
end

function getIdBasedItemCommand( identifier )
	return 'cheat giveitemnum ' .. identifier .. ' 1 0 0'
end


function makeCommandSet (isEntity, blueprintPath, entityClassName, shortItemName, tekgramBP, itemId)
	local OR = '<br/><b>or</b><br/>'
	
	local commands = ''
	local canShowSummon = isEntity and entityClassName ~= nil
	local canShowGFI = not isEntity and shortItemName ~= nil
	
	-- ID-based item command
	if not isEntity and itemId then
		commands = copyClipboard(getIdBasedItemCommand(itemId))
		if blueprintPath or shortItemName then
			commands = commands .. OR
		end
	end
	
	-- Loose, short commands
	if canShowSummon then
		commands = commands .. copyClipboard(getExampleShortCommand(true, entityClassName))
	elseif canShowGFI then
		commands = commands .. copyClipboard(getExampleShortCommand(false, shortItemName))
	end
		
	-- "or" between the two forms
	if blueprintPath and (canShowSummon or canShowGFI) then
		commands = commands .. OR
	end
		
	-- Strict, BP-reliant command
	if blueprintPath then
		commands = commands .. copyClipboard(getExampleBPCommand(isEntity, blueprintPath))
	end
	
	if tekgramBP then
		commands = commands .. '<br/><b>Unlock [[Tekgram]]</b><br/>'
				   .. copyClipboard(getTekgramUnlockCommand(tekgramBP))
	end
	
	return commands
end


function guardStringArgument( args, name )
	local v = args[name] or nil
	if v ~= nil then
		v = mw.text.trim(v)
		if #v == 0 then
			v = nil
		end
	end
	return v
end


function p.spawnCommand( f )
	local args = f.args
	local parentArgs = f:getParent().args

	-- Infobox arguments
	local blueprintPath = guardStringArgument(parentArgs, 'blueprintpath')
	local entityClassName = guardStringArgument(parentArgs, 'entityId')
	local shortItemName = guardStringArgument(parentArgs, 'gfi')
	local tekgram = guardStringArgument(parentArgs, 'tekgram')
	local itemId = guardStringArgument(parentArgs, 'itemid')
	local incompleteBaseClassArg = parentArgs.incompleteBaseClass or parentArgs.incompleteData or args.baseClassIsTemplate
	local isBaseClassIncomplete = incompleteBaseClassArg ~= nil and incompleteBaseClassArg:lower() == 'yes' or false
	local baseNote = guardStringArgument(parentArgs, 'spawncommandnote')

	-- Check if type is specified
	if args.type == nil then
		return 'error: "type" has to be specified (creature or item) for spawn command section to be generated'
	end
	
	-- Own hardcoded arguments
	local isEntity = args.type == 'creature'
	local captionLinkTarget = args.linkTarget or ''
	local variantOrderList = args.variantOrder or ''
	
	-- Fill in info from variables set by Dv if creature
	if isEntity then
		if blueprintPath == nil then
			blueprintPath = f:preprocess('{{#var:blueprintpath}}')
		end
		if entityClassName == nil then
			entityClassName = f:preprocess('{{#var:entityId}}')
		end
		-- Reduce to null if empty.
		if blueprintPath == '' then
			blueprintPath = nil
		end
		if entityClassName == '' then
			entityClassName = nil
		end
	end
	
	-- Remove object descriptor elements from the blueprint path if one is valid.
	if blueprintPath ~= nil then
		blueprintPath = Utility.getUnqualifiedBlueprintPath(blueprintPath)
	end
	
	-- Auto-generate class name for entities
	if isEntity and entityClassName == nil and blueprintPath ~= nil then
		entityClassName = Utility.getBlueprintClassName(blueprintPath, true)
	end
	
	-- Display flags
	local canShowSummon = isEntity and entityClassName ~= nil
	local canShowGFI = not isEntity and shortItemName ~= nil

	-- Variable for generated commands text
	local commands = ''
	
	-- Main class
	if (not isBaseClassIncomplete) and (blueprintPath or entityId or shortItemName) then
		commands = makeCommandSet(isEntity, blueprintPath, entityClassName, shortItemName, tekgram, itemId)
		if baseNote ~= nil then
			commands = baseNote .. '\n' .. commands
		end
	end
	
	-- Initialize variants from variantOrderList
	-- We use an external list provided by the template to retain order of the variants.
	local variants = {}
	local variantOrder = {}
	if variantOrderList ~= '' then
		for _, variantName in ipairs(mw.text.split(variantOrderList, ';')) do
			if variants[variantName] == nil then
				variants[variantName] = {}
				table.insert(variantOrder, variantName)
			end
		end
	end
	
	-- Collect variants (and their details) from arguments
	for argName, argValue in pairs(parentArgs) do
		argName = mw.text.trim(argName)
		local variantName = nil
		local isBP = false
		
		-- Detect if this parameter is a BP/short ID
		if mw.ustring.find(argName, 'blueprintpath ', 0, true) == 1 then
			variantName = mw.ustring.sub(argName, 14)
			isBP = true
		elseif isEntity and mw.ustring.find(argName, 'entityId ', 0, true) == 1 then
			variantName = mw.ustring.sub(argName, 9)
		elseif (not isEntity) and mw.ustring.find(argName, 'gfi ', 0, true) == 1 then
			variantName = mw.ustring.sub(argName, 4)
		end
		
		if variantName ~= nil then
			variantName = mw.text.trim(variantName)
			if #variantName > 0 then
				-- Ensure the variant is initialized.
				if variants[variantName] == nil then
					variants[variantName] = {}
					table.insert(variantOrder, variantName)
				end
			
				-- Save the value.
				if isBP then
					local tempVariantBP = mw.text.trim(argValue)
					if tempVariantBP ~= nil then
						-- Remove object descriptor from the blueprint path.
						tempVariantBP = Utility.getUnqualifiedBlueprintPath(tempVariantBP)
					end
					variants[variantName]['bp'] = tempVariantBP
				else
					variants[variantName]['short'] = mw.text.trim(argValue)
				end
			end
		end
	end
	
	-- Generate commands for variants
	local firstRendered = isBaseClassIncomplete
	for index, variantName in ipairs(variantOrder) do
		local spawnInfo = variants[variantName]
		-- Auto-generate class name for entities
		if isEntity and spawnInfo.bp and not spawnInfo.short then
			spawnInfo.short = Utility.getBlueprintClassName(spawnInfo.bp, true)
		end
		
		if spawnInfo.bp or spawnInfo.short then
			if not firstRendered then
				commands = commands .. '<br/>'
			end
			firstRendered = false
			commands = commands .. '<span style="font-size:1.1em;font-weight:bold;">Variant ' .. variantName .. '</span><br/>'
			commands = commands .. makeCommandSet(isEntity, spawnInfo.bp, spawnInfo.short, spawnInfo.short)
		end
	end

	-- Return nothing if no command was generated
	if #commands == 0 then
		return ''
	end
	
	local out = '<div class="info-arkitex info-module">'
				.. '<div class="info-arkitex info-unit">'
				   .. '<div class="info-arkitex info-X1-100">'
				      .. '<div style="text-align:left; padding:0 8px 0 8px;" class="mw-collapsible mw-collapsed">' .. "'''[[" .. captionLinkTarget .. "|Spawn Command]]'''"
				    	 .. '<div class="mw-collapsible-content" style="text-align:left;font-size:0.8em;word-wrap:break-word;width:310px">'
				    		.. commands
				    	 .. '</div>'
				      .. '</div>'
				   .. '</div>'
				.. '</div>'
			 .. '</div>'
	return f:preprocess(out)
end


return p