Merge pull request #427 from fmasa/encumbrance-exclude

Option to exclude trapping from Encumbrance calculation

Author: fmasa

common/src/commonMain/kotlin/cz/frantisekmasa/wfrp_master/common/character/trappings/EditPlayerDataDialog.kt

@@ -17,12 +17,14 @@ fun EditPlayerDataDialog(
                 itemFlaws = trapping.itemFlaws,
                 quantity = trapping.quantity,
                 note = trapping.note,
+                isEncumbranceCounted = trapping.isEncumbranceCounted,
             ),
         onSaveRequest = {
             onSaveRequest(
                 trapping.update(
                     itemQualities = it.itemQualities,
                     itemFlaws = it.itemFlaws,
+                    isEncumbranceCounted = it.isEncumbranceCounted,
                     quantity = it.quantity,
                     note = it.note,
                 ),

common/src/commonMain/kotlin/cz/frantisekmasa/wfrp_master/common/character/trappings/EncumbranceCountedCheckbox.kt

@@ -0,0 +1,26 @@
+package cz.frantisekmasa.wfrp_master.common.character.trappings
+
+import androidx.compose.foundation.layout.Row
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.MutableState
+import androidx.compose.ui.Modifier
+import cz.frantisekmasa.wfrp_master.common.Str
+import cz.frantisekmasa.wfrp_master.common.core.ui.forms.CheckboxWithText
+import cz.frantisekmasa.wfrp_master.common.core.ui.primitives.InfoIcon
+import dev.icerock.moko.resources.compose.stringResource
+
+@Composable
+fun EncumbranceCountedCheckbox(state: MutableState<Boolean>) {
+    Row {
+        CheckboxWithText(
+            modifier = Modifier.weight(1f),
+            text = stringResource(Str.trappings_label_encumbrance_counted),
+            checked = state.value,
+            onCheckedChange = { state.value = it },
+        )
+        InfoIcon(
+            title = stringResource(Str.trappings_label_encumbrance_counted),
+            text = stringResource(Str.trappings_label_encumbrance_counted_subtext),
+        )
+    }
+}

common/src/commonMain/kotlin/cz/frantisekmasa/wfrp_master/common/character/trappings/NonCompendiumTrappingForm.kt

@@ -1,5 +1,6 @@
 package cz.frantisekmasa.wfrp_master.common.character.trappings
 
+import androidx.compose.foundation.layout.Column
 import androidx.compose.foundation.text.KeyboardOptions
 import androidx.compose.runtime.Composable
 import androidx.compose.runtime.MutableState
@@ -91,14 +92,18 @@ fun NonCompendiumTrappingForm(
             keyboardOptions = KeyboardOptions.Default.copy(keyboardType = KeyboardType.Number),
         )
 
-        TextInput(
-            label = stringResource(Str.trappings_label_encumbrance_per_unit),
-            value = formData.encumbrance,
-            maxLength = 8,
-            validate = validate,
-            keyboardOptions = KeyboardOptions.Default.copy(keyboardType = KeyboardType.Number),
-            filters = listOf(Filter.DecimalNumber),
-        )
+        Column {
+            TextInput(
+                label = stringResource(Str.trappings_label_encumbrance_per_unit),
+                value = formData.encumbrance,
+                maxLength = 8,
+                validate = validate,
+                keyboardOptions = KeyboardOptions.Default.copy(keyboardType = KeyboardType.Number),
+                filters = listOf(Filter.DecimalNumber),
+            )
+
+            EncumbranceCountedCheckbox(formData.isEncumbranceCounted)
+        }
 
         TextInput(
             label = stringResource(Str.trappings_label_description),
@@ -170,6 +175,7 @@ private fun TrappingTypeForm(
                 WeaponQualitiesPicker(formData)
                 WeaponFlawsPicker(formData)
             }
+
             TrappingTypeOption.ARMOUR -> {
                 SelectBox(
                     label = stringResource(Str.armour_label_type),
@@ -187,9 +193,11 @@ private fun TrappingTypeForm(
                 ArmourQualitiesPicker(formData.armourQualities)
                 ArmourFlawsPicker(formData.armourFlaws)
             }
+
             TrappingTypeOption.CLOTHING_OR_ACCESSORY, TrappingTypeOption.PROSTHETIC -> {
                 WornCheckbox(formData)
             }
+
             TrappingTypeOption.CONTAINER -> {
                 TextInput(
                     label = stringResource(Str.trappings_label_carries),
@@ -198,6 +206,7 @@ private fun TrappingTypeForm(
                 )
                 WornCheckbox(formData)
             }
+
             TrappingTypeOption.MELEE_WEAPON -> {
                 WeaponEquipSelect(formData)
                 SelectBox(
@@ -216,6 +225,7 @@ private fun TrappingTypeForm(
                 WeaponQualitiesPicker(formData)
                 WeaponFlawsPicker(formData)
             }
+
             TrappingTypeOption.RANGED_WEAPON -> {
                 WeaponEquipSelect(formData)
                 SelectBox(
@@ -241,6 +251,7 @@ private fun TrappingTypeForm(
                 WeaponQualitiesPicker(formData)
                 WeaponFlawsPicker(formData)
             }
+
             TrappingTypeOption.BOOK_OR_DOCUMENT,
             TrappingTypeOption.DRUG_OR_POISON,
             TrappingTypeOption.MISCELLANEOUS,
@@ -249,7 +260,8 @@ private fun TrappingTypeForm(
             TrappingTypeOption.SPELL_INGREDIENT,
             TrappingTypeOption.TOOL_OR_KIT,
             TrappingTypeOption.TRADE_TOOLS,
-            -> {}
+            -> {
+            }
         }
 }
 
@@ -312,6 +324,7 @@ private class InventoryItemFormData(
     val itemFlaws: MutableState<Set<ItemFlaw>>,
     val description: InputValue,
     val type: TrappingTypeFormData,
+    val isEncumbranceCounted: MutableState<Boolean>,
 ) : HydratedFormData<InventoryItem> {
     override fun isValid() = listOf(name, encumbrance, quantity, description).all { it.isValid() } && type.isValid()
 
@@ -337,6 +350,7 @@ private class InventoryItemFormData(
                     containerId
                 },
             compendiumId = null,
+            isEncumbranceCounted = isEncumbranceCounted.value,
         )
     }
 
@@ -365,6 +379,12 @@ private class InventoryItemFormData(
             description = inputValue(item?.description ?: ""),
             type = TrappingTypeFormData.fromTrappingType(item?.trappingType),
             containerId = item?.containerId ?: defaultContainerId,
+            isEncumbranceCounted =
+                rememberSaveable {
+                    mutableStateOf(
+                        item?.isEncumbranceCounted ?: true,
+                    )
+                },
         )
     }
 }
@@ -396,6 +416,7 @@ private class TrappingTypeFormData(
                     ammunitionWeaponGroups.value.isNotEmpty() &&
                     damage.isValid()
             }
+
             TrappingTypeOption.ARMOUR -> armourLocations.value.isNotEmpty() && armourPoints.isValid()
             TrappingTypeOption.CONTAINER -> carries.isValid()
             TrappingTypeOption.MELEE_WEAPON -> damage.isValid()
@@ -423,6 +444,7 @@ private class TrappingTypeFormData(
                     flaws = weaponFlaws.toMap(),
                     damage = DamageExpression(damage.value),
                 )
+
             TrappingTypeOption.ARMOUR ->
                 TrappingType.Armour(
                     locations = armourLocations.value,
@@ -432,16 +454,19 @@ private class TrappingTypeFormData(
                     qualities = armourQualities.toMap(),
                     flaws = armourFlaws.toMap(),
                 )
+
             TrappingTypeOption.BOOK_OR_DOCUMENT -> TrappingType.BookOrDocument
             TrappingTypeOption.CLOTHING_OR_ACCESSORY ->
                 TrappingType.ClothingOrAccessory(
                     worn = worn.value,
                 )
+
             TrappingTypeOption.CONTAINER ->
                 TrappingType.Container(
                     carries = Encumbrance(carries.toDouble()),
                     worn = worn.value,
                 )
+
             TrappingTypeOption.DRUG_OR_POISON -> TrappingType.DrugOrPoison
             TrappingTypeOption.FOOD_OR_DRINK -> TrappingType.FoodOrDrink
             TrappingTypeOption.HERB_OR_DRAUGHT -> TrappingType.HerbOrDraught
@@ -454,6 +479,7 @@ private class TrappingTypeFormData(
                     flaws = weaponFlaws.toMap(),
                     equipped = weaponEquipped.value,
                 )
+
             TrappingTypeOption.PROSTHETIC -> TrappingType.Prosthetic(worn = worn.value)
             TrappingTypeOption.RANGED_WEAPON ->
                 TrappingType.RangedWeapon(
@@ -464,6 +490,7 @@ private class TrappingTypeFormData(
                     flaws = weaponFlaws.toMap(),
                     equipped = weaponEquipped.value,
                 )
+
             TrappingTypeOption.SPELL_INGREDIENT -> TrappingType.SpellIngredient
             TrappingTypeOption.MISCELLANEOUS -> null
             TrappingTypeOption.TOOL_OR_KIT -> TrappingType.ToolOrKit
@@ -484,6 +511,7 @@ private class TrappingTypeFormData(
                         weaponQualities = type.qualities,
                         weaponFlaws = type.flaws,
                     )
+
                 is TrappingType.Armour ->
                     fromDefaults(
                         type = TrappingTypeOption.ARMOUR,
@@ -494,18 +522,21 @@ private class TrappingTypeFormData(
                         armourFlaws = type.flaws,
                         worn = type.worn,
                     )
+
                 is TrappingType.BookOrDocument -> fromDefaults(TrappingTypeOption.BOOK_OR_DOCUMENT)
                 is TrappingType.ClothingOrAccessory ->
                     fromDefaults(
                         type = TrappingTypeOption.CLOTHING_OR_ACCESSORY,
                         worn = type.worn,
                     )
+
                 is TrappingType.Container ->
                     fromDefaults(
                         type = TrappingTypeOption.CONTAINER,
                         carries = type.carries,
                         worn = type.worn,
                     )
+
                 is TrappingType.DrugOrPoison -> fromDefaults(TrappingTypeOption.DRUG_OR_POISON)
                 is TrappingType.HerbOrDraught -> fromDefaults(TrappingTypeOption.HERB_OR_DRAUGHT)
                 is TrappingType.MeleeWeapon ->
@@ -518,11 +549,13 @@ private class TrappingTypeFormData(
                         weaponFlaws = type.flaws,
                         weaponEquipped = type.equipped,
                     )
+
                 is TrappingType.Prosthetic ->
                     fromDefaults(
                         type = TrappingTypeOption.PROSTHETIC,
                         worn = type.worn,
                     )
+
                 is TrappingType.RangedWeapon ->
                     fromDefaults(
                         type = TrappingTypeOption.RANGED_WEAPON,
@@ -533,6 +566,7 @@ private class TrappingTypeFormData(
                         weaponFlaws = type.flaws,
                         weaponEquipped = type.equipped,
                     )
+
                 is TrappingType.SpellIngredient -> fromDefaults(TrappingTypeOption.SPELL_INGREDIENT)
                 TrappingType.FoodOrDrink -> fromDefaults(TrappingTypeOption.FOOD_OR_DRINK)
                 TrappingType.ToolOrKit -> fromDefaults(TrappingTypeOption.TOOL_OR_KIT)

common/src/commonMain/kotlin/cz/frantisekmasa/wfrp_master/common/character/trappings/TrappingFromCompendiumForm.kt

@@ -46,6 +46,7 @@ fun TrappingFromCompendiumForm(
     val noteField = inputValue(data.note)
     val qualityValues = rememberSaveable { mutableStateOf(data.itemQualities) }
     val flawValues = rememberSaveable { mutableStateOf(data.itemFlaws) }
+    val isEncumbranceCounted = rememberSaveable { mutableStateOf(data.isEncumbranceCounted) }
     var validate by remember { mutableStateOf(false) }
 
     Scaffold(
@@ -72,6 +73,7 @@ fun TrappingFromCompendiumForm(
                                         itemFlaws = flawValues.value,
                                         quantity = quantityField.toInt().coerceAtLeast(1),
                                         note = noteField.value,
+                                        isEncumbranceCounted = isEncumbranceCounted.value,
                                     ),
                                 )
                                 onDismissRequest()
@@ -114,12 +116,16 @@ fun TrappingFromCompendiumForm(
                 selected = flawValues,
             )
 
-            TextInput(
-                label = stringResource(Str.trappings_label_quantity),
-                value = quantityField,
-                validate = validate,
-                keyboardOptions = KeyboardOptions.Default.copy(keyboardType = KeyboardType.Number),
-            )
+            Column {
+                TextInput(
+                    label = stringResource(Str.trappings_label_quantity),
+                    value = quantityField,
+                    validate = validate,
+                    keyboardOptions = KeyboardOptions.Default.copy(keyboardType = KeyboardType.Number),
+                )
+
+                EncumbranceCountedCheckbox(isEncumbranceCounted)
+            }
         }
     }
 }
@@ -129,4 +135,5 @@ data class TrappingFromCompendiumPlayerData(
     val itemFlaws: Set<ItemFlaw>,
     val quantity: Int,
     val note: String,
+    val isEncumbranceCounted: Boolean,
 )

common/src/commonMain/kotlin/cz/frantisekmasa/wfrp_master/common/character/trappings/add/AddTrappingScreen.kt

@@ -65,6 +65,7 @@ class AddTrappingScreen(
                             itemFlaws = emptySet(),
                             quantity = 1,
                             note = "",
+                            isEncumbranceCounted = true,
                         ),
                     onSaveRequest = {
                         val item =

common/src/commonMain/kotlin/cz/frantisekmasa/wfrp_master/common/core/domain/trappings/InventoryItem.kt

@@ -33,6 +33,7 @@ data class InventoryItem(
     val trappingType: TrappingType? = null,
     val itemQualities: Set<ItemQuality> = emptySet(),
     val itemFlaws: Set<ItemFlaw> = emptySet(),
+    val isEncumbranceCounted: Boolean = true,
     override val compendiumId: UuidAsString? = null,
 ) : CharacterItem<InventoryItem, Trapping> {
     init {
@@ -42,6 +43,10 @@ data class InventoryItem(
 
     @Stable
     val effectiveEncumbrance: Encumbrance get() {
+        if (!isEncumbranceCounted) {
+            return Encumbrance.Zero
+        }
+
         if (containerId != null) {
             // Encumbrance of items carried in a container are ignored, see rulebook page 301
             return Encumbrance.Zero
@@ -76,6 +81,7 @@ data class InventoryItem(
     fun update(
         itemQualities: Set<ItemQuality>,
         itemFlaws: Set<ItemFlaw>,
+        isEncumbranceCounted: Boolean,
         quantity: Int,
         note: String,
     ): InventoryItem =
@@ -86,6 +92,7 @@ data class InventoryItem(
                     encumbranceModifier(this.itemQualities, this.itemFlaws),
             itemQualities = itemQualities,
             itemFlaws = itemFlaws,
+            isEncumbranceCounted = isEncumbranceCounted,
             quantity = quantity,
             note = note,
         )

common/src/commonMain/moko-resources/base/strings.xml

@@ -678,6 +678,8 @@
     <string name="trappings_availability_rare">Rare</string>
     <string name="trappings_availability_scarce">Scarce</string>
     <string name="trappings_label_availability">Availability</string>
+    <string name="trappings_label_encumbrance_counted">Count Encumbrance</string>
+    <string name="trappings_label_encumbrance_counted_subtext">Add this encumbrance to character\'s encumbrance (uncheck if not carried around e.g. a cart)</string>
     <string name="trappings_label_carries">Carries</string>
     <string name="trappings_label_description">Description (optional)</string>
     <string name="trappings_label_encumbrance_per_unit">Encumbrance (per unit)</string>

firebase/firestore.rules

@@ -342,7 +342,7 @@ service cloud.firestore {
                     allow delete: if canEditCharacter();
 
                     function isValidInventoryItem(item) {
-                        return ["id", "name", "description", "note", "quantity", "encumbrance", "trappingType", "containerId", "compendiumId", "itemQualities", "itemFlaws"].hasAll(item.keys())
+                        return ["id", "name", "description", "note", "quantity", "encumbrance", "trappingType", "containerId", "compendiumId", "itemQualities", "itemFlaws", "isEncumbranceCounted"].hasAll(item.keys())
                             && item.id is string && item.id == itemId && isValidUuid(item.id)
                             && item.name is string && isNotBlank(item.name) && item.name.size() <= 50
                             && item.description is string && item.description.size() <= 2500
@@ -353,7 +353,8 @@ service cloud.firestore {
                                 || item.containerId == null || containerExists(item.containerId)
                             )
                             && (! ("note" in item) || (item.note is string && item.note.size() <= 500))
-                            && (!("compendiumId" in item) || (item.compendiumId == null || (item.compendiumId is string && exists(/databases/$(database)/documents/parties/$(partyId)/trappings/$(item.compendiumId)))));
+                            && (!("compendiumId" in item) || (item.compendiumId == null || (item.compendiumId is string && exists(/databases/$(database)/documents/parties/$(partyId)/trappings/$(item.compendiumId)))))
+                            && (!("isEncumbranceCounted" in item) || item.isEncumbranceCounted is bool);
                     }
 
                     function containerExists(containerId) {