Atmosphere

Atmosphere : Instance

Overview

The Atmosphere class is a component used to simulate realistic atmospheric effects within a game environment. It enhances the visual realism by mimicking how sunlight interacts with air particles, affecting the appearance of distant objects and the overall ambiance. By adjusting various properties, developers can create diverse environmental moods, such as foggy mornings, clear skies, or dramatic sunsets.

Description

The Atmosphere class provides several properties that allow developers to control the visual effects related to atmospheric conditions in their games. It is particularly useful for creating immersive environments where lighting and visibility play crucial roles.

Properties

Density

number

Density represents the concentration or thickness of atmospheric elements like fog, affecting how light is scattered and absorbed in the atmosphere.

Code Samples

local Lighting = game:GetService("Lighting")
local Atmosphere = Lighting:WaitForChild("Atmosphere")

Atmosphere.Density = 0.2

FogFalloffClear

number

A number property in the Atmosphere class controls fog falloff based on distance, ranging from 0.0 to 10.

Code Samples

local Lighting = game:GetService("Lighting")
local Atmosphere = Lighting:WaitForChild("Atmosphere")

Atmosphere.FogFalloffClear = 0.1

StartDistance

number

StartDistance is a number property controlling the starting distance for atmospheric effects in the LuaAtmosphere class, with a range from 0.0 to 30000.0. It sets the starting distance for atmosphere effects in the scene and controls when atmospheric changes become visible.

Code Samples

local Lighting = game:GetService("Lighting")
local Atmosphere = Lighting:WaitForChild("Atmosphere")

Atmosphere.StartDistance = 1000

Color

Color3

The Color property in the Atmosphere class represents the atmospheric color using a custom Color3 structure to store RGB values.

Code Samples

local Lighting = game:GetService("Lighting")
local Atmosphere = Lighting:WaitForChild("Atmosphere")

Atmosphere.Color = Color3.new(255, 0, 0)

TODActor

AMetaTODMobile

{Description Slot}

Code Samples

Methods

Events