fixes and documentation

Author: GammaGames

source/scenes/Play.lua

@@ -11,38 +11,30 @@ local playerSlot
 local ground = gfx.image.new("/assets/images/ground")
 local tree = gfx.image.new("/assets/images/tree")
 local grass = gfx.image.new("/assets/images/grass")
+local collected = 0
 
+-- Input is mostly handled by the player
 Play.inputHandler = {
-	leftButtonDown = function()
-		player:setState("left")
-    end,
-	leftButtonUp = function()
-		player:setState("idle")
-	end,
-	rightButtonDown = function()
-		player:setState("right")
-    end,
-	rightButtonUp = function()
-		player:setState("idle")
-    end,
+	BButtonHeld = function()
+		Noble.GameData.set("items", items, playerSlot)  -- Save the player's collected items
+		Noble.transition(Title)
+	end
 }
 
--- This runs when your scene's object is created, which is the
--- first thing that happens when transitioning away from another scene.
 function Play:init()
     Play.super.init(self)
 
+	collected = 0
 	playerSlot = tonumber(Noble.Settings.get("playerSlot"))
 	items = Noble.GameData.get("items", playerSlot)
 	player = Player(100, 96, playerSlot)
     self.menu:addMenuItem("menu", function() Noble.transition(Title) end)
 end
 
--- When transitioning from another scene, this runs as soon as this
--- scene needs to be visible (this moment depends on which transition type is used).
 function Play:enter()
     Play.super.enter(self)
 
+	-- Using regular sprites because of convenience
 	local tree_sprite = gfx.sprite.new(tree)
 	tree_sprite:setCenter(0.5, 1)  -- This sets the anchor to the bottom center
 	tree_sprite:moveTo(144, 104)
@@ -65,69 +57,59 @@ function Play:enter()
 	ground_sprite:setCenter(0.5, 0)  -- This sets the anchor to the top center
 	ground_sprite:moveTo(100, 104)
 	self:addSprite(ground_sprite)
+
 	self:addSprite(player)
-	player:setState("idle")
-	playdate.display.setScale(2)
+	player.active = true  -- Setting active sets the state, so we don't set it until the scene enters
+	playdate.display.setScale(2)  -- Set the screen scale so the 16x16 pixels are bigger
+end
+
+-- Helper function to collect items, used for adding and removing callbacks to Signal
+local function collectItem(_, _, value)
+	collected += 1
+	local key = tostring(value)  -- Convert to string so the items work like a dictionary and not an array
+	if items[key] == nil then
+		items[key] = 0
+	end
+	items[key] += 1
 end
 
 -- This runs once a transition from another scene is complete.
 function Play:start()
     Play.super.start(self)
 
 	Noble.showFPS = true
