The Best Room

Lesson 20 of 20 in Coddy's Roblox Game: Escape the Dark course.

The last feature: the deepest room a player ever reached, Best on the leaderboard, kept between visits in a DataStore. Read it when they join, raise it when they walk into a deeper room, and save it when they leave and when the server closes.

GetAsync waits for the store. A function that waits inside PlayerAdded gives the player's first character time to spawn before anything below it runs, so the CharacterAdded connection goes first and the read last:

local ok, saved = pcall(function()
	return bestStore:GetAsync(tostring(player.UserId))
end)

Data stores can fail, so every call is wrapped in pcall. In Roblox Studio, DataStores work once the place is published and Enable Studio Access to API Services is on.

That is the whole game: dark rooms, a monster, and a way out.

Challenge

Hard

Get DataStoreService and local bestStore = DataStoreService:GetDataStore("BestRoom").
In PlayerAdded, after the CharacterAdded connection: a Best IntValue in leaderstats, then the saved value (by tostring(player.UserId), in a pcall).
In setupEntry, raise Best when the room is deeper.
Save Best on PlayerRemoving and in game:BindToClose, with SetAsync in a pcall.

Press Play, then Check: the check leaves and comes back.

Try it yourself

local Players = game:GetService("Players")
local ServerStorage = game:GetService("ServerStorage")
local Lighting = game:GetService("Lighting")
local TweenService = game:GetService("TweenService")
local PathfindingService = game:GetService("PathfindingService")
local Settings = require(game.ReplicatedStorage.Settings)

local remotes = game.ReplicatedStorage.Remotes
local rooms = workspace.Rooms
local lastRoom = rooms.Lobby -- the newest room
local count = 0 -- rooms made so far
local monster = nil
local codes = {} -- vault door -> its code
local lastTry = {} -- player -> when they last tried a code

-- Night falls: no sun, a little light everywhere, and fog
Lighting.ClockTime = Settings.ClockTime
Lighting.Ambient = Settings.Ambient
Lighting.OutdoorAmbient = Settings.Ambient
Lighting.FogColor = Color3.new(0, 0, 0)
Lighting.FogEnd = Settings.FogEnd
print("Lights out")

-- A tool a player carries: in their hand, or in their Backpack
local function findTool(player, name)
	return (player.Character and player.Character:FindFirstChild(name)) or player.Backpack:FindFirstChild(name)
end

-- Flashlights drain while they shine, and go dark when empty
task.spawn(function()
	while true do
		task.wait(0.25)
		for _, player in Players:GetPlayers() do
			local flashlight = player.Character and player.Character:FindFirstChild("Flashlight")
			if flashlight and flashlight.Handle.Beam.Enabled then
				local battery = math.max(0, flashlight:GetAttribute("Battery") - Settings.BatteryDrain * 0.25)
				flashlight:SetAttribute("Battery", battery)
				if battery == 0 then
					flashlight.Handle.Beam.Enabled = false
				end
			end
		end
	end
end)

-- Swing a door open on its hinge
local function openDoor(door)
	door:SetAttribute("Open", true)
	door.Panel.Prompt.Enabled = false
	local hinge, panel = door.Hinge, door.Panel
	local goal = hinge.CFrame * CFrame.Angles(0, math.rad(90), 0) * hinge.CFrame:ToObjectSpace(panel.CFrame)
	TweenService:Create(panel, TweenInfo.new(0.6), { CFrame = goal }):Play()
end

-- Out: the run is over (and how long it took)
local function escape(player)
	if player:GetAttribute("Escaped") then
		return
	end
	player:SetAttribute("EscapeTime", workspace:GetServerTimeNow() - player:GetAttribute("StartedAt"))
	player:SetAttribute("Escaped", true)
	if monster then
		monster:Destroy()
		monster = nil
	end
end

-- The nearest living player it could catch (not hidden), within MonsterSight, and how far
local function nearestCharacter(position)
	local best, bestDistance = nil, Settings.MonsterSight
	for _, player in Players:GetPlayers() do
		local character = player.Character
		local root = character and character:FindFirstChild("HumanoidRootPart")
		if root and character.Humanoid.Health > 0 and not character:GetAttribute("Hidden") then
			local distance = (root.Position - position).Magnitude
			if distance < bestDistance then
				best, bestDistance = character, distance
			end
		end
	end
	return best, bestDistance
end

-- Can the monster see this character? A ray from its head that hits them
local function canSee(shadow, character)
	local from = shadow.Head.Position
	local params = RaycastParams.new()
	params.FilterDescendantsInstances = { shadow }
	local hit = workspace:Raycast(from, character.HumanoidRootPart.Position - from, params)
	return hit ~= nil and hit.Instance:IsDescendantOf(character)
end

