In-game Functions: Difference between revisions

'''Disclaimer:''' Blindly adding items and experience will most likely take away game enjoyment. It is highly encouraged only to use this to either test things or recoup lost items/progress due to lost saves.

<div class="toclimit-ex">__TOC__</div>

==Using In-game Functions==

On Web, Steam, and Epic, the console can be opened with F12. If using Steam or Epic, you must [[Mod_Creation/Enabling_DevTools_for_the_Steam_and_Epic_Clients|enable the dev console first]] before you are able to open it.

== Add Item to Bank ==

The <code>addItemByID</code> function can be used to add any item in the game to the bank.

=== Attributes ===

For a complete list of items, see: [[Table of Items]]. Item IDs are on their respective wiki page.

|-

| quantity || int || No || || Quantity of item to add.

=== Examples ===

The above code will result in attempting to add 10 {{ItemIcon|Oak Logs}} to the Bank. If they do not fit, 10 will be added to the # of Oak Logs lost on the item's stats. Additionally, Oak Logs will be marked as discovered in the Completion Log.

The above code will add 1,000,000 of every item in the game. The items will be forced into the bank even if you do not have room and there will be no notifications upon adding the items.

== Remove Item from Bank ==

The <code>removeItemQuantityByID</code> function can be used to remove any item from the bank

Note that if an item's quantity is in an invalid state, such as <syntaxhighlight lang="js" inline>NaN</syntaxhighlight> or <syntaxhighlight lang="js" inline>Infinity</syntaxhighlight>, then this function will not be able to remove that item from the bank. For any such items, use the below snippet instead:

=== Examples ===

The above code will result in 10 {{ItemIcon|Oak Logs}} being removed from the bank.

{| class="wikitable"

|-

|-

|-

|}

==== Examples ====

==== Attributes ====

{| class="wikitable"

|-

|-

|}

==== Examples ====

The <code>addPrayerPoints</code> and <code>addSoulPoints</code> functions can be used to add prayer points or soul points to a player.

  game.combat.player.addPrayerPoints(amount);

  game.combat.player.addSoulPoints(amount);

{| class="wikitable"

|-

|-

|}

=== Examples ===

  game.combat.player.addPrayerPoints(1);

  game.combat.player.addSoulPoints(-50);

The first line will add 1 prayer point to the player while the second will remove 50 soul points.

The <code>addXP</code> and <code>addAbyssalXP</code> functions can be used to add or remove experience and abyssal experience from any skill. The <code>setXP</code> and <code>setAbyssalXP</code> can be used to set the new experience or abyssal experience value.

game.<skill>.addXP(xp);

game.<skill>.addAbyssalXP(xp);

{| class="wikitable"

|-

|-

|}

=== Examples ===

game.thieving.addXP(1000);

</syntaxhighlight>

The first line will result in 1,000 experience being added to {{Skill|Thieving}}. The second line will remove 700 abyssal xp from Astrology. The third line will set Attack's level to 120.

The <code>addMasteryXP</code> function can be used to add experience to any specific {{Icon|Mastery}} in a skill.

where <code><skill></code> is the lowercase name of the skill you are adding mastery experience to.

=== Attributes ===

{| class="wikitable"

|-

|-

|-

|}

=== Examples ===

  game.farming.addMasteryXP(game.farming.actions.getObjectByID('melvorD:Carrot'), 300);

  game.farming.addMasteryXP(game.farming.actions.getObjectByID('melvorTotH:Starfruit'), -500);

The first line will result in 300 {{Icon|Mastery}} XP being added to {{Skill|Farming}} for {{ItemIcon|Carrot Seeds}} whereas the second line will remove 500 Mastery XP from {{ItemIcon|Starfruit}}.

The above code will result in 5,000 {{Icon|Mastery}} XP being added to every action within every skill with a mastery action.