-	Signal:add("collected", self, function(_, _, value)
-		local key = tostring(value)
-		if items[key] == nil then
-			items[key] = 0
-		end
-		items[key] += 1
-	end)
-	itemTimer = Timer.new(1000, function()
+	Signal:add("collected", self, collectItem)  -- Add our callback when an item is collected
+	itemTimer = Timer.new(1000, function()  -- Once a second, spawn an item at a random position
 		Item(math.random(10, 190), -10)
     end)
 	itemTimer.repeats = true
 end
 
--- This runs once per frame.
--- function Play:update()
--- 	Play.super.update(self)
--- 	-- Your code here
--- end
-
--- function Play:drawBackground()
--- 	Play.super.drawBackground(self)
---     -- Your code here
--- 	tree:draw(24, 80)
--- 	tree:draw(146, 74)
--- 	grass:draw(56, 89, gfx.kImageFlippedX)
--- 	grass:draw(156, 89)
---  ground:draw(4, 104)
--- end
-
 -- This runs as as soon as a transition to another scene begins.
 function Play:exit()
     Play.super.exit(self)
 
 	Noble.showFPS = false
 	itemTimer:remove()
-	Signal:remove("collected")
-	Noble.GameData.set("items", items, playerSlot)
+	Signal:remove("collected", collectItem)
+	Noble.GameData.set("items", items, playerSlot)  -- Save the player's collected items
 end
 
 -- This runs once a transition to another scene completes.
 function Play:finish()
 	Play.super.finish(self)
-	-- Your code here
-	playdate.display.setScale(1)
+	playdate.display.setScale(1)  -- Reset the scale when exiting
 end
 
--- TODO Show number of items collected
+-- This is called before the system pauses the game
 function Play:pause()
     Play.super.pause(self)
-    -- Your code here
-end
 
-function Play:resume()
-	Play.super.resume(self)
-	-- Your code here
+	-- Draw the number of collected items to the menu image
+    local _img = gfx.image.new(400, 240, gfx.kColorWhite)
+    gfx.pushContext(_img)
+		gfx.drawTextAligned("*Collected*", 100, 110, kTextAlignment.center)
+		gfx.drawTextAligned(collected, 100, 130, kTextAlignment.center)
+    gfx.popContext()
+    pd.setMenuImage(_img)
 end

source/scenes/Stats.lua

@@ -6,23 +6,36 @@ class("Stats").extends(BaseScene)
 
 local items
 local grid
-
+local modal
 local locked_image = gfx.image.new("/assets/images/locked")
 local heart_image = gfx.image.new("/assets/images/heart")
 local icons_it = gfx.imagetable.new("/assets/images/kenney-icons")
 local columns, rows = icons_it:getSize()
-local modal, modal_animator
+local modal_animator = gfx.animator.new(
+    500,
+    Geometry.lineSegment.new(
+        200, 275,
+        200, 120
+    ),
+    Ease.outBack
+)
 local keyTimer
 Stats.inputHandler = {
+	BButtonHeld = function()
+		Noble.transition(Title)
+	end,
     upButtonDown = function()
+        -- If there's already a timer, ignore
         if keyTimer ~= nil then
             return
         end
+        -- Add repeat timers so users can hold the direction
 		local function timerCallback()
             grid:selectPreviousRow(true)
 		end
 		keyTimer = playdate.timer.keyRepeatTimer(timerCallback)
     end,
+    -- Remove the listener on button up
     upButtonUp = function()
         if keyTimer == nil then
             return
@@ -80,31 +93,27 @@ Stats.inputHandler = {
     end,
     AButtonDown = function()
         local _, row, column = grid:getSelection()
-        local index = math.floor(columns * (row - 1) + column)
-        if index == 1 then
+        local index = math.floor(columns * (row - 1) + column)  -- Convert row/column to index
+        if index == 1 then  -- Index 1 is blank, use a placeholder
             modal = notify("*HELLO :)\nThanks for checking out the example project!*", function()
                 Noble.currentScene():removeSprite(modal)
                 modal = nil
             end)
         else
+            -- If the item is locked, skip
             if items[tostring(index)] == nil then
                 return
             end
+            -- Else show the status
             local count = items[tostring(index)]
             modal = notify("*#"..index.."*: Collected "..count.." time"..(count > 1 and "s" or ""), function()
                 Noble.currentScene():removeSprite(modal)
                 modal = nil
             end)
         end
-        modal_animator = gfx.animator.new(
-            500,
-            Geometry.lineSegment.new(
-                200, 275,
-                200, 120
-            ),
-            Ease.outBack
-        )
-        Noble.currentScene():addSprite(modal)
+        modal:moveTo(200, 275)  -- Move the modal to the bottom of the screen
+        modal_animator:reset()
+        Noble.currentScene():addSprite(modal)  -- Add to the current scene
     end
 }
 
@@ -116,11 +125,12 @@ function Stats:init()
     grid:setNumberOfRows(rows)
     grid:setSelection(1, 1, 1)
     grid.changeRowOnColumnWrap = false
-    function grid:drawCell(_, row, column, selected, x, y, _, _)
+    function grid:drawCell(_, row, column, selected, x, y, _, _)  -- Override the drawCell function
+        -- Get either the locked image or the unlocked tile image
         local index = math.floor(columns * (row - 1) + column)
         local image = items[tostring(index)] == nil and locked_image or icons_it:getImage(index)
 
-        if index == 1 then
+        if index == 1 then  -- Index 1 is blank, use a heart when selected
             if selected then
                 image = heart_image
             else
@@ -129,95 +139,44 @@ function Stats:init()
         end
 
         if selected then
-            image:drawScaled(x, y, 2)
+            image:drawScaled(x, y, 2)  -- Draw the sprite larger if selected
         else
             image:draw(x + 8, y + 8)
         end
     end
     self.menu:addMenuItem("menu", function() Noble.transition(Title) end)
 end
 
+-- This will be drawn behind all sprites (the ui popup is a sprite)
 function Stats:drawBackground()
     grid:drawInRect(0, 0, 400, 240)
 end
 
 function Stats:update()
-    if grid.needsDisplay then
+    if grid.needsDisplay then  -- If the grid changed, redraw background
         gfx.sprite.redrawBackground()
     end
-    if modal ~= nil then
+    if modal ~= nil and not modal_animator:ended() then  -- Animate the modal
         modal:moveTo(modal_animator:currentValue())
     end
 end
 
--- TODO Show number of items collected total %
-
--- function Title:pause()
--- 	Title.super.pause(self)
--- 	-- Your code here
--- end
--- function Title:resume()
--- 	Title.super.resume(self)
--- 	-- Your code here
--- end
-
---
--- -- This runs when your scene's object is created, which is the
--- -- first thing that happens when transitioning away from another scene.
--- function Title:init()
--- 	Title.super.init(self)
-
---     -- gfx.setFontFamily(Noble.Text.FONT_NEWSLEAK_FAMILY)
--- 	Noble.Text.setFont(Noble.Text.FONT_NEWSLEAK)
---     menu = Noble.Menu.new(
---         true,  -- Activate
---         Noble.Text.ALIGN_CENTER,
---         false,  -- No localization
---         nil,  -- Use default color
---         4, 6  -- Adjust padding
---     )
---     menu:addItem("Play", function() Noble.transition(Play, 1, Noble.TransitionType.DIP_WIDGET_SATCHEL) end)
---     menu:addItem("Stats", function() Noble.transition(Stats, 1, Noble.TransitionType.DIP_WIDGET_SATCHEL) end)
--- end
-
--- -- When transitioning from another scene, this runs as soon as this
--- -- scene needs to be visible (this moment depends on which transition type is used).
--- function Title:enter()
---     Title.super.enter(self)
-
--- 	self:addSprite(logo)
--- end
-
--- -- This runs once a transition from another scene is complete.
--- function Title:start()
--- 	Title.super.start(self)
--- 	-- Your code here
--- end
-
--- -- This runs once per frame.
--- function Title:update()
--- 	Title.super.update(self)
--- 	-- Your code here
---     menu:draw(200, 160)
--- end
-
--- -- This runs as as soon as a transition to another scene begins.
--- function Title:exit()
--- 	Title.super.exit(self)
--- 	-- Your code here
--- end
-
--- -- This runs once a transition to another scene completes.
--- function Title:finish()
--- 	Title.super.finish(self)
--- 	-- Your code here
--- end
+function Stats:pause()
+    Play.super.pause(self)
+    local icon_count = (#icons_it - 1)  -- ID 1 is blank
+    local item_count = 0
+    local collected_count = 0
+    for _, count in pairs(items) do
+        item_count += 1
+        collected_count += count
+    end
 
--- function Title:pause()
--- 	Title.super.pause(self)
--- 	-- Your code here
--- end
--- function Title:resume()
--- 	Title.super.resume(self)
--- 	-- Your code here
--- end
+    local _img = gfx.image.new(400, 240, gfx.kColorWhite)
+    gfx.pushContext(_img)
+		gfx.drawTextAligned("*Collected*", 100, 90, kTextAlignment.center)
+		gfx.drawTextAligned(item_count .. "/" .. icon_count, 100, 110, kTextAlignment.center)
+		gfx.drawTextAligned(string.format("%.2f %%", item_count / icon_count * 100), 100, 130, kTextAlignment.center)
+		gfx.drawTextAligned(collected_count .. " Collected total", 100, 150, kTextAlignment.center)
+        gfx.popContext()
+    pd.setMenuImage(_img)
+end