Template:Disambiguation/doc

Template that is used on disambiguation pages. These are pages that are created to differentiate between multiple other pages with the same or a similar name. An example of this would be Ancient.

The below script will search all current Icon Templates in v1.3.1 (except for Synergies) for the given searchTerm then output an array of the results in valid Icon Template format with expansion icons. This may result in some duplicates between ItemIcons and UpdateIcons, such as Iron Sieve which is both an Item and Purchase.

To use the script, copy and paste the script into the console. The script can then be run with disambiguation(searchTerm, returnEquipmentTemplate) where searchTerm is the disambiguation page you're about to create (with proper capitalization) and returnEquipmentTemplate is a Boolean (true/false) for whether you want to return a template for Template:EquipmentTableFromList/doc instead, defaulting to false.

Upon running the function, the outputs will be pasted into the console while also being copied to the clipboard. If the results look good (more than a single item) then begin creating the disambiguation page. The results should be manually checked for any erroring or incorrect templates before creating the page.

The results should be cleaned up a bit. Items that include 'Dusty' should not be included with 'Dust' however 'Stardust' is fine due to how relevant the item is. Certain category names may be changed if that category only contains 1 type of object, such as 'Combat' to 'Combat Areas' or 'Others' to 'Points of Interest'. If an entire equipment set is shown, it should be linked to the appropriate Equipment page (such as Adamant Equipment).

