chest.lua

--[[ This script handles the treasure chests. Each of the 5 main rooms will have a chest with a different treasure on it. The player will need to find the game’s 5 treasures to beat the game. ]]
-- This creates the class for the chest
Chest = Class{}

-- This stores the opened and closed chest sprites
local CLOSED_CHEST_IMAGE = love.graphics.newImage('graphics/chest-closed.png')
local OPENED_CHEST_IMAGE = love.graphics.newImage('graphics/chest-opened.png')

--[[ I could show a victory message after opening all 5 chests by 
using a counter that keeps track of the number of chests opened, 
and using a boolean variable that turns to “true” once the counter 
reaches 5.

I could go go to the part where the script 
checks if the player can open the chest. If they open the chest, 
I will add one to the treasure counter. Since I need to constantly 
check if I need to update the counter, this counter should go in 
the update() function of Chest.lua. This counter should start at 
0. I will declare it in the init() function of Chest.lua. 
It may be best if I made this counter a global variable if I’m 
going to call it in main.lua to change the boolean victory 
variable into “true”.
]]
treasureCounter = 0

--[[ DEBUGGING CODE: This will contain the sprites for the 5 treasures and of the treasure bubble to compare their 
sizes to the chest sprites.

DELETE LATER. ]]
local TREASURE_1_IMAGE = love.graphics.newImage('graphics/treasures/bronze-ring.png')
local TREASURE_2_IMAGE = love.graphics.newImage('graphics/treasures/bronze-armor.png')
local TREASURE_3_IMAGE = love.graphics.newImage('graphics/treasures/ruby.png')
local TREASURE_4_IMAGE = love.graphics.newImage('graphics/treasures/gold-ingot.png')
local TREASURE_5_IMAGE = love.graphics.newImage('graphics/treasures/diamond.png')
local BUBBLE_IMAGE = love.graphics.newImage('graphics/treasure-bubble-empty.png')
local DEACTIVATED_LEVER_IMAGE = love.graphics.newImage('graphics/deactivated-lever.png')
local ACTIVATED_LEVER_IMAGE = love.graphics.newImage('graphics/activated-lever.png')

local CAGE_IMAGE = love.graphics.newImage('graphics/cage.png')





--[[ This will have the initial properties of the chest.

Since most of the chests will have different positions, I need to specify the x and y coordinates of each chest from main.lua 
for each time that I instantiate a chest. 

The height and width of all chests will be the same, so there’s no point in obtaining the width and height of each chest 
inside of an “if” statement.

I can use the width and the height of either the closed or the opened chest sprite, since both of them have the same 
width and height anyways.]]
function Chest:init(chest_x, chest_y)
	self.width = CLOSED_CHEST_IMAGE:getWidth()
	self.height = CLOSED_CHEST_IMAGE:getHeight()

	--[[ The position of each chest will be rendered depending on the room where the player is currently located.
	
	However, that will be specified on the render() function, not here. ]]
	self.y = chest_y 
	self.x = chest_x

	--[[ This is a variable that will tell the game whether to render the closed chest sprite or the opened one for 
	the current instance of the chest. 
	
	I'm using "self." so that only the current instance of the chest will be closed. That is, if I open a chest, the 
	rest of the chests will remain closed, and if a chest is opened, it will remain opened once the player returns
	to the room. Or in other words, if I had 2 chests in the same room, this will prevent the 2 chests from opening 
	at the same time if I open 1 chest. ]]
	self.closedChest = true
end

