API:Class/LuaSettings

Filtered-inheritance mode: While this class technically inherits all Instance class members, some (if not all) have been hidden because they serve no purpose for this object.
Settings: This object has been marked as a settings object. It is used to hold persistent settings, which may be accessible by Roblox Studio's settings menu, or the in-game menu. This object cannot be created.

Configuration icon.pngLuaSettings : Object Icon.pngInstance

The LuaSettings allows you to change certain properties, in regards to how Roblox handles Lua. It is labeled as Lua in the Roblox Studio Settings menu.

Properties

Properties [toggle]

boolAreScriptStartsReported

Toggles whether or not script starts are logged in the output. If set to true, the output will print blue text indicating what scripts are running, and their origin point in the DataModel.

|RMD member="API:Class/LuaSettings/AreScriptStartsReported"|Toggles whether or not script starts are logged in the output.

If set to true, the output will print blue text indicating what scripts are running, and their origin point in the DataModel.|/RMD|

doubleDefaultWaitTime

How long a call to wait() with no arguments will yield.

|RMD member="API:Class/LuaSettings/DefaultWaitTime"|How long a call to wait() with no arguments will yield.|/RMD|
intGcFrequency

How many heartbeats there are between manual GC steps in Lua.

|RMD member="API:Class/LuaSettings/GcFrequency"|How many heartbeats there are between manual GC steps in Lua.|/RMD|
intGcLimit

The ideal limit above which Roblox triggers aggressive garbage collection, in average KB per GcFrequency.

|RMD member="API:Class/LuaSettings/GcLimit"|The ideal limit above which Roblox triggers aggressive garbage collection, in average KB per GcFrequency.|/RMD|
intGcPause

Sets the size of pauses between successive garbage collections in Lua.

|RMD member="API:Class/LuaSettings/GcPause"|Sets the size of pauses between successive garbage collections in Lua.|/RMD|
intGcStepMul

Sets the value of Lua's garbage collection step multiplier, which controls the 'granularity' of Lua's garbage collector.

|RMD member="API:Class/LuaSettings/GcStepMul"|Sets the value of Lua's garbage collection step multiplier, which controls the 'granularity' of Lua's garbage collector.|/RMD|
floatWaitingThreadsBudget

Sets the maximum percent of Roblox's duty cycle that can be used to resume waiting Lua threads. This defaults to 0.1 (or 10%).

|RMD member="API:Class/LuaSettings/WaitingThreadsBudget"|Sets the maximum percent of Roblox's duty cycle that can be used to resume waiting Lua threads.

This defaults to 0.1 (or 10%).|/RMD|

Toggles whether or not script starts are logged in the output. If set to true, the output will print blue text indicating what scripts are running, and their origin point in the DataModel.
How long a call to wait() with no arguments will yield.
How many heartbeats there are between manual GC steps in Lua.
The ideal limit above which Roblox triggers aggressive garbage collection, in average KB per GcFrequency.
Sets the size of pauses between successive garbage collections in Lua.
Sets the value of Lua's garbage collection step multiplier, which controls the 'granularity' of Lua's garbage collector.
Sets the maximum percent of Roblox's duty cycle that can be used to resume waiting Lua threads. This defaults to 0.1 (or 10%).



|RMD member="API:Class/LuaSettings"|The LuaSettings allows you to change certain properties, in regards to how Roblox handles Lua. It is labeled as Lua in the Roblox Studio Settings menu. |/RMD|