function disambiguation(searchTerm, returnEquipmentTemplate=false) {
	let search = (item) => !item.isModded && item.name.toLowerCase().includes(searchTerm.toLowerCase());
	let wikiIcon = (item, icon, extras, postText) => {
		numResults++;
		if (!returnEquipmentTemplate) {
			extras = extras.replaceAll('${NAME}', `${item.name}`);
			let expIcon = `${item.namespace.includes('TotH') ? ' {{TotH}}' : item.namespace.includes('AoD') ? ' {{AoD}}' : item.namespace.includes('ItA') ? ' {{ItA}}' : ' {{Melvor}}'}`;
			let iconTemplate = icon === 'Link' ? ` [[${extras}]]` : ` {{${icon}|${item.name.replace('Potion I', 'Potion')}${extras}}}`;
			return `*${expIcon}${iconTemplate}${postText}`;
		}
		return `|${item.name}`;
	}
	let pushResults = (arr, header, icon, extras='', postText='') => {
		if (arr.length > 0 && !returnEquipmentTemplate && !results.includes(header))
			results += header;
		arr.forEach(item => {
			if (!returnEquipmentTemplate || item.validSlots !== undefined)
				results += `\n${wikiIcon(item, icon, extras, postText)}`;
		});
	}
	let results = '', numResults = 0;
	if (returnEquipmentTemplate) results += `{{UserContentVersion|${gameVersion.substr(1)}}}\n\n= ${searchTerm} Equipment =\n== Melee Weapons ==\n{{EquipmentTableFromList\n\n}}\n== Ranged Weapons & Ammo ==\n{{EquipmentTableFromList\n\n}}\n== Armour ==\n{{EquipmentTableFromList\n|includeModifiers=false`;
	if (!returnEquipmentTemplate) results += `{{Disam}}\n{{UserContentVersion|${gameVersion.substr(1)}}}\n\n'''${searchTerm}''' may refer to:`;
	pushResults(game.items.weapons.filter(x => search(x) && !x.validSlots.includes('Quiver')), '\n== Equipment ==', 'ItemIcon');
	pushResults(game.items.equipment.filter(x => search(x) && x.validSlots.includes('Quiver')), '\n== Equipment ==', 'ItemIcon');
	pushResults(game.items.equipment.filter(x => search(x) && !(x instanceof WeaponItem) && !x.validSlots.includes('Quiver')), '\n== Equipment ==', 'ItemIcon');
	pushResults(game.items.filter(x => x.validSlots == undefined && !(x instanceof OpenableItem) && !(x instanceof BoneItem) && !(x instanceof SoulItem) && !(x instanceof FoodItem) && !['potion_ii', 'potion_iii', 'potion_iv'].some(y => x.id.toLowerCase().includes(y)) && search(x)), '\n== Items ==', 'ItemIcon');
	pushResults(game.items.openables.filter(x => search(x)), '\n== Openables ==', 'ItemIcon');
	pushResults(game.items.bones.filter(x => search(x)), '\n== Bones ==', 'ItemIcon');
	pushResults(game.items.souls.filter(x => search(x)), '\n== Souls ==', 'ItemIcon');
	pushResults(game.items.food.filter(x => search(x)), '\n== Food ==', 'ItemIcon');
	pushResults(game.monsters.filter(x => search(x)), '\n== Monsters ==', 'MonsterIcon');
	pushResults(game.combatAreas.filter(x => search(x)), '\n== Combat Areas ==', 'ZoneIcon');
	pushResults(game.attackSpellbooks.allObjects.filter(x => search(x)), '\n== Spells & Spellbooks ==', 'SpellbookIcon');
	pushResults([...game.attackSpells.allObjects, ...game.curseSpells.allObjects, ...game.auroraSpells.allObjects, ...game.altMagic.actions.allObjects].filter(x => search(x)), '\n== Spells & Spellbooks ==', 'SpellIcon');
	pushResults(game.shop.purchases.filter(x => x.contains.items?.length !== 1 && !x.contains.itemCharges && search(x)), '\n== Purchases ==', 'UpgradeIcon');
	pushResults(game.prayers.filter(x => search(x)), '\n== Prayers ==', 'PrayerIcon');
	pushResults([...game.township.buildings.allObjects, ...game.township.seasons.allObjects, ...game.township.biomes.allObjects, ...game.township.resources.allObjects].filter(x => !['melvorF:GP', 'melvorItA:AP'].includes(x.id) && search(x)), '\n== Township ==', 'TownshipIcon');
	pushResults(game.skills.filter(x => search(x)), '\n== Skills ==', 'Skill');
	pushResults(game.astrology.actions.filter(x => search(x)), '\n== Skill Actions ==', 'ConstellationIcon');
	pushResults(game.agility.actions.filter(x => search(x)), '\n== Skill Actions ==', 'AgilityIcon');
	pushResults(game.thieving.actions.filter(x => search(x)), '\n== Skill Actions ==', 'Icon', '|type=thieving');
	pushResults(game.pets.filter(x => search(x)), '\n== Pets ==', 'PetIcon');
	pushResults(game.combatEffects.allObjects.filter(x => ['Shadeveil', 'Ablaze', 'Affliction', 'Barrier Burn', 'Bleed', 'Burn', 'Deadly Poison', 'Eldritch Curse', 'Fear', 'Freeze', 'Frostburn', 'Laceration', 'Nulled', 'Poison', 'Shock', 'Silence', 'Sleep', 'Slow', 'Stun', 'Toxin', 'Voidburst', 'Wither'].includes(x.name) && search(x)), '\n== Combat Effects ==', 'EffectIcon');
	pushResults(game.currencies.allObjects.filter(x => search(x)), '\n== Others ==', 'Icon');
	pushResults(game.gamemodes.allObjects.filter(x => !x.isEvent && x.id !== 'melvorD:Unset' && search(x)), '\n== Others ==', 'Icon');
	pushResults(game.combat.slayerTask.categories.allObjects.filter(x => search(x)), '\n== Others ==', 'Link', 'Slayer#${NAME}|${NAME}', ' Slayer Tier');
	if (cloudManager.hasAoDEntitlementAndIsEnabled)
		pushResults(game.cartography.worldMaps.getObjectByID('melvorAoD:Melvor').pointsOfInterest.filter(x => search(x)), '\n== Others ==', 'POIIcon');
	if (returnEquipmentTemplate) results += '\n}}';
	self.nw?.Clipboard.get().set ? self.nw?.Clipboard?.get().set(results, 'text') : copy(results);
	console.log(results);
	notifyPlayer(game.attack, `Copied ${numResults} results for ${searchTerm} to clipboard`, 'success', 0);
}