Get Region Data

7 June 2015

Release 8.22 - added the optional region parameter.

getregiondata (Commands)
Type	Corrade progressive command
Command	`getregiondata`
Description	The `getregiondata` can be used to retrieve information about the current simulator that the bot is on.
Permissions	`land`
Parameters	`group`, `password`, `data`
Last Changes	Release 8.22 - added the optional `region` parameter.

The getregiondata can be used to retrieve information about the current simulator that the bot is on.

Command Required Parameters Required Corrade Permissions Example

getregiondata

group, password, data

land

llInstantMessage(CORRADE,
    wasKeyValueEncode(
        [
            "command", "getregiondata",
            "group", wasURLEscape(GROUP),
            "password", wasURLEscape(PASSWORD),
            // returns the last lag and the
            // agents on the current simulator
            "data", wasListToCSV(
                [
                    "Stats.LastLag",
                    "Stats.Agents"
                ]
            ),
            // sent to URL
            "callback", wasURLEscape(URL)
        ]
    )
);

The data parameter is supplied a CSV list of fields and properties of a libopenmetaverse Simulator structure, including any sub-structures.

Optional Parameter	Possible Values	Description
`region`	A string representing a region name.	Attempt to perform the command on the specified region. Note that Corrade must be connected to that region. If in doubt, please use the getconnectedregions command to determine whether the region you want to specify is currently connected.

For example, to query the Stats sub-structure of the Simulator structure, one could supply a list of fields to the data parameter:

Parameter	Possible Values	Description	Examples
`data`	`ActiveScripts`	Number of Active scripts running in this simulator	llInstantMessage(CORRADE, wasKeyValueEncode( [ "command", "getregiondata", "group", wasURLEscape(GROUP), "password", wasURLEscape(PASSWORD), // returns the last lag and the // agents on the current simulator "data", wasListToCSV( [ "Stats.LastLag", "Stats.Agents" ] ), // sent to URL "callback", wasURLEscape(URL) ] ) );
	`Agents`	Number of agents currently in this simulator
	`AgentTime`
	`AgentUpdates`
	`ChildAgents`	Number of agents in neighbor simulators
	`ConnectTime`	Time in seconds agent has been connected to simulator
	`Dilation`	Current time dilation of this simulator
	`FPS`	Current Frames per second of simulator
	`FrameTime`
	`ImageTime`
	`IncomingBPS`	Incoming bytes per second
	`INPPS`
	`LastLag`
	`LastPingID`	ID of last Ping sent
	`LastPingSent`	Time last ping was sent
	`LSLIPS`
	`MissedPings`
	`NetTime`
	`Objects`	Total number of objects Simulator is simulating
	`OtherTime`
	`OutgoingBPS`	Outgoing bytes per second
	`OUTPPS`
	`PendingDownloads`	Number of downloads pending
	`PendingLocalUploads`	Number of local uploads pending
	`PendingUploads`	Number of uploads pending
	`PhysicsFPS`	Current Physics frames per second of simulator
	`PhysicsTime`
	`ReceivedPongs`	Total number of ping replies sent to this agent by this simulator
	`ReceivedResends`	Total number of resent packets recieved
	`RecvBytes`	Total number of bytes received by this simulator to this agent
	`RecvPackets`	Total number of packets received by this simulator to this agent
	`ResentPackets`	Total number of packets that have been resent
	`ResidentSize`
	`ScriptedObjects`	Total number of Active (Scripted) objects running
	`ScriptTime`
	`SentBytes`	Total number of bytes sent by this simulator to this agent
	`SentPackets`	Total number of packets sent by this simulator to this agent
	`SentPings`	Total number of pings sent to this simulator by this agent
	`UnackedBytes`	Unacknowledged bytes in queue
	`VirtualSize`

Or one could query the Simulator structure for data such as the Name, SimVersion and the RegionID. Perhaps combined with the Agents field of the Stats sub-structure of the Simulator structure:

llInstantMessage(CORRADE,
    wasKeyValueEncode(
        [
            "command", "getregiondata",
            "group", wasURLEscape(GROUP),
            "password", wasURLEscape(PASSWORD),
            // returns the name, simversion and regionid from the Simulator structure combined
            // with the agents field from the Stats sub-structure of the Simulator structure
            "data", wasListToCSV(
                [
                    "Name",
                    "SimVersion",
                    "RegionID",
                    "Stats.Agents"
               ]
            ),
            // sent to URL
            "callback", wasURLEscape(URL)
        ]
    )
);