Melvor Idle

In-game Functions: Difference between revisions

Page Discussion

In-game Functions (view source)

Revision as of 11:11, 2 January 2023

940 bytes added ,  2 January 2023
Use SyntaxHighlight
m (Bump version)
(Use SyntaxHighlight)
Line 11: Line 11:
== Add Item to Bank ==
== Add Item to Bank ==
The addItemByID function can be used to add any item in the game to the bank.
The addItemByID function can be used to add any item in the game to the bank.
  <nowiki>game.bank.addItemByID(itemID, quantity, logLost, found, ignoreSpace)</nowiki>
  <syntaxhighlight lang="js">game.bank.addItemByID(itemID, quantity, logLost, found, ignoreSpace)</syntaxhighlight>


=== Attributes ===
=== Attributes ===
Line 30: Line 30:


=== Examples ===
=== Examples ===
  <nowiki>game.bank.addItemByID("melvorD:Oak_Logs", 10, true, true, false);</nowiki>
  <syntaxhighlight lang="js">game.bank.addItemByID("melvorD:Oak_Logs", 10, true, true, false);</syntaxhighlight>
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 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.


== Remove Item from Bank ==
== Remove Item from Bank ==
The removeItemQuantityByID function can be used to remove any item from the bank
The removeItemQuantityByID function can be used to remove any item from the bank
  <nowiki>game.bank.removeItemQuantityByID(itemID, quantity, removeItemCharges)</nowiki>
  <syntaxhighlight lang="js">game.bank.removeItemQuantityByID(itemID, quantity, removeItemCharges)</syntaxhighlight>


=== Attributes ===
=== Attributes ===
Line 50: Line 50:


=== Examples ===
=== Examples ===
  <nowiki>game.bank.removeItemQuantityByID("melvorD:Oak_Logs", 10);</nowiki>
  <syntaxhighlight lang="js">game.bank.removeItemQuantityByID("melvorD:Oak_Logs", 10);</syntaxhighlight>
The above code will result in 10 {{ItemIcon|Oak Logs}} being removed from the bank.
The above code will result in 10 {{ItemIcon|Oak Logs}} being removed from the bank.


