llGetEnvironment

function

Function syntax

list llGetEnvironment(

vector pos,// Position vector in region coordinates (X/Y determine the parcel, or region if X/Y are -1; Z determines the sky track altitude).
list params// A list of environmental attributes to retrieve.

);

Returns: list
Energy: 10

If an unknown rule is encountered in the parameter list an error is sent to the debug channel.

Returns a list containing the current environment values for the parcel or region as a list of attributes. Takes a list of attributes to retrieve in params and returns them in the order requested.

list result = llGetEnvironment(ZERO_VECTOR, []);

Specification

From the LSL definitions: EnvironmentParamReadOnly (rule and request, then what it returns)

// Sun, moon and starsSKY_SUN → rotation rot, float scale, vector sun_color, integer is_default_texture, vector direction, vector ambient_color, vector diffuse_colorSKY_MOON → rotation rot, float scale, float brightness, integer is_default_texture, vector direction, vector ambient_color, vector diffuse_colorSKY_SUN_TEXTURESKY_MOON_TEXTURESKY_GLOW → float glow_size, float glow_focusSKY_STAR_BRIGHTNESS → float brightness  // 0 to 500SKY_LIGHT → vector light_direction, vector fade_color, vector total_ambient// Sky colour and atmosphereSKY_AMBIENT → vector ambient_colorSKY_BLUE → vector blue_density, vector blue_horizonSKY_HAZE → float density, float horizon, float density_multiplier, float distance_multiplierSKY_GAMMA → float gamma  // 0 to 20SKY_DOME → float offset, float radius, float max_altitudeSKY_PLANET → float planet_radius, float sky_bottom_radius, float sky_top_radiusSKY_REFRACTION → float moisture_level, float droplet_radius, float ice_levelSKY_REFLECTION_PROBE_AMBIANCE → float ambiance  // 0.0 to 10.0// CloudsSKY_CLOUDS → vector color, float coverage, float scale, float variance, vector scroll, vector density, vector detail, integer is_defaultSKY_CLOUD_TEXTURE// WaterWATER_FOG → vector color, float density, float modulationWATER_NORMAL_TEXTUREWATER_NORMAL_SCALE → vector scale  // <0,0,0> to <10,10,10>WATER_WAVE_DIRECTION → vector large_wave, vector small_waveWATER_FRESNEL → float offset, float scaleWATER_REFRACTION → float scale_above, float scale_belowWATER_BLUR_MULTIPLIER → float multiplier  // -0.5 to 0.5// Day cycle and defaultsENVIRONMENT_DAYINFO → integer day_length, integer day_offset, float secs_since_midnightSKY_TRACKS → float sky2, float sky3, float sky4SKY_TEXTURE_DEFAULTS → integer bloom_is_default, integer halo_is_default, integer rainbow_is_defaultWATER_TEXTURE_DEFAULTS → integer normal_is_default, integer transparent_is_default

Parameters

Caveats

If the script can not run in the requested parcel, this function returns an empty list and issues a warning in the debug channel.
SKY_LIGHT’s param fade_color does not return a clamped value, meaning an unusually bright scene will cause it to return an out-of-bounds color. (This can be fixed by clamping the value manually, but this should really return a clamped value).

Examples

Example 1

default
{
    touch_start(integer total_number)
    {
        list environment = llGetEnvironment(llGetPos(), [SKY_TRACKS, SKY_AMBIENT, SKY_CLOUDS]);
        llOwnerSay(llDumpList2String(environment, ", "));
    }
}