Template:Disambiguation/doc: Difference between revisions

Add Fishing and Thieving areas; Add support for Earth Golem (AoD); Move skills back into "Others" category
m (Added expansion icons into output results)
(Add Fishing and Thieving areas; Add support for Earth Golem (AoD); Move skills back into "Others" category)
 
(35 intermediate revisions by 2 users not shown)
Line 1: Line 1:
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.
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 and Currencies) for the given <code>searchTerm</code> then output an array of the results in valid Icon Template format with expansion icons. Requires a bit of cleanup before it can be used on the Wiki. You can right click + Copy Object on the output array to copy the array. With a good text editor such as Notepad++ or Sublime, you can select multiple lines which makes the cleanup take a few seconds.
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, 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]]).


This may result in some duplicates between Icons and Shop Purchases, such as Iron Sieve which is both an Item and Purchase.
<syntaxhighlight lang="javascript" line>
<syntaxhighlight lang="javascript" line>
let searchTerm = ''.toLowerCase();
function disambiguation(searchTerm, returnEquipmentTemplate=false) {
 
let search = (item) => !item.isModded && item.name.toLowerCase().includes(searchTerm.toLowerCase());
const search = (obj) => obj.name.toLowerCase().includes(searchTerm);
let wikiIcon = (item, icon, extras, postText) => {
let results = [];
numResults++;
game.items.filter(x => search(x)).forEach(item => results.push({item: item, icon: 'ItemIcon'}));
if (!returnEquipmentTemplate) {
game.monsters.filter(x => search(x)).forEach(monster => results.push({item: monster, icon: 'MonsterIcon'}));
extras = extras.replaceAll('${NAME}', `${item.name}`);
game.skills.filter(x => search(x)).forEach(skill => results.push({item: skill, icon: 'Skill'}));
let name = item.id === 'melvorAoD:EarthGolem' ? 'Earth Golem (AoD)' : item.name;
game.standardSpells.filter(x => search(x)).forEach(spell => results.push({item: spell, icon: 'SpellIcon'})); // In v1.3, these are
name = name.replace('Potion I', 'Potion');
game.ancientSpells.filter(x => search(x)).forEach(spell => results.push({item: spell, icon: 'SpellIcon'})); // condensed into
let expIcon = `${item.namespace.includes('TotH') ? ' {{TotH}}' : item.namespace.includes('AoD') ? ' {{AoD}}' : item.namespace.includes('ItA') ? ' {{ItA}}' : ' {{Melvor}}'}`;
game.archaicSpells.filter(x => search(x)).forEach(spell => results.push({item: spell, icon: 'SpellIcon'})); // game.attackSpells
let iconTemplate = icon === 'Link' ? ` [[${extras}]]` : ` {{${icon}|${name}${extras}}}`;
game.curseSpells.filter(x => search(x)).forEach(spell => results.push({item: spell, icon: 'SpellIcon'}));
return `*${expIcon}${iconTemplate}${postText}`;
game.auroraSpells.filter(x => search(x)).forEach(spell => results.push({item: spell, icon: 'SpellIcon'}));
}
game.shop.purchases.filter(x => search(x)).forEach(purchase => results.push({item: purchase, icon: 'UpgradeIcon'}));
return `|${item.name}`;
game.pets.filter(x => search(x)).forEach(pet => results.push({item: pet, icon: 'PetIcon'}));
}
game.prayers.filter(x => search(x)).forEach(prayer => results.push({item: prayer, icon: 'PrayerIcon'}));
let pushResults = (arr, header, icon, extras='', postText='') => {
game.combatAreas.filter(x => search(x)).forEach(area => results.push({item: area, icon: 'ZoneIcon'}));
if (arr.length > 0 && !returnEquipmentTemplate && !results.includes(header))
game.slayerAreas.filter(x => search(x)).forEach(area => results.push({item: area, icon: 'ZoneIcon'}));
results += header;
game.dungeons.filter(x => search(x)).forEach(area => results.push({item: area, icon: 'ZoneIcon'}));
arr.forEach(item => {
game.astrology.actions.filter(x => search(x)).forEach(constellation => results.push({item: constellation, icon: 'ConstellationIcon'}));
if (!returnEquipmentTemplate || item.validSlots !== undefined)
game.township.buildings.filter(x => search(x)).forEach(building => results.push({item: building, icon: 'TownshipIcon'}));
results += `\n${wikiIcon(item, icon, extras, postText)}`;
game.township.seasons.filter(x => search(x)).forEach(season => results.push({item: season, icon: 'TownshipIcon'}));
});
game.township.biomes.filter(x => search(x)).forEach(biome => results.push({item: biome, icon: 'TownshipIcon'}));
}
game.township.resources.filter(x => search(x)).forEach(resource => results.push({item: resource, icon: 'TownshipIcon'}));
let results = '', numResults = 0;
game.agility.actions.filter(x => search(x)).forEach(obstacle => results.push({item: obstacle, icon: 'AgilityIcon'}));
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 (cloudManager.hasAoDEntitlementAndIsEnabled)
if (!returnEquipmentTemplate) results += `{{Disam}}\n{{UserContentVersion|${gameVersion.substr(1)}}}\n\n'''${searchTerm}''' may refer to:`;
game.cartography.worldMaps.getObjectByID('melvorAoD:Melvor').pointsOfInterest.filter(x => search(x)).forEach(poi => results.push({item: poi, icon: 'POIIcon'}));
pushResults(game.items.weapons.filter(x => search(x) && !x.validSlots.includes('Quiver')), '\n== Equipment ==', 'ItemIcon');
results.map(x => `*${x.item.namespace?.includes('TotH') ? '{{TotH}}' : x.item.namespace?.includes('AoD') ? '{{AoD}}' : ''}{{${x.icon}|${x.item.name}}}`);
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.astrology.actions.filter(x => search(x)), '\n== Skill Actions ==', 'ConstellationIcon', '', ' (Constellation)');
pushResults(game.agility.actions.filter(x => search(x)), '\n== Skill Actions ==', 'AgilityIcon', '', ' (Agility Obstacle)');
pushResults(game.thieving.actions.filter(x => search(x)), '\n== Skill Actions ==', 'Icon', '|type=thieving', ' (Thieving NPC)');
pushResults(game.thieving.areas.filter(x => search(x)), '\n== Skill Actions ==', 'Link', 'Thieving#${NAME}|${NAME}', ' (Thieving Area)');
pushResults(game.fishing.areas.filter(x => search(x)), '\n== Skill Actions ==', 'Link', 'Fishing#${NAME}|${NAME}', ' (Fishing Area)');
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.skills.filter(x => search(x)), '\n== Others ==', 'Skill');
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);
}
</syntaxhighlight>
</syntaxhighlight>