Roblox API Reference

StarterGui On DevHub

Summary

This class is not creatable. An object of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.

Tags: [NotCreatable, Service]

Inherits (2)

Member index (12)

Type Member History
bool ProcessUserInput 338
bool ResetPlayerGuiOnSpawn 123 206 301
ScreenOrientation ScreenOrientation 290
bool ShowDevelopmentGui
VirtualCursorMode VirtualCursorMode 479
Variant GetCore (string parameterName) 210
bool GetCoreGuiEnabled (CoreGuiType coreGuiType) 124
void RegisterGetCore (string parameterName, Function getFunction) 210
void RegisterSetCore (string parameterName, Function setFunction) 210
void SetCore (string parameterName, Variant value) 210
void SetCoreGuiEnabled (CoreGuiType coreGuiType, bool enabled) 124
CoreGuiChangedSignal (CoreGuiType coreGuiType, bool enabled) 124
2 members inherited from BasePlayerGui
51 members inherited from Instance

Removed member index (4)

Type Member History
bool BackpackGuiEnabled 113 124
bool HealthGuiEnabled 113 124
bool PlayerListGuiEnabled 113 124
bool ResetPlayerGuiOnDeath 113 123

History

Members

CoreGuiChangedSignal On DevHub

Name Type Default
coreGuiType CoreGuiType none
enabled bool none

History

GetCore On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
parameterName string none

History

Tags: [Yields]

GetCoreGuiEnabled On DevHub

Name Type Default
coreGuiType CoreGuiType none

History

ProcessUserInput On DevHub

This member is hidden. It is not meant to be used, and may have unresolved issues.
This item is not replicated. Its interface does not cross the network boundary.

History

Tags: [Hidden, NotReplicated]

RegisterGetCore On DevHub

Name Type Default
parameterName string none
getFunction Function none

History

RegisterSetCore On DevHub

Name Type Default
parameterName string none
setFunction Function none

History

ResetPlayerGuiOnSpawn On DevHub

Globally controls the resetting behavior of LayerCollectors under the PlayerGui.

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

When ResetPlayerGuiOnSpawn is true (the default), a LayerCollector under the PlayerGui will reset if its ResetOnSpawn property is also true. When ResetPlayerGuiOnSpawn is false, LayerCollectors will never reset, regardless of their ResetOnSpawn property.

ResetPlayerGuiOnSpawn is deprecated. To suppress the resetting behavior of a LayerCollector, its ResetOnSpawn property should explicitly be set to false.

History

Tags: [Deprecated]

ScreenOrientation On DevHub

History

SetCore On DevHub

Name Type Default
parameterName string none
value Variant none

History

SetCoreGuiEnabled On DevHub

Name Type Default
coreGuiType CoreGuiType none
enabled bool none

History

ShowDevelopmentGui On DevHub

VirtualCursorMode On DevHub

This member is not scriptable. It cannot be accessed by Lua code.

History

Tags: [NotScriptable]

Removed members

BackpackGuiEnabled

This member is hidden. It is not meant to be used, and may have unresolved issues.

History

Tags: [Hidden]

HealthGuiEnabled

This member is hidden. It is not meant to be used, and may have unresolved issues.

History

Tags: [Hidden]

PlayerListGuiEnabled

This member is hidden. It is not meant to be used, and may have unresolved issues.

History

Tags: [Hidden]

ResetPlayerGuiOnDeath

This member is hidden. It is not meant to be used, and may have unresolved issues.

History

Tags: [Hidden]

Relevant enums (3)