Skip to content

Settings

Settings is a module made to put every configurable setting into one place. These settings get applied at the start of the engine.

Every setting is categorized, depending on what purpose they have.

Rendering

In this category there are settings related to Rendering. Such as optimizing the rendering of UI elements by culling them, disabling character loading or disabling 3D rendering.

Disable3DRendering

Since: 0.6.0 Default: Disable3DRendering true

Disables 3D rendering by

  • Setting the camera FOV to 1
  • Setting the camera type to scriptable
  • Setting the camera's CFrame to 0


DisablePlayerCharacters

Since: 0.5.3 Default: DisablePlayerCharacters true

This setting disables the player characters, by deleting them locally.


OptimizeLighting

Since: 0.6.0 Default: OptimizeLighting true

Optimizes lighting by

  • Ambient, ColorShift_Bottom, ColorShift_Top, OutdoorAmbient, FogColor to black
  • Brightness to 0
  • GlobalShadows to false
  • ClockTime to 4
  • GeographicLatitude to 0


EnableCoreGuis

Since: 0.5.3

This setting is used to enable/disable core guis, to free up space or remove unnecessary features. Such as chat, player list or the emotes menu.

Default values

  • EmotesMenu (default: false)
  • PlayerList (default: false)
  • Backpack (default: false)
  • Health (default: false)
  • Chat (default: false)


Prototypes

Prototypes are settings that are work in progress, unstable or unoptimized. These settings are recommended to be kept at their default state.

List of prototypes present in Rendering

  • CullGuiElements (default: false)
    • Culls out gui elements that are behind each other or out of the screen boundaries
    • Status: Unoptimized, at 2000 objects game lagged at unplayable rate every time an object moved or scene was loaded

Pool

InitialCache

Since: 0.6.0

This setting is used to determine how many should be created for each class present in the table.

Default values

  • ImageLabel (default: 100)
  • TextLabel (default: 100)
  • TextButton (default: 50)
  • ImageButton (default: 50)
  • TextBox (default: 50)
  • ScrollingFrame (default: 5)
  • ViewportFrame (default: 5)
  • Frame (default: 100)


ExtensionSize

Since: 0.6.0 Default: ExtensionSize 10

Used when the pool runs out of the specified object. This setting determines how many should get created to fill up the pool.

Physics

Nature2D.QuadTreesEnabled

Since: 0.6.0 Default: QuadTreesEnabled true

Optimization regarding looking up rigidbodies in Nature2D


Nature2D.CollisionIteration

Since: 0.6.0 Default: CollisionIteration 4

How accure the collision detection should be.

Warning

Higher values result in better collision detection, but at the price of performance! The default value is recommened by Nature2D


Nature2D.ConstraintIteration

Since: 0.6.0 Default: CollisionIteration 3

How accure the contraints should be.

Warning

Higher values result in better contraints detection, but at the price of performance! The default value is recommened by Nature2D

Console

LogHeader

Since: 0.6.0 Default: LogHeader true

Determines if Rethink shoukd print it's header into the console.


LogOnPropertyFail

Since: 0.6.0 Default: LogOnPropertyFail True

Determines if the Compiler should notify in the console, if an unprocessable property was found.

Uncategorized

CompilerChunkSize

Warning: Deprecated since 0.6.2 Since: 0.6.0 Default: CompilerChunkSize 100

How big should a chunk be, when using TaskDistributor.GenerateChunk(). This setting is used in the Compiler.


ViewportColor

Since: 0.6.0 Default: ViewportColor R: 35, R: 68, B: 139

The color of the viewport.