External-Item-Descriptions/eid_api.lua

--[[
EID features 6 tables for mods to define their descriptions:
__eidTrinketDescriptions for trinkets
__eidCardDescriptions for cards
__eidPillDescriptions for pills
__eidItemDescriptions for Collectibles / items
__eidItemTransformations assigns transformation-informations to collectibles
__eidEntityDescriptions for entities
__eidEntityDescriptions["ID.Variant.Subtype"] = {"HEADLINE","DESCRIPTION"};

To assign a unique description for a specific entity:    entity:GetData()["EID_Description"] = {"HEADLINE","DESCRIPTION"}   


For example: to add the item "My Item Name" and the Description "Most Fitting Description" do something like this:

-- 1. Get your itemid
local item = Isaac.GetItemIdByName("My Item Name");
-- 2. Make sure we're not adding to a nil table
if not __eidItemDescriptions then
  __eidItemDescriptions = {};
end
-- 3. Add the description
__eidItemDescriptions[item] = "Most Fitting Description";

--]]
-- Init variables for other mods to hand over Descriptions if they were not yet inited by another mod.
if not __eidItemDescriptions then
	__eidItemDescriptions = {}
end
if not __eidTrinketDescriptions then
	__eidTrinketDescriptions = {}
end
if not __eidCardDescriptions then
	__eidCardDescriptions = {}
end
if not __eidPillDescriptions then
	__eidPillDescriptions = {}
end
if not __eidItemTransformations then
	__eidItemTransformations = {}
end
if not __eidEntityDescriptions then
	__eidEntityDescriptions = {}
end

---------------------------------------------------------------------------
-------------------------Handle Custom Enum -----------------------------

--maps the Player transformation from the enum PlayerForm to the internal transformation table
-- Possible usages:		EID.TRANSFORMATION[ PlayerForm.PLAYERFORM_MUSHROOM ]
-- 						EID.TRANSFORMATION.MUSHROOM
EID.TRANSFORMATION = {
	["GUPPY"] = 1,
	["LORD_OF_THE_FLIES"] = 3,
	["MUSHROOM"] = 2,
	["ANGEL"] = 10,
	["BOB"] = 8,
	["SPUN"] = 5,
	["MOM"] = 6,
	["CONJOINED"] = 4,
	["LEVIATHAN"] = 9,
	["POOP"] = 7,
	["BOOKWORM"] = 12,
	["ADULT"] = 14,
	["SPIDERBABY"] = 13,
	["SUPERBUM"] = 11
}

-- List of item Types
EID.ItemTypeAnm2Names = {
"null", 	-- 1
"passive", 	-- 2
"active", 	-- 3
"familiar", -- 4
"trinket" 	-- 5
}
---------------------------------------------------------------------------
-------------------------Handle API Functions -----------------------------

-- Returns if EID is displaying text right now
function EID:isDisplayingText()
	return isDisplayingText
end

-- Returns true, if curse of blind is active
function EID:hasCurseBlind()
	return Game():GetLevel():GetCurses() & LevelCurse.CURSE_OF_BLIND > 0
end

-- returns the current text position
function EID:getTextPosition()
	return Vector(EIDConfig["XPosition"], EIDConfig["YPosition"])
end

-- returns the entity that is currently described. returns last described entity if currently not displaying text
function EID:getLastDescribedEntity()
	return lastDescriptionEntity
end

function EID:getModDescription(list, id)
	return (list) and (list[id])
end

--Get the name of the given transformation by its ID
function EID:getTransformationName(id)
	local str = "Custom"
	if tonumber(id) == nil then
		return id
	elseif EID:isVanillaTransformationID(id) then
		return transformations[tonumber(id) + 1]
	end
	return str
end

