class_name FXConfig extends Resource
## Stores settings to apply to FX.

## Variety of weather condition.
enum WeatherType {
	NONE, ## No particular weather condition.
	RAIN, ## Rainfall.
	SNOW ## Snowfall.
}

## Whether to render a canvas layer in the background instead of sky.
@export var canvas := false
## Music that should play.
@export var bgm: AudioStream = null
## Ambience that should play.
@export var bgs: AudioStream = null
## Desired fog color.
@export var fog := Color.TRANSPARENT
## How close the sky should look to midnight.
@export var night: float = 0.0
## How cloudy the sky should be.
@export var overcast: float = 0.25
## How wet the environment should be.
@export var wet: float = 0.0
## Desired wind speed.
@export var wind: float = 0.25
## Direction the light should come from. (Opposite of actual facing direction.)
@export var light_source := Vector3.UP
## Light intensity.
@export var light_energy: float = 0.25
## Weather that should occur.
@export var weather_type := WeatherType.NONE
## Amount of weather to occur.
@export var weather_magnitude: float = 0.0
## Screen tint, e.g. for exceptionally hot or cold environments.
@export var tint := Color.WHITE