The <code>addMasteryPoolXP</code> function can be used to add [[Mastery#The_Mastery_Pool|Mastery Pool]] experience to a skill

where <code><skill></code> is the lowercase name of the skill you are adding mastery experience to.

=== Attributes ===

{| class="wikitable"

|-

|-

A list of realm IDs can be obtained by entering the following into the console: <code>console.log(game.realms.allObjects.map((a) => a.id + ' - ' + a.name).join('\n'))</code>.

|-

|}

=== Examples ===

  game.woodcutting.addMasteryPoolXP(game.realms.getObjectByID('melvorD:Melvor'), 600);

  game.woodcutting.addMasteryPoolXP(game.realms.getObjectByID('melvorItA:Abyssal'), -400);

The first line will result in 600 [[Mastery#The_Mastery_Pool|Mastery Pool]] XP being added to {{Skill|Woodcutting}} in the Melvor Realm whereas the second line will remove 400 mastery pool xp from Woodcutting in the abyssal realm.

The above code will result in 1,000 [[Mastery#The_Mastery_Pool|Mastery Pool]] XP being added to all skills in every realm.

The <code>unlockPetByID</code> function is used to unlock [[Pets]].

=== Attributes ===

{| class="wikitable"

|-

|-

|}

=== Examples ===

  game.petManager.unlockPetByID('melvorD:CoolRock');

  game.petManager.unlocked.delete(game.pets.getObjectByID('melvorD:CoolRock'));game.petManager.computeProvidedStats();

The above code will unlock every single pet.

The <code>discoverMark</code> function is used to discover [[Summoning#Summoning Marks|Summoning Marks]].

=== Attributes ===

{| class="wikitable"

|-

|-

A list of mark IDs can be obtained by entering the following into the console: <syntaxhighlight lang="js" inline>console.log(game.summoning.actions.allObjects.map((a) => a.id + ' - ' + a.name).join('\n'))</syntaxhighlight>.

=== Examples ===

  game.summoning.discoverMark(game.summoning.actions.getObjectByID('melvorF:Dragon'));

  game.summoning.marksUnlocked.delete(game.summoning.actions.getObjectByID('melvorF:Dragon'));

  </syntaxhighlight>

The first line discovers a single mark for the {{ItemIcon|Dragon}} familiar whereas the second line removes all marks from the Dragon.

game.summoning.actions.forEach((mark) => {

game.summoning.marksUnlocked.set(mark, (mark.realm.id === 'melvorD:Melvor') ? 61 : 31);

The above code will set every single mark to level 61 if it's in the Melvor Realm and 31 if it's in the Abyssal Realm then update the mark count and mark states.

The <code>locateAncientRelic</code> function is used to locate [[Ancient Relics#List_of_Ancient_Relics|Ancient Relics]].

where <code><skill></code> is the lowercase name of the skill you wish to add a relic to.

{| class="wikitable"

|-

|-

A list of realms IDs can be obtained by entering the following into the console: <syntaxhighlight lang="js" inline>console.log(game.realms.allObjects.map((a) => a.id + ' - ' + a.name).join('\n'))</syntaxhighlight>. To convert the realmID into a realm object, use <syntaxhighlight lang="js" inline>game.realms.getObjectByID('realmID')</syntaxhighlight>.

|-

The relic can be obtained with <code>relicSet.relicDrops[#].relic;</code> where <code>#</code> is replaced with the relic number, starting from 0 for the first relic and ending with 4 for the 5th relic.

=== Examples ===

let realm = game.realms.getObjectByID('melvorD:Melvor');

let relicSet = game.woodcutting.ancientRelicSets.get(realm);

let relic = relicSet.relicDrops[0].relic;

if (!relicSet.foundRelics.has(relic))

</syntaxhighlight>

The above code locates Woodcutting Relic 1 in the Melvor Realm.

game.skills.forEach(skill => {

game.realms.forEach(realm => {

});

</syntaxhighlight>

== Reset all Equipment Quick Equip Items ==

=== Examples ===

game.combat.player.equipment.equippedArray.forEach(equipped => {

equipped.quickEquipItems = [game.emptyEquipmentItem, game.emptyEquipmentItem, game.emptyEquipmentItem];

</syntaxhighlight>

The above code will reset all the quick equip items for the '''current''' equipment set.

game.combat.player.equipmentSets.forEach(({ equipment }) => {

equipment.equippedArray.forEach(equipped => {

The above code will reset all the quick equip items for '''all''' equipment sets.

The <code>addDungeonCompletion</code> and <code>setDungeonCompleteCount</code> functions are used to modify a dungeon's completion count.

game.combat.player.manager.addDungeonCompletion(dungeon);

game.combat.player.manager.setDungeonCompleteCount(dungeon, amount);

{| class="wikitable"

|-

|-

A list of dungeon IDs can be obtained by entering the following into the console: <syntaxhighlight lang="js" inline>console.log(game.dungeons.allObjects.map((a) => a.id + ' - ' + a.name).join('\n'))</syntaxhighlight>.

If an invalid dungeonID is entered, your game will be unable to be saved until the entry is either removed or the game is reloaded. You can remove the undefined entry with <code>game.combat.player.manager.dungeonCompletion.delete(undefined)</code> which should return <code>true</code> and the errors should stop appearing.

|-

|}

=== Examples ===

</syntaxhighlight>

After modifying the dungeon completion count, run <code>game.queueRequirementRenders();</code> to apply UI updates without having to restart the game.

{| class="wikitable"

|-

|-

|}

==== Examples ====

  game.slayer.increaseLevelCap(20);

  game.thieving.setAbyssalLevelCap(45);

</syntaxhighlight>

The first line will increase {{Skill|Slayer|Slayer's}} level cap by 20 levels whereas the second line will set {{AbyssalSkill|Thieving|Thieving's}} level cap to 45.

  game.skills.forEach(skill => {

skill.setLevelCap(skill.maxLevelCap);

=== Awarding random level caps ===

The below script will award random level cap increases without increasing combat level caps. The only value that must be changed is the <code>capType</code> at the beginning of the script. 0 is a pre-Bane level cap increase, 2 is a TotH level cap increase, and 4 is an ItA level cap increase.

let capType = 0; // 0 = pre-Bane, 2 = TotH, 4 = ItA

let capIncrease = game.currentGamemode.levelCapIncreases[capType];

</syntaxhighlight>

If you wish to also increase combat level caps then the following can be used.

let capType = 0; // 0 = pre-Bane, 2 = TotH, 4 = ItA

let capIncrease = game.currentGamemode.levelCapIncreases[capType];

game.increaseSkillLevelCaps(capIncrease, capIncrease.requirementSets.get(0));

</syntaxhighlight>

{{Menu}}