llGetEnv

From Second Life Wiki
Revision as of 23:59, 14 November 2016 by Lucia Nightfire (talk | contribs) (Added info for "region_max_prims".)
Jump to navigation Jump to search

Summary

Function: string llGetEnv( string name );

Returns a string with the requested data about the region.

• string name The name of the data to request

Note that the value returned is a string, you may need to cast it to an integer for use in calculations.

Table of valid name values.
Name Description Type to typecast to
"agent_limit" Get the maximum number of avatars normally allowed on this region (teleport home, and login to last location, are allowed to exceed this). integer
"dynamic_pathfinding" Get the region's effective dynamic_pathfinding status, "enabled" or "disabled". This option is configured in the Region Debug Console N/A
"estate_id" Numerical index identifying which estate a region belongs to. Main grid mainland is "1" integer
"estate_name" "mainland", "Linden Homes", "My Happy Estate", etc. N/A
"frame_number" Get the frame number of the simulator, for example "42042". integer
"region_cpu_ratio" Get number of regions per CPU for this region type. Returns "1" or "4". integer
"region_idle" Get the region's idle status, "1" or "0". integer boolean
"region_product_name" Get the type of region this is: "Estate / Full Region", "Mainland / Homestead", "Estate / Openspace", "Estate / Full Region - Skill Gaming" etc. N/A
"region_product_sku" Get the region's product number (as string). N/A
"region_start_time" Get the time the region was last (re)started, in llGetUnixTime format integer
"sim_channel" Get the region's channel string, for example "Second Life Server". N/A
"sim_version" Get the region's version number string, for example "10.11.30.215699". N/A
"simulator_hostname" Get the simhost running this region. Same as llGetSimulatorHostname but without the script delay. N/A
"region_max_prims" Get the maximum number of prims allowed on this region. integer

Examples

default
{
    touch_start(integer total_number)
    {
        string version = llGetEnv("sim_version");
        llOwnerSay("Region " + llGetRegionName() + " is running "
                   + llGetEnv("sim_channel") + " version " + version );

        list ver = llParseString2List(version, ["."], []);

        llOwnerSay("Build: "+llList2String(ver, 3));
        llOwnerSay("Build Date: "+llList2String(ver, 2)+"-"+llList2String(ver, 1)+"-20"+llList2String(ver, 0));
    }
}

Notes

  • Region idling lowers a region's framerate when no avatars are currently on or looking into the region. Scripts measuring time dilation with llGetRegionTimeDilation may report significant time dilation if the region is idle.

See Also

Deep Notes

History

  • SVC-4874
  • Introduced in Second Life RC LeTigre 10.11.30.215699, deployed on 2010-12-01.
  • Deployed to rest of Agni with Second Life Server 10.11.30.215699, Second Life RC BlueSteel 10.12.06.216207, Second Life RC Magnum 10.11.30.215699
  • "frame_number" option added in Second Life RC BlueSteel 12.01.03.247042
    • Returns an integer that represents the current 'frame' of the simulator. Generally only useful for specific debugging cases.
  • Removed (temporarily?) in Second Life RC BlueSteel 12.01.06.247303

Signature

function string llGetEnv( string name );