Outdoor Environment

Description

The Environment Outdoors library is used to modify settings of the QLabs actor environment. Not all Open World environments support all environmental features.

Outdoor Environment Library

class library_qlabs_environment_outdoors.QLabsEnvironmentOutdoors(qlabs, verbose=False)[source]: This class modifies QLabs open worlds with outdoor environments.

Constants

QLabsEnvironmentOutdoors.ID_ENVIRONMENT_OUTDOORS = 1100: Class ID

QLabsEnvironmentOutdoors.CLEAR_SKIES = 0

QLabsEnvironmentOutdoors.PARTLY_CLOUDY = 1

QLabsEnvironmentOutdoors.CLOUDY = 2

QLabsEnvironmentOutdoors.OVERCAST = 3

QLabsEnvironmentOutdoors.FOGGY = 4

QLabsEnvironmentOutdoors.LIGHT_RAIN = 5

QLabsEnvironmentOutdoors.RAIN = 6

QLabsEnvironmentOutdoors.THUNDERSTORM = 7

QLabsEnvironmentOutdoors.LIGHT_SNOW = 8

QLabsEnvironmentOutdoors.SNOW = 9

QLabsEnvironmentOutdoors.BLIZZARD = 10

Methods

QLabsEnvironmentOutdoors.set_time_of_day(time)[source]

Set the time of day for an outdoor environment.

Parameters: time (float) – A value from 0 to 24. Midnight is a value 0 or 24. Noon is a value of 12.
Returns: True if setting the time was successful, False otherwise
Return type: boolean

QLabsEnvironmentOutdoors.set_outdoor_lighting(state)[source]

Overrides the outdoor lighting set by other environment functions

Parameters: state – 0 force lights off, 1 force lights on
Returns: True if setting the time was successful, False otherwise
Return type: boolean

QLabsEnvironmentOutdoors.set_weather_preset(weather_preset)[source]

Set the weather conditions for an outdoor environment with a preset value

Parameters: time (int32) – A preset index (see defined constants for weather types)
Returns: True if setting the time was successful, False otherwise
Return type: boolean