In-game Functions: Difference between revisions

From Melvor Idle
m (Amend example)
mNo edit summary
Line 58: Line 58:
! Attribute !! Type !! Optional? !! Default !! Description
! Attribute !! Type !! Optional? !! Default !! Description
|-
|-
| skill || int || No || || The ID of the skill
| skillID || int || No || || The ID of the skill
|-
|-
| masteryID || int || No || || The skill specific Mastery ID. See [[#Mastery IDs|below]] for information on how to identify Mastery ID values
| masteryID || int || No || || The skill specific Mastery ID. See [[#Mastery IDs|below]] for information on how to identify Mastery ID values

Revision as of 16:41, 26 December 2020

This page was last updated for (v0.18.0).

In-game functions are responsible for most things in the game. It is possible to interact directly with them through the console. This can be used to add items, levels, GP and more. These functions can be executed though the console. To access the console open Developer Tools (usually by pressing F12) in your browser and navigate to the console. Then, simply paste the code in the input field and press enter. Most functions will require you to fill out variables in the code before executing them. Note that all code is case sensitive.

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

Disclaimer: You are playing around with the code of the game if you make mistakes, it is possible that could corrupt your game. It is highly recommended to BACKUP YOUR SAVE before running any in-game functions.

addItemToBank

The addItemToBank function can be used to add any item in the game to the bank.

addItemToBank(itemID, quantity, found, showNotification, ignoreBankSpace)

Attributes

Attribute Type Optional? Default Value Description
itemID int No The ID of the item.
For a complete list of items and their IDs, see: Table of Items
quantity int No Quantity of item to add. Will remove items from the bank if a negative value is specified
found boolean Yes true Determines if it will show in item completion log
showNotification boolean Yes true Determines if it will show notification
ignoreBankSpace boolean Yes false If true, the item will be added to the bank even if the bank is already full

Examples

addItemToBank(1, 10, false);

The above code will result in 10 items with item ID 1 (Oak Logs) being added to the Bank without them appearing in the item completion log, but with notification.

addXP

The addXP function can be used to add experience to any skill. Note that the game will not visually show the updated XP until after refresh or 1 new action.

addXP(skillID, xp, forceSkill, dropRares)

Attributes

Attribute Type Optional? Default Value Description
skillID int No The ID of the skill
xp int No Amount of experience to add. Note that this is the amount of experience added before bonuses such as that from the Firemaking Skillcape or Pyro
forceSkill boolean Yes false Determines whether experience boosts normally conditional on the skill (such as that granted by the Ancient Ring of Skills) are applied regardless of the skill experience is being added to
dropRares boolean Yes true Determines if rolls for items that have a chance of dropping when the player earns experience are performed (currently includes Mastery Tokens, Crown of Rhaelyx parts, and Mysterious Stones)

Examples

addXP(10, 1000);

The above code will result in 1000 experience being added to the skill with ID 10 (Thieving).

addMasteryXP

The addMasteryXP function can be used to add experience to any specific Mastery in a skill. Note that the game will not visually show the updated Masterry experience until after refresh or 1 new action.

addMasteryXP(skillID, masteryID, timePerAction, spendingXP, xp, addToPool, offline)

Attributes

Attribute Type Optional? Default Description
skillID int No The ID of the skill
masteryID int No The skill specific Mastery ID. See below for information on how to identify Mastery ID values
timePerAction int No The interval (in milliseconds) of the action granting mastery experience. Has no effect on the result if spendingXP is true
spendingXP boolean Yes false true: The amount of experience specified with xp is added, timePerAction is ignored
false: The amount of experience added is determined by the Mastery experience per action calculation, xp is ignored
xp int Yes 0 Amount of experience to add. Has no effect on the result if spendingXP is false
addToPool boolean Yes true Determines whether a portion of the specified experience amount is added to the mastery pool for the relevant skill or not
offline boolean Yes false Determines if various UI elements are immediately updated to reflect the experience gain. Should usually be left as the default value

Mastery IDs

Below is a reference of how the various mastery ID values may be identified.

Skill Mastery ID
Woodcutting Index of the required tree within the constant trees
Thieving Index of the required NPC within the constant thievingNPC
Farming items[itemID].masteryID[1] replacing itemID with the ID of the planted seed
Fishing items[itemID].masteryID[1], replacing itemID with the ID of the item produced by the action
Firemaking
Cooking
Mining
Smithing
Fletching
Crafting
Runecrafting
Herblore

Examples

addMasteryXP(11, 13, 0, true, 300);

The above code will result in 300 Mastery XP being added to the skill with ID 11 (Farming) for Mastery ID 13 (Carrot Seeds).

addMasteryXP(2, 3, 3000);

The above code will result in the calculation & addition of the amount of Mastery XP from an action in skill with ID 2 (Firemaking) for item with Mastery ID 3 (Teak Logs), supposing the action took 3,000 milliseconds.