166
edits
Silber
Joined 13 June 2021
no edit summary
No edit summary |
No edit summary |
||
| Line 51: | Line 51: | ||
The above code will result in item ID 1 (Oak Logs) to be removed from the bank. | The above code will result in item ID 1 (Oak Logs) to be removed from the bank. | ||
== addXP == | == player.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. | The player.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. | ||
<nowiki>addXP(skillID, xp, forceSkill, dropRares)</nowiki> | <nowiki>player.addXP(skillID, xp, forceSkill, dropRares)</nowiki> | ||
=== Attributes === | === Attributes === | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 68: | Line 68: | ||
|} | |} | ||
=== Examples === | === Examples === | ||
<nowiki>addXP(10, 1000);</nowiki> | <nowiki>player.addXP(10, 1000);</nowiki> | ||
The above code will result in 1000 experience being added to the skill with ID 10 (Thieving). | The above code will result in 1000 experience being added to the skill with ID 10 (Thieving). | ||
== addMasteryXP == | == player.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. | The player.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. | ||
<nowiki>addMasteryXP(skillID, masteryID, timePerAction, spendingXP, xp, addToPool, offline)</nowiki> | <nowiki>player.addMasteryXP(skillID, masteryID, timePerAction, spendingXP, xp, addToPool, offline)</nowiki> | ||
=== Attributes === | === Attributes === | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 125: | Line 125: | ||
=== Examples === | === Examples === | ||
<nowiki>addMasteryXP(11, 13, 0, true, 300);</nowiki> | <nowiki>player.addMasteryXP(11, 13, 0, true, 300);</nowiki> | ||
The above code will result in 300 Mastery XP being added to the skill with ID 11 (Farming) for Mastery ID 13 (Carrot Seeds). | The above code will result in 300 Mastery XP being added to the skill with ID 11 (Farming) for Mastery ID 13 (Carrot Seeds). | ||
<nowiki>addMasteryXP(2, 3, 3000);</nowiki> | <nowiki>player.addMasteryXP(2, 3, 3000);</nowiki> | ||
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. | 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. | ||
== player.addMasteryXpToPool == | |||
The player.addMasteryXpToPool function can be used to add mastery pool experience to a skill | |||
<nowiki>player.addMasteryXP(skillID, xp, offline, token)</nowiki> | |||
=== Attributes === | |||
{| class="wikitable" | |||
|- | |||
! Attribute !! Type !! Optional? !! Default Value !! Description | |||
|- | |||
| skillID || int || No || || The ID of the skill, see: [[#Skill ID|Skill ID]] | |||
|- | |||
| xp || int || Yes || 0 || Amount of experience to add. One quarter of this value will be added if the player is under level 99 in that skill. One half of the value will be added if the player is level 99 in that skill. | |||
|- | |||
| 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 | |||
|- | |||
| token || boolean || Yes || false || Forces forces 100% of the <code>xp</code> value to be added to the pool, ignoring player's level within the skill. | |||
|} | |||
=== Examples === | |||
<nowiki>player.addMasteryXpToPool(11, 600);</nowiki> | |||
The above code will result in 150 Mastery Pool XP being added to the skill with ID 11 (Farming) if the player is under 99 in farming. Or 300 Mastery Pool XP being added if the player is over 99 | |||
<nowiki>player.addMasteryXP(11, 600, false, true);</nowiki> | |||
The above code will result in 600 Mastery Pool XP being added to the skill with ID 11 (Farming) regardless of the level of the player in the skill. | |||
== Reference Tables == | == Reference Tables == | ||