--Returns true, if the transformation has a vanilla icon
function EID:isVanillaTransformationID(id)
	if tonumber(id) ~= nil then
		if (tonumber(id) <= #transformations - 1) then
			return true
		end
	end
	return false
end

-- tries to get the ingame name of an item based on its ID
function EID:getObjectName(objID, objType)
	if objType == "collectible" then
		return EID.itemConfig:GetCollectible(objID).Name
	elseif objType == "trinket" then
		return EID.itemConfig:GetTrinket(objID).Name
	elseif objType == "card" then
		return EID.itemConfig:GetCard(objID).Name
	elseif objType == "pill" then
		return EID.itemConfig:GetPillEffect(objID).Name
	elseif objType == "sacrifice" then
		return sacrificeDescriptionHeader
	elseif objType == "dice" then
		return diceDescriptionHeader
	elseif objType == "custom" then
		return objID
	end
end

-- check if an entity is part of the describable entities
function EID:hasDescription(entity)
	local isAllowed = false
	if EIDConfig["EnableEntityDescriptions"] then
		isAllowed =
			isAllowed or (__eidEntityDescriptions[entity.Type .. "." .. entity.Variant .. "." .. entity.SubType] ~= nil) --[[or type(entity:GetData()["EID_Description"]) ~= type(nil)]]
	end
	isAllowed = isAllowed or (entity.Variant == PickupVariant.PICKUP_COLLECTIBLE and EIDConfig["DisplayItemInfo"])
	isAllowed = isAllowed or (entity.Variant == PickupVariant.PICKUP_TRINKET and EIDConfig["DisplayTrinketInfo"])
	isAllowed = isAllowed or (entity.Variant == PickupVariant.PICKUP_TAROTCARD and EIDConfig["DisplayCardInfo"])
	isAllowed = isAllowed or (entity.Variant == PickupVariant.PICKUP_PILL and EIDConfig["DisplayPillInfo"])
	return entity.Type == EntityType.ENTITY_PICKUP and isAllowed and entity.SubType > 0
end

-- Replaces shorthand-representations of a character with the internal reference
function EID:replaceShortMarkupStrings(text)
	text = string.gsub(text, "!!!", "{{Warning}}") -- Turn 3 Exclamations into Warning
	text = string.gsub(text, "↑", "{{ArrowUp}}") -- Up Arrow
	text = string.gsub(text, "↓", "{{ArrowDown}}") -- Down Arrow
	text = string.gsub(text, "\1", "{{ArrowUp}}") -- Legacy Up Arrow
	text = string.gsub(text, "\2", "{{ArrowDown}}") -- Legacy Down Arrow
	text = string.gsub(text, "\3", "{{Warning}}") -- Legacy Warning
	text = string.gsub(text, "\6", "{{Heart}}") -- Legacy Heart
	text = string.gsub(text, "\5", "{{Key}}") -- Legacy Key
	text = string.gsub(text, "\015", "{{Coin}}") -- Legacy Coin
	text = string.gsub(text, "\8\189", "{{Bomb}}") -- Legacy BOMB
	return text
end

-- Generates a string with the defined pixel-length using a custom 1px wide character
-- This will only work for this specific custom font
function EID:generatePlaceholderString(length)
	local placeholder = ""
	for i = 1, length do
		placeholder = placeholder .. "¤"
	end
	return placeholder
end

-- Returns the inlineIcon object of a given Iconstring
-- can be used to validate an iconstring
function EID:getIcon(str)
	return EID.InlineIcons[string.gsub(str, "{{(.-)}}", function(a) return a end)] or nil
end

-- Returns the width of a given string in Pixels
function EID:getStrWidth(str)
	return EID.font:GetStringWidthUTF8(str)
end

-- Searches true the given string and replaces Iconplaceholders with icons.
-- Returns the string without the placeholders but with an accurate space between lines.
function EID:filterMarkup(text, textPosX, textPosY)
	for word in string.gmatch(text, "{{.-}}") do
		local textposition = string.find(text, word)
		local lookup = EID:getIcon(word) or EID.InlineIcons["ERROR"]
		local Xoffset = lookup[5] or 0
		local prefixTextWidth = EID:getStrWidth(string.sub(text, 0, textposition - 1))
		EID.InlineIconSprite:SetFrame(lookup[1], lookup[2])
		EID.InlineIconSprite.Scale = Vector(EIDConfig["Scale"], EIDConfig["Scale"])
		EID.InlineIconSprite:Render(
			Vector((textPosX + prefixTextWidth + Xoffset -2) * EIDConfig["Scale"], textPosY),
			Vector(0, 0),
			Vector(0, 0)
		)
		text = string.gsub(text, word, EID:generatePlaceholderString(lookup[3]), 1)
	end
	return text
end

-- Returns the icon used for the bulletpoint. It will look at the first word in the given string.
function EID:handleBulletpointIcon(text)
	local firstWord = string.match(text, "([^%s]+)")
	if EID:getIcon(firstWord) ~= nil then
		return firstWord
	end
	return "\007"
end

--needs to be called in a render Callback
-- args: string, Vector(int, int), Vector(float,float), KColor obj, bool
function EID:renderString(str, position, scale, kcolor, centered)
	str = EID:replaceShortMarkupStrings(str)
	str = EID:filterMarkup(str, position.X, position.Y)
	EID.font:DrawStringScaledUTF8(str, position.X, position.Y, scale.X, scale.Y, kcolor, EID:getStrWidth(str), centered)
end

-- Get KColor object of "Entity Name" texts
function EID:getNameColor()
	return KColor(
		EIDConfig["ItemNameColor"][1],
		EIDConfig["ItemNameColor"][2],
		EIDConfig["ItemNameColor"][3],
		EIDConfig["Transparency"],
		0,
		0,
		0
	)
end

-- Get KColor object of "Description" texts
function EID:getTextColor()
	return KColor(
		EIDConfig["TextColor"][1],
		EIDConfig["TextColor"][2],
		EIDConfig["TextColor"][3],
		EIDConfig["Transparency"],
		0,
		0,
		0
	)
end

-- Get KColor object of "Transformation" texts
function EID:getTransformationColor()
	return KColor(
		EIDConfig["TransformationColor"][1],
		EIDConfig["TransformationColor"][2],
		EIDConfig["TransformationColor"][3],
		EIDConfig["Transparency"],
		0,
		0,
		0
	)
end

-- Get KColor object of "Error" texts
function EID:getErrorColor()
	return KColor(
		EIDConfig["ErrorColor"][1],
		EIDConfig["ErrorColor"][2],
		EIDConfig["ErrorColor"][3],
		EIDConfig["Transparency"],
		0,
		0,
		0
	)
end