Instances

gethui

Returns game:CoreGui lookup.RobloxGui.

Syntax

gethui(): Instance | nil
Aliases gethiddenuigethiddenguiget_hidden_uiget_hidden_gui

Returns

NameTypeDescription
robloxGuiInstance | nilThe RobloxGui value read from CoreGui, or nil when CoreGui or RobloxGui is unavailable.

Description

Returns game:CoreGui lookup.RobloxGui. The function takes no arguments. If CoreGui lookup returns nil, or if RobloxGui on that value is nil, the function returns nil. The function does not create a container and does not use the cached CoreGui value.

Call it without parameters. The function reads the needed context from the current runtime state.

It returns robloxGui (Instance | nil). Use the returns table to separate successful values from nil results and recoverable errors.

Example

Example call with placeholder values.

local result = gethui()
print(result)