FogVolume
Adds fog within a bounded region of world space.
- Creatable
Instance.new("FogVolume")- Inherits
- Instance
- Replication
- Standard
Behavior
FogVolume adds fog within a bounded region of world space.
Summary
The color of light scattered by the fog.
The directionality of fog scattering relative to incoming light.
The position and orientation of the volume in world space.
Compatibility spelling of CFrame.
The density used to calculate light scattering and visibility in this FogVolume.
The distance over which fog density fades near the volume boundary.
The fog's emitted-light color.
The multiplier applied to the fog's emitted light.
Whether this fog volume is enabled.
The rate at which density decreases with height.
The boundary shape used for this region.
The dimensions of this region, in studs.
Returns this instance if it is an ExecutionGroup.
Properties
Albedo
FogVolume.Albedo: Color3 = Color3.new(1, 1, 1)The color of light scattered by the fog.
Anisotropy
FogVolume.Anisotropy: number = 0.2The directionality of fog scattering relative to incoming light.
CFrame
FogVolume.CFrame: CFrame = CFrame.new(0, 0, 0)The position and orientation of the volume in world space.
CoordinateFrame
FogVolume.CoordinateFrame: CFrameCompatibility spelling of CFrame. Use CFrame in new code.
Density
FogVolume.Density: number = 0.3The density used to calculate light scattering and visibility in this FogVolume.
EdgeFade
FogVolume.EdgeFade: number = 0.5The distance over which fog density fades near the volume boundary.
Emission
FogVolume.Emission: Color3 = Color3.new(0, 0, 0)The fog's emitted-light color.
EmissionBrightness
FogVolume.EmissionBrightness: number = 1The multiplier applied to the fog's emitted light.
Enabled
FogVolume.Enabled: boolean = trueWhether this fog volume is enabled.
HeightFalloff
FogVolume.HeightFalloff: number = 0The rate at which density decreases with height.
Shape
FogVolume.Shape: Enum.FogVolumeShape = Enum.FogVolumeShape.BoxThe boundary shape used for this region.
Size
FogVolume.Size: Vector3 = Vector3.new(24, 12, 24)The dimensions of this region, in studs.
Methods
GetExecutionGroup
FogVolume:GetExecutionGroup(): ExecutionGroup?Returns this instance if it is an ExecutionGroup. Otherwise returns the nearest ancestor ExecutionGroup, or nil when no group contains the instance.
Inherited members
- Properties
- ArchivableClassNameNameParent
- Methods
- AddComponent()AddTag()ClearAllChildren()ClearTags()Clone()Destroy()FindFirstAncestor()FindFirstAncestorOfClass()FindFirstAncestorWhichIsA()FindFirstChild()FindFirstChildOfClass()FindFirstChildWhichIsA()FindFirstDescendant()GetAttribute()GetAttributeChangedSignal()GetAttributes()GetChildren()GetComponent()GetComponentChangedSignal()GetComponents()GetDebugId()GetDescendants()GetFullName()GetPropertyChangedSignal()GetReferencing()GetTags()HasComponent()HasTag()IsA()IsAncestorOf()IsDescendantOf()RemoveComponent()RemoveTag()SetAttribute()WaitForChild()
- Events
- AncestryChangedAttributeChangedChangedChildAddedChildRemovedDescendantAddedDescendantRemovingDestroying