-
Notifications
You must be signed in to change notification settings - Fork 86
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #393 from Jameskmonger/mining-task
refactor: ♻️ convert mining to new task system
- Loading branch information
Showing
7 changed files
with
1,487 additions
and
1,312 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| import { randomBetween } from '@engine/util'; | ||
| import { IHarvestable } from '@engine/world/config'; | ||
|
|
||
| /** | ||
| * Roll a random number between 0 and 255 and compare it to the percent needed to mine the ore. | ||
| * | ||
| * @param ore The ore to mine | ||
| * @param toolLevel The level of the pickaxe being used | ||
| * @param miningLevel The player's mining level | ||
| * | ||
| * @returns True if the tree was successfully cut, false otherwise | ||
| */ | ||
| export const canMine = ( | ||
| ore: IHarvestable, | ||
| toolLevel: number, | ||
| miningLevel: number | ||
| ): boolean => { | ||
| const successChance = randomBetween(0, 255); | ||
|
|
||
| const percentNeeded = | ||
| ore.baseChance + toolLevel + miningLevel; | ||
| return successChance <= percentNeeded; | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,144 @@ | ||
| import { LandscapeObject } from '@runejs/filestore'; | ||
| import { findItem } from '@engine/config'; | ||
| import { ActorLandscapeObjectInteractionTask } from '@engine/task/impl'; | ||
| import { colors, colorText, randomBetween } from '@engine/util'; | ||
| import { Player, Skill } from '@engine/world/actor'; | ||
| import { HarvestTool, IHarvestable, soundIds } from '@engine/world/config'; | ||
| import { checkForGemBoost } from '@engine/world/skill-util/glory-boost'; | ||
| import { rollGemType } from '@engine/world/skill-util/harvest-roll'; | ||
| import { canMine } from './chance'; | ||
|
|
||
| /** | ||
| * A task that handles mining. It is a subclass of ActorLandscapeObjectInteractionTask, which means that it will | ||
| * walk to the object, and then execute the task when it is in range. | ||
| * | ||
| * The mining task will repeat until the player's inventory is full, or the rock is depleted, or the task is otherwise | ||
| * stopped. | ||
| * | ||
| * @author jameskmonger | ||
| */ | ||
| export class MiningTask extends ActorLandscapeObjectInteractionTask<Player> { | ||
| /** | ||
| * The number of ticks that have elapsed since this task was started. | ||
| * | ||
| * We use this to determine when to mine the next ore, or play the next animation. | ||
| */ | ||
| private elapsedTicks = 0; | ||
|
|
||
| /** | ||
| * The name of the item that we are mining. | ||
| */ | ||
| private targetItemName: string; | ||
|
|
||
| constructor(player: Player, landscapeObject: LandscapeObject, private readonly ore: IHarvestable, private readonly tool: HarvestTool) { | ||
| super(player, landscapeObject); | ||
|
|
||
| const item = findItem(ore.itemId); | ||
|
|
||
| if (!item) { | ||
| throw new Error(`Could not find item with ID ${ore.itemId}`); | ||
| } | ||
|
|
||
| this.targetItemName = item.name.toLowerCase().replace(' ore', '') | ||
| } | ||
|
|
||
| public execute(): void { | ||
| const taskIteration = this.elapsedTicks++; | ||
|
|
||
| // This will be null if the player is not in range of the object. | ||
| if (!this.landscapeObject) { | ||
| return; | ||
| } | ||
|
|
||
| if (!this.hasLevel()) { | ||
| this.actor.sendMessage(`You need a Mining level of ${this.ore.level} to mine this rock.`, true); | ||
| return; | ||
| } | ||
|
|
||
| if (!this.hasMaterials()) { | ||
| this.actor.sendMessage('You do not have a pickaxe for which you have the level to use.'); | ||
| return; | ||
| } | ||
|
|
||
| // Check if the players inventory is full, and notify them if its full. | ||
| if (!this.actor.inventory.hasSpace()) { | ||
| this.actor.sendMessage(`Your inventory is too full to hold any more ${this.targetItemName}.`, true); | ||
| this.actor.playSound(soundIds.inventoryFull); | ||
| return; | ||
| } | ||
|
|
||
| // mining in original plugin took 3 ticks to mine a rock, so we'll do the same for now | ||
| if (taskIteration % 3 !== 0) { | ||
| return; | ||
| } | ||
|
|
||
| this.actor.playSound(soundIds.pickaxeSwing, 7, 0); | ||
| this.actor.playAnimation(this.tool.animation); | ||
|
|
||
| // Get tool level, and set it to 2 if the tool is an iron hatchet or iron pickaxe | ||
| // TODO why is this set to 2? Was ported from the old code | ||
| let toolLevel = this.tool.level - 1; | ||
| if(this.tool.itemId === 1349 || this.tool.itemId === 1267) { | ||
| toolLevel = 2; | ||
| } | ||
|
|
||
| // roll for success | ||
| const succeeds = canMine(this.ore, toolLevel, this.actor.skills.mining.level); | ||
| if(!succeeds) { | ||
| return; | ||
| } | ||
|
|
||
| const findsRareGem = randomBetween(1, checkForGemBoost(this.actor)) === 1; | ||
| if (findsRareGem) { | ||
| this.actor.sendMessage(colorText('You found a rare gem.', colors.red)); | ||
| this.actor.giveItem(rollGemType()); | ||
| } else { | ||
| this.actor.sendMessage(`You manage to mine some ${this.targetItemName}.`); | ||
| this.actor.giveItem(this.ore.itemId); | ||
|
|
||
| // TODO (Jameskmonger) handle Gem rocks and Pure essence rocks | ||
| // if (itemToAdd === 1436 && details.player.skills.hasLevel(Skill.MINING, 30)) { | ||
| // itemToAdd = 7936; | ||
| // } | ||
| // if (details.object.objectId === 2111 && details.player.skills.hasLevel(Skill.MINING, 30)) { | ||
| // itemToAdd = rollGemRockResult().itemId; | ||
| // } | ||
| } | ||
|
|
||
| this.actor.skills.addExp(Skill.MINING, this.ore.experience); | ||
|
|
||
| // check if the rock is depleted | ||
| if (randomBetween(0, 100) <= this.ore.break) { | ||
| this.actor.playSound(soundIds.oreDepeleted); | ||
| this.actor.playAnimation(null); | ||
|
|
||
| const replacementObject = this.ore.objects.get(this.landscapeObject.objectId); | ||
|
|
||
| if (replacementObject) { | ||
| const respawnTime = randomBetween(this.ore.respawnLow, this.ore.respawnHigh); | ||
| this.actor.instance.replaceGameObject(replacementObject, this.landscapeObject, respawnTime); | ||
| } | ||
|
|
||
| this.stop(); | ||
| return; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Checks if the player has the pickaxe they started with. | ||
| * | ||
| * @returns true if the player has the pickaxe, false otherwise | ||
| */ | ||
| private hasMaterials() { | ||
| return this.actor.inventory.has(this.tool.itemId); | ||
| } | ||
|
|
||
| /** | ||
| * Check that the player still has the level to mine the ore. | ||
| * | ||
| * @returns true if the player has the level, false otherwise | ||
| */ | ||
| private hasLevel() { | ||
| return this.actor.skills.hasLevel(Skill.MINING, this.ore.level); | ||
| } | ||
| } |
Oops, something went wrong.