Call to disable the TopBar may fail initially

[martimmatias]

Satchel version

1.3.1

Description

The call to StarterGui:GetCore("TopBarEnabled") may fail when the script is required at the start of a LocalScript.
https://github.com/RyanLua/Satchel/blob/6630d4c19b0e1697d1f1de7bed261dcc12fccab7/src/init.luau#L1497

Error: SetCore: TopbarEnabled has not been registered by the CoreScripts

Related DevForum post: https://devforum.roblox.com/t/setcoretobarenabled-throws-an-error-without-a-wait/22347

Expected behavior

No response

Actual behavior

No response

Steps to reproduce

Require the Module at the start of a LocalScript in StarterGui.
Playtest as a server with 1 player, as that seems more likely to cause the CoreGui scripts to not be fully ready yet.

Relevant log output

[ryanlua]

Solved in dc9d1f9

[kdserra]

For me dc9d1f9 only solved the error initially, but when I start a 2 player session it would spam my output with the same error.

To fix it I delayed the heartbeat registration until the dependency TopbarEnabled is found, once found it begins listening to the Heartbeat. After this fix the error no longer appears in my local session and multi-player sessions.

local function WaitForCore(name: string)
	local result: any = nil
	repeat
		local success, value = pcall(function()
			return StarterGui:GetCore(name)
		end)
		if success then
			result = value
		else
			task.wait()
		end
	until result ~= nil
	return result
end

WaitForCore("TopbarEnabled")

-- Update every heartbeat the icon state
RunService.Heartbeat:Connect(function(): ()
	OnIconChanged(BackpackEnabled)
end)