refactor: A bunch of refactoring and flavor text improvements. New settings as well.

Author: Firebottle

src/firebot/games/register-game.ts

@@ -283,14 +283,27 @@ const gameSettings: Record<string, SettingCategoryDefinition> = {
         description: 'Settings related to combat.',
         sortRank: 5,
         settings: {
+            duelTimeout: {
+                type: 'number',
+                title: 'Duel Timeout',
+                description:
+                    'This is the number of minutes that must pass before a duel request times out.',
+                tip: 'New duels can not be issued to someone until the previous duel times out.',
+                default: 2,
+                sortRank: 1,
+                showBottomHr: false,
+                validation: {
+                    required: true,
+                },
+            },
             offHandMissChance: {
                 type: 'number',
                 title: 'Off hand fumble chance',
                 description:
-                    'If a weapon in the off hand is not "light", this is the fumble chance (skipped turn).',
+                    'If a weapon or spell is in the off hand and is not "light", this is the fumble chance (skipped turn).',
                 tip: 'Setting this lower makes off hand weapons stronger in melee.',
                 default: 25,
-                sortRank: 1,
+                sortRank: 2,
                 showBottomHr: false,
                 validation: {
                     required: true,
@@ -303,7 +316,7 @@ const gameSettings: Record<string, SettingCategoryDefinition> = {
                     'If a ranged weapon is used in melee, this is the fumble chance (skipped turn).',
                 tip: 'Setting this lower makes ranged weapons stronger in melee.',
                 default: 25,
-                sortRank: 1,
+                sortRank: 3,
                 showBottomHr: false,
                 validation: {
                     required: true,
@@ -316,7 +329,7 @@ const gameSettings: Record<string, SettingCategoryDefinition> = {
                     'Divide character stats by this number to determine hit bonus',
                 tip: 'The lower this number, the higher the hit bonus. This will make characters hit more often.',
                 default: 10,
-                sortRank: 2,
+                sortRank: 4,
                 showBottomHr: false,
                 validation: {
                     required: true,
@@ -329,7 +342,7 @@ const gameSettings: Record<string, SettingCategoryDefinition> = {
                     'Divide character stats by this number to determine damage bonus',
                 tip: 'The lower this number, the higher the damage bonus. This will make characters deal more damage.',
                 default: 10,
-                sortRank: 2,
+                sortRank: 5,
                 showBottomHr: false,
                 validation: {
                     required: true,
@@ -342,7 +355,7 @@ const gameSettings: Record<string, SettingCategoryDefinition> = {
                     'This is how fast a character moves in heavy armor.',
                 tip: 'The higher this number, the faster heavy armor characters will approach in the ranged phase of combat.',
                 default: 30,
-                sortRank: 2,
+                sortRank: 6,
                 showBottomHr: false,
                 validation: {
                     required: true,
@@ -355,7 +368,7 @@ const gameSettings: Record<string, SettingCategoryDefinition> = {
                     'This is how fast a character moves in medium armor.',
                 tip: 'The higher this number, the faster medium armor characters will approach in the ranged phase of combat.',
                 default: 40,
-                sortRank: 2,
+                sortRank: 7,
                 showBottomHr: false,
                 validation: {
                     required: true,
@@ -368,7 +381,7 @@ const gameSettings: Record<string, SettingCategoryDefinition> = {
                     'This is how fast a character moves in light armor.',
                 tip: 'The higher this number, the faster light armor characters+ will approach in the ranged phase of combat.',
                 default: 50,
-                sortRank: 2,
+                sortRank: 8,
                 showBottomHr: false,
                 validation: {
                     required: true,
@@ -381,7 +394,7 @@ const gameSettings: Record<string, SettingCategoryDefinition> = {
                     'This is how fast a character moves with no armor.',
                 tip: 'The higher this number, the faster unarmored characters will approach in the ranged phase of combat.',
                 default: 50,
-                sortRank: 2,
+                sortRank: 9,
                 showBottomHr: false,
                 validation: {
                     required: true,
@@ -394,7 +407,7 @@ const gameSettings: Record<string, SettingCategoryDefinition> = {
                     'Percent of dex used when calculating bonus AC for this armor type.',
                 tip: 'The higher this number, the better this armor type becomes.',
                 default: 25,
-                sortRank: 2,
+                sortRank: 10,
                 showBottomHr: false,
                 validation: {
                     required: true,
@@ -407,7 +420,7 @@ const gameSettings: Record<string, SettingCategoryDefinition> = {
                     'Percent of dex used when calculating bonus AC for this armor type.',
                 tip: 'The higher this number, the better this armor type becomes.',
                 default: 50,
-                sortRank: 2,
+                sortRank: 11,
                 showBottomHr: false,
                 validation: {
                     required: true,
@@ -420,7 +433,7 @@ const gameSettings: Record<string, SettingCategoryDefinition> = {
                     'Percent of dex used when calculating bonus AC for this armor type.',
                 tip: 'The higher this number, the better this armor type becomes.',
                 default: 75,
-                sortRank: 2,
+                sortRank: 12,
                 showBottomHr: false,
                 validation: {
                     required: true,
@@ -433,7 +446,59 @@ const gameSettings: Record<string, SettingCategoryDefinition> = {
                     'Percent of dex used when calculating bonus AC for this armor type.',
                 tip: 'The higher this number, the better this armor type becomes.',
                 default: 100,
-                sortRank: 2,
+                sortRank: 13,
+                showBottomHr: false,
+                validation: {
+                    required: true,
+                },
+            },
+            heavyArcaneFailure: {
+                type: 'number',
+                title: 'Heavy Arcane Failure',
+                description:
+                    'Percent chance a spell will fail to cast when wearing this type of armor.',
+                tip: 'Lower numbers makes this armor better for spell users.',
+                default: 50,
+                sortRank: 10,
+                showBottomHr: false,
+                validation: {
+                    required: true,
+                },
+            },
+            mediumArcaneFailure: {
+                type: 'number',
+                title: 'Medium Arcane Failure',
+                description:
+                    'Percent chance a spell will fail to cast when wearing this type of armor.',
+                tip: 'Lower numbers makes this armor better for spell users.',
+                default: 30,
+                sortRank: 10,
+                showBottomHr: false,
+                validation: {
+                    required: true,
+                },
+            },
+            lightArcaneFailure: {
+                type: 'number',
+                title: 'Light Arcane Failure',
+                description:
+                    'Percent chance a spell will fail to cast when wearing this type of armor.',
+                tip: 'Lower numbers makes this armor better for spell users.',
+                default: 0,
+                sortRank: 10,
+                showBottomHr: false,
+                validation: {
+                    required: true,
+                },
+            },
+            nakedArcaneFailure: {
+                type: 'number',
+                title: 'Unarmored Arcane Failure',
+                description:
+                    'Percent chance a spell will fail to cast when wearing this type of armor.',
+                tip: 'Lower numbers makes this armor better for spell users.',
+                default: 0,
+                sortRank: 10,
                 showBottomHr: false,
                 validation: {
                     required: true,

src/systems/characters/characters.ts

@@ -1,6 +1,8 @@
 import {
     Armor,
     CharacterClass,
+    Enchantments,
+    EnchantmentTypes,
     Shield,
     Spell,
     Title,
@@ -103,6 +105,42 @@ export async function getCharacterTotalAC(
     return Math.floor(defenderAC);
 }
 
+/**
+ * Returns defenders defenses against a specific element.
+ * @param defender
+ * @param enchantment
+ * @returns
+ */
+export function getCharacterElementalDefense(
+    defender: Character | GeneratedMonster,
+    enchantment: EnchantmentTypes
+) {
+    let totalDefenderValue = 0;
+    let armor = null;
+    let shield = null;
+
+    if (defender.armor != null) {
+        armor = getItemByID(defender.armor.id, 'armor') as Armor;
+    }
+
+    if (defender.offHand != null && defender.offHand?.itemType === 'shield') {
+        shield = getItemByID(defender.offHand.id, 'shield') as Shield;
+    }
+
+    if (armor != null) {
+        totalDefenderValue +=
+            defender.armor.enchantments[enchantment as keyof Enchantments] +
+            armor.enchantments[enchantment as keyof Enchantments];
+    }
+
+    if (shield != null) {
+        totalDefenderValue +=
+            shield.enchantments[enchantment as keyof Enchantments];
+    }
+
+    return totalDefenderValue;
+}
+
 /**
  * Gets a characters int bonus used in spellcasting and resisting.
  * @param attacker
@@ -195,36 +233,36 @@ export async function getCharacterDamageBonus(
     let item;
     const str = await getAdjustedCharacterStat(attacker, 'str');
     const dex = await getAdjustedCharacterStat(attacker, 'dex');
+    const int = await getAdjustedCharacterStat(attacker, 'int');
 
     // Get our item first.
     if (slot === 'mainHand') {
-        item = getItemByID(attacker.mainHand.id, 'weapon') as Weapon;
+        item = getItemByID(attacker.mainHand.id, 'weapon') as Weapon | Spell;
     }
 
-    if (slot === 'offHand' && attacker.offHand.itemType === 'weapon') {
-        item = getItemByID(attacker.offHand.id, 'weapon') as Weapon;
+    if (slot === 'offHand' && attacker.offHand.itemType !== 'shield') {
+        item = getItemByID(attacker.offHand.id, 'weapon') as Weapon | Spell;
     }
 
     if (item == null) {
         return 0;
     }
 
+    // Item is a spell, use int.
+    if (item.itemType === 'spell') {
+        return Math.floor(int / damageBonusDivider);
+    }
+
     // Now, adjust for item properties.
     if (item.properties.includes('versatile')) {
         return Math.floor(Math.max(str, dex) / damageBonusDivider);
     }
 
-    if (
-        item.properties.includes('heavy') ||
-        item.damage_type === 'bludgeoning'
-    ) {
+    if (item.properties.includes('heavy')) {
         return Math.floor(str / damageBonusDivider);
     }
 
-    if (
-        item.properties.includes('finesse') ||
-        item.damage_type === 'piercing'
-    ) {
+    if (item.properties.includes('finesse')) {
         return Math.floor(dex / damageBonusDivider);
     }
 

src/systems/duels/duels.ts

@@ -1,12 +1,14 @@
 import { startCombat } from '../combat/combat';
+import { getDuelTimeout } from '../settings';
 import { getUserData } from '../user/user';
 
 export function isDuelExpired(date: number | null) {
     if (date == null) {
         return true;
     }
 
-    const timer = 1000 * 60 * 2; // 2 minutes
+    const duelTimeout = getDuelTimeout() ? getDuelTimeout() : 2;
+    const timer = 1000 * 60 * duelTimeout;
     const checked = Date.now() - timer;
 
     return date > checked;

src/systems/equipment/armor.ts

@@ -6,6 +6,7 @@ import {
     StoredArmor,
 } from '../../types/equipment';
 import {
+    getArmorArcaneFailure,
     getArmorDexBonusSettings,
     getArmorMovementSpeedSettings,
 } from '../settings';
@@ -37,7 +38,7 @@ export function getArmorFilteredByRarity(rarity: Rarity[]): Armor {
  * @param armorType
  * @returns
  */
-export function getArmorDexBonus(armorType: ArmorProperties) {
+export function getArmorDexBonus(armorType: ArmorProperties): number {
     return getArmorDexBonusSettings(armorType) / 100;
 }
 
@@ -102,15 +103,6 @@ export async function generateArmorForUser(
  * @param weight
  * @returns
  */
-export function getArcaneFailureChance(
-    weight: 'heavy' | 'medium' | 'light'
-): number {
-    switch (weight) {
-        case 'heavy':
-            return 50;
-        case 'medium':
-            return 30;
-        default:
-            return 0;
-    }
+export function getArcaneFailureChance(weight: ArmorProperties): number {
+    return getArmorArcaneFailure(weight);
 }