CityRP Documentation Repository

cityrp.timeweather

Day / night cycle and weather system - client (sky, fog, HUD, particles, sound).

Functions

Sharedcityrp.timeweather.FormatTime() → stringSource ☍

Returns

  1. string
Sharedcityrp.timeweather.GetPeriod() → stringSource ☍

Returns

  1. string
Sharedcityrp.timeweather.GetTime() → numberSource ☍

Public API mirror used by other plugins.

Returns

  1. number
Sharedcityrp.timeweather.IsNight() → booleanSource ☍

Returns

  1. boolean

Fields

Sharedcityrp.timeweatherSource ☍
Clientcityrp.timeweather.skyRenderSource ☍

Live skypaint values fed to the SkyPaint matproxy every frame.

Clientg_SkyPaintSource ☍

WeatherDefinition

12 fields Source ☍
SharedWeatherDefinition.coldDamageSource ☍

Whether players outside take periodic cold damage.

SharedWeatherDefinition.FogSource ☍

Overrides the ambient day/night fog entirely while active.

SharedWeatherDefinition.groundTextureSource ☍

Ground/model texture swap to apply, currently only "snow".

SharedWeatherDefinition.iconSource ☍

HUD chip icon.

SharedWeatherDefinition.iconColorSource ☍

HUD chip icon tint, defaults to white.

SharedWeatherDefinition.idSource ☍

Unique weather id; "clear" is reserved.

SharedWeatherDefinition.labelSource ☍

Display name, e.g. "Rain".

SharedWeatherDefinition.lightningSource ☍

Whether lightning strikes run while this weather is active.

SharedWeatherDefinition.particleSource ☍

Client particle driver: "rain", "snow", "sandstorm", or nil.

SharedWeatherDefinition.SkySource ☍

Overrides the ambient day/night sky entirely while active.

SharedWeatherDefinition.soundSource ☍

Ambient loop: "rain", "wind", or nil for none.

SharedWeatherDefinition.windScaleSource ☍

Multiplier applied to map env_wind entities. Default 1.

WeatherFog

4 fields Source ☍
SharedWeatherFog.FogColorSource ☍

RGB, 0-1 per channel (same convention as PLUGIN.FogValues).

SharedWeatherFog.FogDensitySource ☍
SharedWeatherFog.FogEndSource ☍
SharedWeatherFog.FogStartSource ☍

WeatherSky

10 fields Source ☍

Same shape as one PLUGIN.SkyColors period preset. Star/cloud fields may be omitted - buildRenderState in cl_init.lua already defaults them when DrawStars is false.

SharedWeatherSky.BottomColorSource ☍

RGB, 0-1 per channel.

SharedWeatherSky.DrawStarsSource ☍
SharedWeatherSky.DuskColorSource ☍

RGB, 0-1 per channel.

SharedWeatherSky.DuskIntensitySource ☍
SharedWeatherSky.DuskScaleSource ☍
SharedWeatherSky.FadeBiasSource ☍
SharedWeatherSky.HDRScaleSource ☍
SharedWeatherSky.SunColorSource ☍

RGB, 0-1 per channel.

SharedWeatherSky.SunSizeSource ☍
SharedWeatherSky.TopColorSource ☍

RGB, 0-1 per channel.