-- Walk toward a point: straight when the way is clear, else along a path
local function walkToward(shadow, goal, path)
	local root = shadow.HumanoidRootPart
	local params = RaycastParams.new()
	params.FilterDescendantsInstances = { shadow }
	local hit = workspace:Raycast(root.Position, goal - root.Position, params)
	if not hit or hit.Instance.Parent:FindFirstChildOfClass("Humanoid") then
		shadow.Humanoid:MoveTo(goal)
		return
	end
	path:ComputeAsync(root.Position, goal)
	local points = path:GetWaypoints()
	if path.Status == Enum.PathStatus.Success and points[2] then
		shadow.Humanoid:MoveTo(points[2].Position)
	end
end

-- The middle of a room `back` rooms before the one players are in (the one
-- before the newest), for the monster's patrol
local function patrolPoint(back)
	for _, room in rooms:GetChildren() do
		if room:GetAttribute("Number") == count - 1 - back then
			return (room.Entrance.CFrame * CFrame.new(0, 3.1, -12)).Position
		end
	end
	return nil
end

-- The monster's mind: every quarter second, after someone
local function runMonster(shadow)
	local humanoid = shadow.Humanoid
	local root = shadow.HumanoidRootPart
	local path = PathfindingService:CreatePath()
	local lastSeen = nil -- where it last saw someone
	local back = 0 -- its patrol: 0 is the players' room, 2 two rooms behind
	while shadow.Parent do
		local character = nearestCharacter(root.Position)
		if character and canSee(shadow, character) then
			lastSeen = character.HumanoidRootPart.Position
		else
			character = nil
		end
		if character and (character.HumanoidRootPart.Position - root.Position).Magnitude <= Settings.CatchDistance then
			-- caught: the player is beaten, and the monster goes until the next door
			character.Humanoid.Health = 0
			shadow:Destroy()
			monster = nil
			return
		end
		local goal = character and character.HumanoidRootPart.Position or lastSeen
		if goal then
			walkToward(shadow, goal, path)
			-- at the place it last saw you, and you are not there: it gives up
			if not character and ((goal - root.Position) * Vector3.new(1, 0, 1)).Magnitude < 1.5 then
				lastSeen = nil
			end
		else
			-- nobody in sight: patrol, back and forth
			local point = patrolPoint(back) or patrolPoint(0)
			if point then
				walkToward(shadow, point, path)
				if ((point - root.Position) * Vector3.new(1, 0, 1)).Magnitude < 2 then
					back = back == 0 and 2 or 0
				end
			end
		end
		task.wait(0.25)
	end
end

-- The monster comes in behind you: at the entrance of the room two before the newest
local function spawnMonster()
	local behind = nil
	for _, room in rooms:GetChildren() do
		if room:GetAttribute("Number") == count - 2 then
			behind = room
		end
	end
	if not behind then
		return
	end
	monster = ServerStorage.Shadow:Clone()
	monster:PivotTo(behind.Entrance.CFrame + Vector3.new(0, 3.1, 0))
	monster.Humanoid.WalkSpeed = Settings.MonsterSpeed
	monster.Parent = workspace
	task.spawn(runMonster, monster)
end

local addRoom -- written below: a door adds a room, and a room has a door

-- What a door does when a player opens it
local function setupDoor(door)
	door.Panel.Prompt.Triggered:Connect(function(player)
		if door:GetAttribute("Open") then
			return
		end
		if door:GetAttribute("Vault") and door:GetAttribute("Locked") then
			return -- a vault opens with its code, on the keypad
		end
		if door:GetAttribute("Locked") then
			local key = findTool(player, "Key")
			if not key then
				return
			end
			key:Destroy()
			door:SetAttribute("Locked", nil)
		end
		if door:GetAttribute("Exit") then
			escape(player)
			openDoor(door)
			return
		end
		if door.Parent == lastRoom then
			addRoom()
		end
		openDoor(door)
	end)
end
setupDoor(workspace.Rooms.Lobby.Door)

-- Walking into a room: it becomes the player's Room, and their checkpoint
local function setupEntry(room)
	room.Entry.Touched:Connect(function(hit)
		local player = Players:GetPlayerFromCharacter(hit.Parent)
		if player then
			local number = room:GetAttribute("Number")
			player.leaderstats.Room.Value = number
			player.RespawnLocation = room.Checkpoint
		end
	end)
end
setupEntry(workspace.Rooms.Lobby)

-- A closet: E to hide inside, E again to come out
local function setupCloset(closet)
	closet.Front.Prompt.Triggered:Connect(function(player)
		local character = player.Character
		if character:GetAttribute("Hidden") then
			character:PivotTo(closet.Front.CFrame * CFrame.new(-3, -1, 0) * CFrame.Angles(0, math.rad(90), 0))
			character:SetAttribute("Hidden", nil)
		else
			character:PivotTo(closet.Inside.CFrame + Vector3.new(0, 2.5, 0))
			character:SetAttribute("Hidden", true)
		end
	end)
