Melvor Idle

Template:Disambiguation/doc: Difference between revisions

Template Discussion

Template:Disambiguation/doc (view source)

Revision as of 06:33, 31 October 2024

713 bytes added ,  31 October
Updated documentation. Added currencies and gamemodes to the output. Changed script to a function so it's a bit easier to run subsequent searches
m (Sort souls into their own category in script)
(Updated documentation. Added currencies and gamemodes to the output. Changed script to a function so it's a bit easier to run subsequent searches)
Line 1: Line 1:
Template that is used on [[:Category:Disambiguation|disambiguation]] pages. These are pages that are created to differentiate between multiple other pages with the same or a similar name.
Template that is used on [[:Category:Disambiguation|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]].


An example of this would be [[Siren]]
The below script will search all current [[Template:Icon|Icon Templates]] in v1.3.1 (except for Synergies) for the given <code>searchTerm</code> 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.


The below script will search all current [[Template:Icon|Icon Templates]] in v1.2.2 (except for Synergies, Spellbooks (not Spells) and Currencies) for the given <code>searchTerm</code> 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 <code>disambiguation(searchTerm, returnEquipmentTemplate)</code> where <code>searchTerm</code> is the disambiguation page you're about to create (with proper capitalization) and <code>returnEquipmentTemplate</code> is a Boolean (true/false) for whether you want to return a template for [[Template:EquipmentTableFromList/doc]] instead.


To use the script, copy and paste it into the console and change the <code>searchTerm</code> to the disambiguation page you're about to create. Upon hitting enter, the outputs will be pasted into the console while also being copied to the clipboard. If the results look good (not a single item or there's a bunch of random items with 1 clear choice for what the user was looking for) then begin creating the disambiguation page. The results will need a manual check before creating the page. 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'.
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.


For <code>returnEquipmentTemplate</code>, see [[Template:EquipmentTableFromList/doc]].
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]]).


<syntaxhighlight lang="javascript" line>
<syntaxhighlight lang="javascript" line>
// Settings //
function disambiguation(searchTerm, returnEquipmentTemplate) {
let searchTerm = 'Siren'; // The proper capitalization of the search term
const search = (item) => !item.isModded && item.name.toLowerCase().includes(searchTerm.toLowerCase());
let returnEquipmentTemplate = false; // returns a template for {{EquipmentTableFromList}} instead
const wikiIcon = (item, icon, extras, postText) => {
// End of Settings //
if (!returnEquipmentTemplate) {
const search = (item) => !item.isModded && item.name.toLowerCase().includes(searchTerm.toLowerCase());
extras = extras.replaceAll('${NAME}', `${item.name}`);
const wikiIcon = (item, icon, extras) => {
let expIcon = `${item.namespace.includes('TotH') ? ' {{TotH}}' : item.namespace.includes('AoD') ? ' {{AoD}}' : item.namespace.includes('ItA') ? ' {{ItA}}' : ' {{Melvor}}'}`;
if (!returnEquipmentTemplate) {
let iconTemplate = icon === 'Link' ? ` [[${extras}]]` : ` {{${icon}|${item.name}${extras}}}`;
let expIcon = `${item.namespace.includes('TotH') ? ' {{TotH}}' : item.namespace.includes('AoD') ? ' {{AoD}}' : item.namespace.includes('ItA') ? ' {{ItA}}' : ' {{Melvor}}'}`;
return `*${expIcon}${iconTemplate}${postText}`;
let iconTemplate = icon === 'Slayer' ? ` [[Slayer#${item.name}|${item.name} Slayer Tier]]` : ` {{${icon}|${item.name}${extras}}}`;
}
return `*${expIcon}${iconTemplate}`;
return `|${item.name}`;
}
}
return `|${item.name}`;
const pushResults = (arr, header, icon, extras='', postText='') => {
}
if (arr.length > 0 && !returnEquipmentTemplate && !results.includes(header))
const pushResults = (arr, header, icon, extras='') => {
results += header;
if (arr.length > 0 && !returnEquipmentTemplate && !results.includes(header))
arr.forEach(item => {
results += header;
if (!returnEquipmentTemplate || item.validSlots !== undefined)
arr.forEach(item => {
results += `\n${wikiIcon(item, icon, extras, postText)}`;
if (!returnEquipmentTemplate || item.validSlots !== undefined)
});
results += `\n${wikiIcon(item, icon, extras)}`;
}
});
let results = '';
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) && 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 => 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 => 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 && 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 results for ${searchTerm} to clipboard`, 'success', 0);
}
}
let results = '';
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) && 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== Combat ==', 'MonsterIcon');
pushResults(game.combatAreas.filter(x => search(x)), '\n== Combat ==', 'ZoneIcon');
pushResults([...game.attackSpells.allObjects, ...game.curseSpells.allObjects, ...game.auroraSpells.allObjects, ...game.altMagic.actions.allObjects].filter(x => search(x)), '\n== Spells ==', 'SpellIcon');
pushResults(game.shop.purchases.filter(x => 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 => search(x)), '\n== Township ==', 'TownshipIcon');
pushResults(game.skills.filter(x => search(x)), '\n== Others ==', 'Skill');
pushResults(game.pets.filter(x => search(x)), '\n== Others ==', 'PetIcon');
pushResults(game.astrology.actions.filter(x => search(x)), '\n== Others ==', 'ConstellationIcon');
pushResults(game.agility.actions.filter(x => search(x)), '\n== Others ==', 'AgilityIcon');
pushResults(game.thieving.actions.filter(x => search(x)), '\n== Others ==', 'Icon', '|type=thieving');
pushResults(game.combatEffects.allObjects.filter(x => search(x)), '\n== Others ==', 'EffectIcon');
pushResults(game.combat.slayerTask.categories.allObjects.filter(x => search(x)), '\n== Others ==', 'Slayer');
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 results for ${searchTerm} to clipboard`, 'success', 0);
</syntaxhighlight>
</syntaxhighlight>
Retrieved from "https://testwiki.melvoridle.com/w/Special:MobileDiff/83498"