== Add GP ==
== Add GP ==
The gp.add function can be used to add [[Currency#Gold Pieces|GP]] to a player.
The gp.add function can be used to add [[Currency#Gold Pieces|GP]] to a player.
  <nowiki>game.gp.add(amount)</nowiki>
  <syntaxhighlight lang="js">game.gp.add(amount)</syntaxhighlight>
=== Attributes ===
=== Attributes ===
{| class="wikitable"
{| class="wikitable"
Line 69: Line 69:
== Remove GP ==
== Remove GP ==
The gp.remove function can be used to remove [[Currency#Gold Pieces|GP]] from a player. If the amount specified is greater than the amount the player currently has, then GP will go into the negatives.
The gp.remove function can be used to remove [[Currency#Gold Pieces|GP]] from a player. If the amount specified is greater than the amount the player currently has, then GP will go into the negatives.
  <nowiki>game.gp.remove(amount)</nowiki>
  <syntaxhighlight lang="js">game.gp.remove(amount)</syntaxhighlight>
=== Attributes ===
=== Attributes ===
{| class="wikitable"
{| class="wikitable"
Line 78: Line 78:
|}
|}
=== Examples ===
=== Examples ===
  <nowiki>game.gp.remove(1);</nowiki>
  <syntaxhighlight lang="js">game.gp.remove(1);</syntaxhighlight>
The above code will remove 1 [[Currency#Gold Pieces|GP]] from the player.
The above code will remove 1 [[Currency#Gold Pieces|GP]] from the player.


== Add Slayer Coins ==
== Add Slayer Coins ==
The slayerCoins.add function can be used to add [[Currency#Slayer Coins|Slayer Coins]] to a player.
The slayerCoins.add function can be used to add [[Currency#Slayer Coins|Slayer Coins]] to a player.
  <nowiki>game.slayerCoins.add(amount)</nowiki>
  <syntaxhighlight lang="js">game.slayerCoins.add(amount)</syntaxhighlight>
=== Attributes ===
=== Attributes ===
{| class="wikitable"
{| class="wikitable"
Line 92: Line 92:
|}
|}
=== Examples ===
=== Examples ===
  <nowiki>game.slayerCoins.add(1);</nowiki>
  <syntaxhighlight lang="js">game.slayerCoins.add(1);</syntaxhighlight>
The above code will add 1 [[Currency#Slayer Coins|Slayer Coin]] to the player.
The above code will add 1 [[Currency#Slayer Coins|Slayer Coin]] to the player.


== Remove Slayer Coins ==
== Remove Slayer Coins ==
The slayerCoins.remove function can be used to remove [[Currency#Slayer Coins|Slayer Coins]] from a player. If the amount specified is greater than the amount the player currently has, then slayer coins will go into the negatives.
The slayerCoins.remove function can be used to remove [[Currency#Slayer Coins|Slayer Coins]] from a player. If the amount specified is greater than the amount the player currently has, then slayer coins will go into the negatives.
  <nowiki>game.slayerCoins.remove(amount)</nowiki>
  <syntaxhighlight lang="js">game.slayerCoins.remove(amount)</syntaxhighlight>
=== Attributes ===
=== Attributes ===
{| class="wikitable"
{| class="wikitable"
Line 106: Line 106:
|}
|}
=== Examples ===
=== Examples ===
  <nowiki>game.slayerCoins.remove(1);</nowiki>
  <syntaxhighlight lang="js">game.slayerCoins.remove(1);</syntaxhighlight>
The above code will remove 1 [[Currency#Slayer Coins|Slayer Coin]] from the player.
The above code will remove 1 [[Currency#Slayer Coins|Slayer Coin]] from the player.


== Add Raid Coins==
== Add Raid Coins==
The raidCoins.add function can be used to add [[Currency#Raid Coins|Raid Coins]] to a player.
The raidCoins.add function can be used to add [[Currency#Raid Coins|Raid Coins]] to a player.
  <nowiki>game.raidCoins.add(amount)</nowiki>
  <syntaxhighlight lang="js">game.raidCoins.add(amount)</syntaxhighlight>
=== Attributes ===
=== Attributes ===
{| class="wikitable"
{| class="wikitable"
Line 120: Line 120:
|}
|}
=== Examples ===
=== Examples ===
  <nowiki>game.raidCoins.add(1);</nowiki>
  <syntaxhighlight lang="js">game.raidCoins.add(1);</syntaxhighlight>
The above will add 1 [[Currency#Raid Coins|Raid Coin]] to the player.
The above will add 1 [[Currency#Raid Coins|Raid Coin]] to the player.


== Remove Raid Coins==
== Remove Raid Coins==
The raidCoins.remove function can be used to remove [[Currency#Raid Coins|Raid Coins]] from a player.
The raidCoins.remove function can be used to remove [[Currency#Raid Coins|Raid Coins]] from a player.
  <nowiki>game.raidCoins.remove(amount)</nowiki>
  <syntaxhighlight lang="js">game.raidCoins.remove(amount)</syntaxhighlight>
=== Attributes ===
=== Attributes ===
{| class="wikitable"
{| class="wikitable"
Line 134: Line 134:
|}
|}
=== Examples ===
=== Examples ===
  <nowiki>game.raidCoins.remvoe(1);</nowiki>
  <syntaxhighlight lang="js">game.raidCoins.remvoe(1);</syntaxhighlight>
The above will remove 1 [[Currency#Raid Coins|Raid Coin]] from the player.
The above will remove 1 [[Currency#Raid Coins|Raid Coin]] from the player.


== Add Prayer Points ==
== Add Prayer Points ==
The combat.player.addPrayerPoints function can be used to add prayer points to a player.
The combat.player.addPrayerPoints function can be used to add prayer points to a player.
  <nowiki>game.combat.player.addPrayerPoints(amount)</nowiki>
  <syntaxhighlight lang="js">game.combat.player.addPrayerPoints(amount)</syntaxhighlight>
=== Attributes ===
=== Attributes ===
{| class="wikitable"
{| class="wikitable"
Line 148: Line 148:
|}
|}
=== Examples ===
=== Examples ===
  <nowiki>game.combat.player.addPrayerPoints(1);</nowiki>
  <syntaxhighlight lang="js">game.combat.player.addPrayerPoints(1);</syntaxhighlight>
The above code will add 1 prayer point to the player, and update player stats.
The above code will add 1 prayer point to the player, and update player stats.


== Add XP ==
== Add XP ==
The addXP function can be used to add experience to any skill.
The addXP function can be used to add experience to any skill.
  <nowiki>game.skill.addXP(xp)</nowiki>
  <syntaxhighlight lang="js">game.skill.addXP(xp)</syntaxhighlight>
where <code>skill</code> is the lowercase name of the skill you are adding experience to.
where <code>skill</code> is the lowercase name of the skill you are adding experience to.
=== Attributes ===
=== Attributes ===
Line 163: Line 163:
|}
|}
=== Examples ===
=== Examples ===
  <nowiki>game.thieving.addXP(1000);</nowiki>
  <syntaxhighlight lang="js">game.thieving.addXP(1000);</syntaxhighlight>
The above code will result in 1000 experience being added to {{Skill|Thieving}}.
The above code will result in 1000 experience being added to {{Skill|Thieving}}.


== Add Mastery XP ==
== Add Mastery XP ==
The addMasteryXP function can be used to add experience to any specific {{Icon|Mastery}} in a skill.
The addMasteryXP function can be used to add experience to any specific {{Icon|Mastery}} in a skill.
  <nowiki>game.skill.addMasteryXP(masteryAction, xp)</nowiki>
  <syntaxhighlight lang="js">game.skill.addMasteryXP(masteryAction, xp)</syntaxhighlight>
where <code>skill</code> is the lowercase name of the skill you are adding mastery experience to.
where <code>skill</code> is the lowercase name of the skill you are adding mastery experience to.
=== Attributes ===
=== Attributes ===
Line 175: Line 175:
! Attribute !! Type !! Optional? !! Default Value !! Description
! Attribute !! Type !! Optional? !! Default Value !! Description
|-
|-
| masteryAction || object || No || || The action to add Mastery XP to. Obtained with <code>game.skill.actions.getObjectByID(id)</code> where <code>skill</code> is to be replaced with the name of the skill (all lowercase), and <code>id</code> is the ID of the action.
| masteryAction || object || No || || The action to add Mastery XP to. Obtained with <syntaxhighlight lang="js" inline>game.skill.actions.getObjectByID(id)</syntaxhighlight> where <code>skill</code> is to be replaced with the name of the skill (all lowercase), and <code>id</code> is the ID of the action.


A list of action IDs can be obtained by entering the following into the console: <code>console.log(game.skill.actions.allObjects.map((a) => a.id + ' - ' + a.name).join('\n'))</code>.
A list of action IDs can be obtained by entering the following into the console: <syntaxhighlight lang="js" inline>console.log(game.skill.actions.allObjects.map((a) => a.id + ' - ' + a.name).join('\n'))</syntaxhighlight>.
|-
|-
| xp || int || Yes || 0 || Amount of experience to add.
| xp || int || Yes || 0 || Amount of experience to add.
Line 183: Line 183:


=== Examples ===
=== Examples ===
  <nowiki>game.farming.addMasteryXP(game.farming.actions.getObjectByID('melvorD:Carrot'), 300);</nowiki>
  <syntaxhighlight lang="js">game.farming.addMasteryXP(game.farming.actions.getObjectByID('melvorD:Carrot'), 300);</syntaxhighlight>
The above code will result in 300 {{Icon|Mastery}} XP being added to {{Skill|Farming}} for {{ItemIcon|Carrot Seeds}}.
The above code will result in 300 {{Icon|Mastery}} XP being added to {{Skill|Farming}} for {{ItemIcon|Carrot Seeds}}.


  <nowiki>game.firemaking.addMasteryXP(game.firemaking.actions.getObjectByID('melvorD:Teak_Logs'), 3000);</nowiki>
  <syntaxhighlight lang="js">game.firemaking.addMasteryXP(game.firemaking.actions.getObjectByID('melvorD:Teak_Logs'), 3000);</syntaxhighlight>
The above code will result in 3,000 {{Icon|Mastery}} XP being added to {{Skill|Firemaking}} for {{ItemIcon|Teak Logs}}.
The above code will result in 3,000 {{Icon|Mastery}} XP being added to {{Skill|Firemaking}} for {{ItemIcon|Teak Logs}}.


== Add Mastery XP to Pool==
== Add Mastery XP to Pool==
The addMasteryPoolXP function can be used to add [[Mastery#The_Mastery_Pool|Mastery Pool]] experience to a skill
The addMasteryPoolXP function can be used to add [[Mastery#The_Mastery_Pool|Mastery Pool]] experience to a skill
  <nowiki>game.skill.addMasteryPoolXP(xp)</nowiki>
  <syntaxhighlight lang="js">game.skill.addMasteryPoolXP(xp)</syntaxhighlight>
where <code>skill</code> is the lowercase name of the skill you are adding mastery experience to.
where <code>skill</code> is the lowercase name of the skill you are adding mastery experience to.
=== Attributes ===
=== Attributes ===
Line 201: Line 201:
|}
|}
=== Examples ===
=== Examples ===
  <nowiki>game.woodcutting.addMasteryPoolXP(600);</nowiki>
  <syntaxhighlight lang="js">game.woodcutting.addMasteryPoolXP(600);</syntaxhighlight>
The above code will result in 600 [[Mastery#The_Mastery_Pool|Mastery Pool]] XP being added to {{Skill|Woodcutting}}.
The above code will result in 600 [[Mastery#The_Mastery_Pool|Mastery Pool]] XP being added to {{Skill|Woodcutting}}.


== Unlock Pet ==
== Unlock Pet ==
The petManager.unlockPetByID function is used to unlock [[Pets]]. Note that unlocking a pet is permanent - there is no supported method to lock a pet once again.
The petManager.unlockPetByID function is used to unlock [[Pets]]. Note that unlocking a pet is permanent - there is no supported method to lock a pet once again.
  <nowiki>game.petManager.unlockPetByID(petID)</nowiki>
  <syntaxhighlight lang="js">game.petManager.unlockPetByID(petID)</syntaxhighlight>
=== Attributes ===
=== Attributes ===
{| class="wikitable"
{| class="wikitable"
Line 215: Line 215:
|}
|}
=== Examples ===
=== Examples ===
  <nowiki>game.petManager.unlockPetByID("melvorD:CoolRock");</nowiki>
  <syntaxhighlight lang="js">game.petManager.unlockPetByID('melvorD:CoolRock');</syntaxhighlight>
The above code will result in the unlocking of {{PetIcon|Cool Rock}}.
The above code will result in the unlocking of {{PetIcon|Cool Rock}}.


== Discover Mark ==
== Discover Mark ==
The discoverMark function is used to discover [[Summoning#Summoning Marks|Summoning Marks]]. Once discovered, there is no supported method to allow a mark to become undiscovered again.
The discoverMark function is used to discover [[Summoning#Summoning Marks|Summoning Marks]]. Once discovered, there is no supported method to allow a mark to become undiscovered again.
  <nowiki>game.summoning.discoverMark(mark)</nowiki>
  <syntaxhighlight lang="js">game.summoning.discoverMark(mark)</syntaxhighlight>
=== Attributes ===
=== Attributes ===
{| class="wikitable"
{| class="wikitable"
Line 226: Line 226:
! Attribute !! Type !! Optional? !! Default Value !! Description
! Attribute !! Type !! Optional? !! Default Value !! Description
|-
|-
| mark || object || No || || The mark to discover. Obtained with <code>game.summoning.actions.getObjectByID(markID)</code> where <code>markID</code> is the ID of the mark.
| mark || object || No || || The mark to discover. Obtained with <syntaxhighlight lang="js" inline>game.summoning.actions.getObjectByID(markID)</syntaxhighlight> where <code>markID</code> is the ID of the mark.


A list of mark IDs can be obtained by entering the following into the console: <code>console.log(game.summoning.actions.allObjects.map((a) => a.id + ' - ' + a.name).join('\n'))</code>.
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 ===
=== Examples ===
  <nowiki>game.summoning.discoverMark(game.summoning.actions.getObjectByID('melvorF:Dragon'));</nowiki>
  <syntaxhighlight lang="js">game.summoning.discoverMark(game.summoning.actions.getObjectByID('melvorF:Dragon'));</syntaxhighlight>
The above code discovers a single mark for the {{ItemIcon|Dragon}} familiar.
The above code discovers a single mark for the {{ItemIcon|Dragon}} familiar.
Retrieved from "https://testwiki.melvoridle.com/w/Special:MobileDiff/60184"