From eb2afa81d57484f86ea48f9b35c350d31d4aedf5 Mon Sep 17 00:00:00 2001 From: Dev Date: Wed, 9 Oct 2024 10:49:22 +0100 Subject: [PATCH] Cleaned up method description --- .../RepeatableQuestRewardGenerator.ts | 20 +++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/project/src/generators/RepeatableQuestRewardGenerator.ts b/project/src/generators/RepeatableQuestRewardGenerator.ts index 8710d1ed..6d3d9df6 100644 --- a/project/src/generators/RepeatableQuestRewardGenerator.ts +++ b/project/src/generators/RepeatableQuestRewardGenerator.ts @@ -52,24 +52,28 @@ export class RepeatableQuestRewardGenerator { } /** - * Generate the reward for a mission. A reward can consist of + * Generate the reward for a mission. A reward can consist of: * - Experience * - Money + * - GP coins + * - Weapon preset * - Items * - Trader Reputation + * - Skill level experience * * The reward is dependent on the player level as given by the wiki. The exact mapping of pmcLevel to * experience / money / items / trader reputation can be defined in QuestConfig.js * - * There's also a random variation of the reward the spread of which can be also defined in the config. + * There's also a random variation of the reward the spread of which can be also defined in the config * * Additionally, a scaling factor w.r.t. quest difficulty going from 0.2...1 can be used - * - * @param {integer} pmcLevel player's level - * @param {number} difficulty a reward scaling factor from 0.2 to 1 - * @param {string} traderId the trader for reputation gain (and possible in the future filtering of reward item type based on trader) - * @param {object} repeatableConfig The configuration for the repeatable kind (daily, weekly) as configured in QuestConfig for the requested quest - * @returns {object} object of "Reward"-type that can be given for a repeatable mission + * @param pmcLevel Level of player reward is being generated for + * @param difficulty Reward scaling factor from 0.2 to 1 + * @param traderId Trader reward will be given by + * @param repeatableConfig Config for quest type (daily, weekly) + * @param questConfig + * @param rewardTplBlacklist OPTIONAL: list of tpls to NOT use when picking a reward + * @returns IQuestRewards */ public generateReward( pmcLevel: number,