API:Class/StarterGui/GetCore

Note:This feature will only work in a LocalScript (or a ModuleScript running on the client)


GetCore

YieldFunction of StarterGui icon.pngStarterGui
Variant GetCore (
    string parameterName
)
Parameters:
  1. parameterName

Returns: Variant
Description: Returns a variable that has been specified by a Roblox CoreScript.

Notes

  • Since this method invokes a Lua function in a CoreScript which can yield, this is a YieldFunction

Example

The following code would check if PlayerPoints notifications are currently enabled:

if game:GetService("StarterGui"):GetCore("PointsNotificationsActive") then
	print("PlayerPoints notifications are enabled")
else
	print("PlayerPoints notifications are disabled")
end





Available GetCore options

Notifications

PointsNotificationsActive

bool StarterGui:GetCore("PointsNotificationsActive")

Description:
Returns true if point notifications are enabled.

BadgesNotificationsActive

bool StarterGui:GetCore("BadgesNotificationsActive")

Description:
Returns true if badge notifications are enabled.

Chat

ChatActive

bool StarterGui:GetCore("ChatActive")

Description:
Returns whether the chat is active or not. This is indicated by the selection state of the top bar's chat icon.

ChatWindowSize

UDim2 StarterGui:GetCore("ChatWindowSize")

Description:
Returns the size of the chat window as a UDim2.

ChatWindowPosition

UDim2 StarterGui:GetCore("ChatWindowPosition")

Description:
Returns the position of the chat window as a UDim2.

ChatBarDisabled

bool StarterGui:GetCore("ChatBarDisabled")

Description:
Returns true if the chat bar is disabled.

Players

GetBlockedUserIds

array<int> StarterGui:GetCore("GetBlockedUserIds")

Description:
Returns a list of UserIds associated with users that have been blocked by the local player.

PlayerBlockedEvent

BindableEvent StarterGui:GetCore("PlayerBlockedEvent")

Description:
Returns a BindableEvent that is fired whenever a player is blocked by the local player.

PlayerUnblockedEvent

BindableEvent StarterGui:GetCore("PlayerUnblockedEvent")

Description:
Returns a BindableEvent that is fired whenever a player is unblocked by the local player.

PlayerMutedEvent

BindableEvent StarterGui:GetCore("PlayerMutedEvent")

Description:
Returns a BindableEvent that is fired whenever a player is muted by the local player.

PlayerUnmutedEvent

BindableEvent StarterGui:GetCore("PlayerUnmutedEvent")

Description:
Returns a BindableEvent that is fired whenever a player is unmuted by the local player.

PlayerFriendedEvent

BindableEvent StarterGui:GetCore("PlayerFriendedEvent")

Description:
Returns a BindableEvent that is fired whenever a player is friended by the local player.

PlayerUnfriendedEvent

BindableEvent StarterGui:GetCore("PlayerUnfriendedEvent")

Description:
Returns a BindableEvent that is fired whenever a player is unfriended by the local player.

Other

DeveloperConsoleVisible

bool StarterGui:GetCore("DeveloperConsoleVisible")

Description:
Returns true if the developer console is visible.

VRRotationIntensity

Warning:This GetCore method only exists if VREnabled is true.

string StarterGui:GetCore("VRRotationIntensity")

Description:
Returns a string describing the camera rotation sensitivity in VR. This returns either "Low", "High", or "Smooth"