end

-- A new room at the exit of the newest one
function addRoom()
	count += 1
	local name = Settings.Order[(count - 1) % #Settings.Order + 1]
	if count >= Settings.RoomsToEscape then
		name = "Exit"
	end
	local room = ServerStorage.Rooms[name]:Clone()
	room:PivotTo(lastRoom.Exit.CFrame)
	room:SetAttribute("Number", count)
	room.Sign.SurfaceGui.Number.Text = "Room " .. count
	room.Parent = rooms
	lastRoom = room
	setupDoor(room.Door)
	setupEntry(room)
	-- a locked room keeps its key inside
	local keySpot = room:FindFirstChild("KeySpot")
	if keySpot then
		local key = ServerStorage.Key:Clone()
		key.Handle.CFrame = keySpot.CFrame
		key.Parent = room
		key.Handle.Prompt.Triggered:Connect(function(player)
			key.Handle.Prompt.Enabled = false
			key.Parent = player.Backpack
		end)
	end
	local closet = room:FindFirstChild("Closet")
	if closet then
		setupCloset(closet)
	end
	-- some rooms have a battery
	local batterySpot = room:FindFirstChild("BatterySpot")
	if batterySpot then
		local battery = ServerStorage.Battery:Clone()
		battery.CFrame = batterySpot.CFrame
		battery.Parent = room
		battery.Prompt.Triggered:Connect(function(player)
			local flashlight = findTool(player, "Flashlight")
			if flashlight and battery.Parent then
				flashlight:SetAttribute("Battery", math.min(Settings.BatteryMax, flashlight:GetAttribute("Battery") + Settings.BatteryRefill))
				battery:Destroy()
			end
		end)
	end
	-- a vault's code is on the note inside it
	if room.Door:GetAttribute("Vault") then
		local code = tostring(math.random(1000, 9999))
		codes[room.Door] = code
		room.Note.SurfaceGui.Code.Text = "Code " .. code
	end
	-- keep the newest room and KeepRooms behind it
	for _, old in rooms:GetChildren() do
		if old:GetAttribute("Number") < count - Settings.KeepRooms then
			old:Destroy()
		end
	end
	if count >= Settings.MonsterFrom and not monster then
		spawnMonster()
	end
	return room
end

-- Out of the closet, you are not hidden any more
task.spawn(function()
	while true do
		task.wait(0.25)
		for _, player in Players:GetPlayers() do
			local character = player.Character
			if character and character:GetAttribute("Hidden") then
				local closest = math.huge
				for _, inside in workspace.Rooms:GetDescendants() do
					if inside.Name == "Inside" then
						closest = math.min(closest, (inside.Position - character.HumanoidRootPart.Position).Magnitude)
					end
				end
				if closest > 4 then
					character:SetAttribute("Hidden", nil)
				end
			end
		end
	end
end)

-- A code typed on a vault's keypad. The server checks it: a real vault near
-- the player, one try per CodeWait, and the right code
remotes.TryCode.OnServerInvoke = function(player, door, code)
	if typeof(door) ~= "Instance" or not codes[door] or typeof(code) ~= "string" then
		return false
	end
	local root = player.Character and player.Character:FindFirstChild("HumanoidRootPart")
	if not root or (root.Position - door.Panel.Position).Magnitude > 12 then
		return false
	end
	local now = time()
	if lastTry[player] and now - lastTry[player] < Settings.CodeWait then
		return false
	end
	lastTry[player] = now
	if code ~= codes[door] then
		return false
	end
	codes[door] = nil
	door:SetAttribute("Locked", nil)
	if door.Parent == lastRoom then
		addRoom()
	end
	openDoor(door)
	return true
end

-- Every player: Room on the leaderboard, and a flashlight every life
Players.PlayerAdded:Connect(function(player)
	local leaderstats = Instance.new("Folder")
	leaderstats.Name = "leaderstats"
	leaderstats.Parent = player

	local room = Instance.new("IntValue")
	room.Name = "Room"
	room.Parent = leaderstats

	player.CharacterAdded:Connect(function()
		if not player:GetAttribute("StartedAt") then
			player:SetAttribute("StartedAt", workspace:GetServerTimeNow())
		end
		local flashlight = ServerStorage.Flashlight:Clone()
		flashlight:SetAttribute("Battery", Settings.BatteryMax)
		flashlight.Parent = player.Backpack
		local beam = flashlight.Handle.Beam
		flashlight.Activated:Connect(function()
			if beam.Enabled then
				beam.Enabled = false
			elseif flashlight:GetAttribute("Battery") > 0 then
				beam.Enabled = true
			end
		end)
	end)
end)