--[[ The update() function makes the chest change from being closed to being opened.

It will accept a parameter from main.lua that should have the value "true". If this function receives that value, 
it means that the player is touching a chest, and that, if they press the "E" key, the chest should open.

I will modify the "self.closedChest" to "true" so that only the current instance of the chest will be opened 
in the Chest:render() function (that is, so that the rest of the chest remain closed if I only open 1 chest.)
	
I may remove the "timerOn" variable from here since, right now, it's a global variable, and it's affecting ALL instances
of the chest{} class (that is, the timer is affecting ALL the chests at the same time).

I had an error that I had to fix. The parameter inside of chest:update() doesn’t tell me if the chest is open. 
It tells me if the player is touching the chest. So, I will rename the parameter “isTouchingChest”.

This will make the user open a chest by pressing the “E” key.
	
I will add an extra variable to check whether the player is colliding with the chest. This way, I’ll only be 
able to open the chest if I’m touching it.
	
From here, I will also call the treasure.lua script via the treasure:render() function, and I will pass “false” 
as a parameter to indicate that the chest has been opened, so it’s ok to render the treasure. BUT it may give me an error, 
since I think I need to specify if it’s treasure1.
	
I need to activate the timer ONLY ONCE. The timer should only activate the 1st time that I open the current chest. 

To do that, I may put another “if” statement inside of “isTouchingChest” to say that, if the chest is closed, to 
activate the timer. It SHOULDN’T activate the timer if the chest is already open. 

I will at 1st check if I’m in a room with a locked chest (like room 2). If I do, I will specify that, to open that chest, 
its corresponding global variable (like unlockChest_2) should be “true”. If that room doesn’t have any levers nor locked 
chests, I will just let the user open the chest without requiring the “unlockChest_NUMBER” variable.

To avoid any possible bugs, I will specify that I want to keep a chest locked (like the one in room 2) if its 
corresponding “unlockChest_NUMBER” variable is not yet set to “true”.
--]]
function Chest:update(isTouchingChest)
	if currentRoom == 2 then
		unlockChest_3 = false
		unlockChest_5 = false
	end

	if love.keyboard.wasPressed('e') then
		if isTouchingChest == true then
			if self.closedChest == true then
				if currentRoom == 2 then
					if unlockChest_2 == true then	-- Room 2's treasure
						self.closedChest = false
						timerOn = true

						--[[ This will update the treasure counter to indicathe that I have grabbed the 1st treasure.
						Once I pick up all 5 of them, this counter will reach 5, and the victory state will change
						to "true". This will add Room 2's treasure to the counter. ]]
						treasureCounter = treasureCounter + 1	

						-- DEBUGGING message that prints the treasure counter
						print(treasureCounter)	

					-- I may not need this
					--[[else
						self.closedChest = true
						timerOn = false]]
					end
				elseif currentRoom == 3 then	-- Room 3's treasure
					if unlockChest_3 == true then
						self.closedChest = false
						timerOn = true
						treasureCounter = treasureCounter + 1

						print(treasureCounter)
					end
				elseif currentRoom == 5 then	-- Room 5's treasure
					if unlockChest_5 == true then
						self.closedChest = false
						timerOn = true
						treasureCounter = treasureCounter + 1

						print(treasureCounter)
					end
				else	-- Rooms 1 and 4's treasure
					self.closedChest = false
					timerOn = true
					treasureCounter = treasureCounter + 1

					print(treasureCounter)
				end
			end
		end
	end
end

--[[ This will render the chest sprite.

To be able to change the chest from closed to open, I will render the closed chest on a layer on top of the opened 
chest sprite. Then, I will create a variable that will store whether the chest should be opened or closed, and use an 
“if” statement to tell the game whether to show or remove the closed chest sprite (source: 
https://youtu.be/F86edI_EF3s).

If that variable says that the chest should be closed (by default), the chest will remain closed. Otherwise, the closed 
chest sprite will disappear, and will reveal the opened chest sprite underneath it.

I will render the closed chest on top of the opened chest sprite.

In the end, I decided just to use an "else" statement to render the opened chest if the closedChest variable is equal
to "false".

I decided to subtract 23 px to the height of the opened chest so that it doesn't clip through the floor (23 px is the 
height difference between the closed and opened chest sprites).

To fix the bug where all of the chest were being opened if I opened only 1 chest, I had to change "closedChest" to 
"self.closedChest" so that only the current instance of the chest changes from closed to opened. ]]
function Chest:render()
	if self.closedChest == true then
		love.graphics.draw(CLOSED_CHEST_IMAGE, self.x, self.y)
	else
		love.graphics.draw(OPENED_CHEST_IMAGE, self.x, self.y - 23)
	end

	--[[ DEBUGGING CODE. I will render the treasures to see their sizes compared to the size of the chest sprites.

	Also, I will render the treasure UI bubble to see if I need to modify the size of the sprite.
	
	DELETE LATER.
	]]
	-- love.graphics.draw(CAGE_IMAGE, VIRTUAL_WIDTH - (141 * 3) - 55, -80 + VIRTUAL_HEIGHT - 100)

	-- love.graphics.draw(ACTIVATED_LEVER_IMAGE, 200, -160 + VIRTUAL_HEIGHT)
	-- love.graphics.draw(DEACTIVATED_LEVER_IMAGE, 100, -170 + VIRTUAL_HEIGHT)

	-- love.graphics.draw(BUBBLE_IMAGE, self.x + 5, self.y - 90)

	-- love.graphics.draw(TREASURE_5_IMAGE, self.x + 20, self.y - 50)
end