Add help and examine dialogs

Author: Adam Arold

src/main/kotlin/org/hexworks/cavesofzircon/systems/InputReceiver.kt

@@ -10,9 +10,11 @@ import org.hexworks.cavesofzircon.commands.MoveUp
 import org.hexworks.cavesofzircon.commands.PickItemUp
 import org.hexworks.cavesofzircon.extensions.GameEntity
 import org.hexworks.cavesofzircon.extensions.position
+import org.hexworks.cavesofzircon.view.dialog.HelpDialog
 import org.hexworks.cavesofzircon.world.GameContext
 import org.hexworks.cobalt.logging.api.LoggerFactory
 import org.hexworks.zircon.api.data.impl.Position3D
+import org.hexworks.zircon.api.screen.Screen
 import org.hexworks.zircon.api.uievent.KeyCode
 import org.hexworks.zircon.api.uievent.KeyboardEvent
 
@@ -33,6 +35,7 @@ object InputReceiver : BaseBehavior<GameContext>() {
                 KeyCode.KEY_F -> player.moveDown(context)
                 KeyCode.KEY_P -> player.pickItemUp(currentPos, context)
                 KeyCode.KEY_I -> player.inspectInventory(currentPos, context)
+                KeyCode.KEY_H -> showHelp(context.screen)
                 else -> {
                     logger.debug("UI Event ($uiEvent) does not have a corresponding command, it is ignored.")
                 }
@@ -45,6 +48,10 @@ object InputReceiver : BaseBehavior<GameContext>() {
         executeCommand(InspectInventory(context, this, position))
     }
 
+    private fun showHelp(screen: Screen) {
+        screen.openModal(HelpDialog(screen))
+    }
+
     private fun GameEntity<Player>.pickItemUp(position: Position3D, context: GameContext) {
         executeCommand(PickItemUp(context, this, position))
     }

src/main/kotlin/org/hexworks/cavesofzircon/systems/InventoryInspector.kt

@@ -16,6 +16,7 @@ import org.hexworks.cavesofzircon.commands.InspectInventory
 import org.hexworks.cavesofzircon.extensions.GameCommand
 import org.hexworks.cavesofzircon.extensions.GameItem
 import org.hexworks.cavesofzircon.extensions.whenTypeIs
+import org.hexworks.cavesofzircon.view.dialog.ExamineDialog
 import org.hexworks.cavesofzircon.view.fragment.InventoryFragment
 import org.hexworks.cavesofzircon.world.GameContext
 import org.hexworks.cobalt.datatypes.Maybe
@@ -30,7 +31,7 @@ import org.hexworks.zircon.internal.component.modal.EmptyModalResult
 
 object InventoryInspector : BaseFacet<GameContext>() {
 
-    val DIALOG_SIZE = Sizes.create(33, 14)
+    val DIALOG_SIZE = Sizes.create(40, 14)
 
     override fun executeCommand(command: GameCommand<out EntityType>) = command
             .responseWhenCommandIs(InspectInventory::class) { (context, itemHolder, position) ->
@@ -43,6 +44,9 @@ object InventoryInspector : BaseFacet<GameContext>() {
                         onDrop = { item ->
                             itemHolder.executeCommand(DropItem(context, itemHolder, item, position))
                         },
+                        onExamine = { item ->
+                            screen.openModal(ExamineDialog(screen, item))
+                        },
                         onEat = { item ->
                             itemHolder.whenTypeIs<EnergyUser> { eater ->
                                 item.whenTypeIs<Food> { food ->

src/main/kotlin/org/hexworks/cavesofzircon/view/dialog/ExamineDialog.kt

@@ -0,0 +1,33 @@
+package org.hexworks.cavesofzircon.view.dialog
+
+import org.hexworks.cavesofzircon.attributes.types.iconTile
+import org.hexworks.cavesofzircon.extensions.GameItem
+import org.hexworks.zircon.api.Components
+import org.hexworks.zircon.api.GraphicalTilesetResources
+import org.hexworks.zircon.api.graphics.BoxType
+import org.hexworks.zircon.api.screen.Screen
+
+class ExamineDialog(screen: Screen, item: GameItem) : Dialog(screen) {
+
+    override val container = Components.panel()
+            .withTitle("Examining ${item.name}")
+            .withSize(25, 15)
+            .withBoxType(BoxType.TOP_BOTTOM_DOUBLE)
+            .wrapWithBox()
+            .build().apply {
+                addComponent(Components.textBox()
+                        .withContentWidth(23)
+                        .addHeader("Name", withNewLine = false)
+                        .addInlineComponent(Components.icon()
+                                .withIcon(item.iconTile)
+                                .withTileset(GraphicalTilesetResources.nethack16x16())
+                                .build())
+                        .addInlineComponent(Components.label()
+                                .withText(" ${item.name}")
+                                .build())
+                        .commitInlineElements()
+                        .addNewLine()
+                        .addHeader("Description", withNewLine = false)
+                        .addParagraph(item.description, withNewLine = false))
+            }
+}

src/main/kotlin/org/hexworks/cavesofzircon/view/dialog/HelpDialog.kt

@@ -0,0 +1,48 @@
+package org.hexworks.cavesofzircon.view.dialog
+
+import org.hexworks.zircon.api.Components
+import org.hexworks.zircon.api.graphics.BoxType
+import org.hexworks.zircon.api.screen.Screen
+
+class HelpDialog(screen: Screen) : Dialog(screen) {
+
+    override val container = Components.panel()
+            .withTitle("Help")
+            .withSize(44, 27)
+            .withBoxType(BoxType.TOP_BOTTOM_DOUBLE)
+            .wrapWithBox()
+            .build().apply {
+                addComponent(Components.textBox()
+                        .withContentWidth(42)
+                        .addNewLine()
+                        .addHeader("Caves of Zircon")
+                        .addParagraph("""
+                            Descend to the Caves Of Zircon and collect as many Zircons as you can.
+                             Find the exit (+) to win the game. Use what you find to avoid dying.""".trimIndent())
+                        .addNewLine())
+
+                addComponent(Components.textBox()
+                        .withContentWidth(27)
+                        .withPosition(0, 8)
+                        .addHeader("Movement:")
+                        .addListItem("wasd: Movement")
+                        .addListItem("r: Move up")
+                        .addListItem("f: Move down"))
+
+                addComponent(Components.textBox()
+                        .withContentWidth(40)
+                        .withPosition(0, 16)
+                        .addHeader("Navigation:")
+                        .addListItem("[Tab]: Focus next")
+                        .addListItem("[Shift] + [Tab]: Focus previous")
+                        .addListItem("[Space]: Activate focused item"))
+
+                addComponent(Components.textBox()
+                        .withContentWidth(21)
+                        .withPosition(28, 8)
+                        .addHeader("Actions:")
+                        .addListItem("(i)nventory")
+                        .addListItem("(p)ick up")
+                        .addListItem("(h)elp"))
+            }
+}

src/main/kotlin/org/hexworks/cavesofzircon/view/fragment/InventoryFragment.kt

@@ -16,7 +16,8 @@ class InventoryFragment(inventory: Inventory,
                         width: Int,
                         private val onDrop: (GameItem) -> Unit,
                         private val onEat: (GameItem) -> Unit,
-                        private val onEquip: (GameItem) -> Maybe<GameItem>) : Fragment {
+                        private val onEquip: (GameItem) -> Maybe<GameItem>,
+                        private val onExamine: (GameItem) -> Unit) : Fragment {
 
     override val root = Components.vbox()
             .withSize(width, inventory.size + 1)
@@ -42,6 +43,10 @@ class InventoryFragment(inventory: Inventory,
                 onDrop(item)
                 Processed
             }
+            examineButton.onComponentEvent(ACTIVATED) {
+                onExamine(item)
+                Processed
+            }
             eatButton.onComponentEvent(ACTIVATED) {
                 list.removeComponent(this.root)
                 onEat(item)

src/main/kotlin/org/hexworks/cavesofzircon/view/fragment/InventoryRowFragment.kt

@@ -25,6 +25,11 @@ class InventoryRowFragment(width: Int, item: GameItem) : Fragment {
             .withText("Equip")
             .build()
 
+    val examineButton = Components.button()
+            .wrapSides(false)
+            .withText("Examine")
+            .build()
+
     override val root = Components.hbox()
             .withSpacing(1)
             .withSize(width, 1)
@@ -35,6 +40,7 @@ class InventoryRowFragment(width: Int, item: GameItem) : Fragment {
                         .withSize(InventoryFragment.NAME_COLUMN_WIDTH, 1)
                         .withText(item.name))
                 addComponent(dropButton)
+                addComponent(examineButton)
                 item.whenTypeIs<Food> {
                     addComponent(eatButton)
                 }