Get Region Data

7 June 2015

  • Release 8.22 - added the optional region parameter.
getregiondata (Commands)
TypeCorrade progressive command
Commandgetregiondata
DescriptionThe getregiondata gets information about the current simulator that the bot is on.
Permissionsland
Parametersgroup, password, data
Last ChangesRelease 8.22 - added the optional region parameter.

The getregiondata gets 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 ActiveScriptsNumber 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)
        ]
    )
);
AgentsNumber of agents currently in this simulator
AgentTime
AgentUpdates
ChildAgentsNumber of agents in neighbor simulators
ConnectTimeTime in seconds agent has been connected to simulator
DilationCurrent time dilation of this simulator
FPSCurrent Frames per second of simulator
FrameTime
ImageTime
IncomingBPSIncoming bytes per second
INPPS
LastLag
LastPingIDID of last Ping sent
LastPingSentTime last ping was sent
LSLIPS
MissedPings
NetTime
ObjectsTotal number of objects Simulator is simulating
OtherTime
OutgoingBPSOutgoing bytes per second
OUTPPS
PendingDownloadsNumber of downloads pending
PendingLocalUploadsNumber of local uploads pending
PendingUploadsNumber of uploads pending
PhysicsFPSCurrent Physics frames per second of simulator
PhysicsTime
ReceivedPongsTotal number of ping replies sent to this agent by this simulator
ReceivedResendsTotal number of resent packets recieved
RecvBytesTotal number of bytes received by this simulator to this agent
RecvPacketsTotal number of packets received by this simulator to this agent
ResentPacketsTotal number of packets that have been resent
ResidentSize
ScriptedObjectsTotal number of Active (Scripted) objects running
ScriptTime
SentBytesTotal number of bytes sent by this simulator to this agent
SentPacketsTotal number of packets sent by this simulator to this agent
SentPingsTotal number of pings sent to this simulator by this agent
UnackedBytesUnacknowledged 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)
        ]
    )
);

secondlife/scripted_agents/corrade/api/commands/getregiondata.txt ยท Last modified: 2020/09/04 06:53 (external edit)

Access website using Tor Access website using i2p Wizardry and Steamworks PGP Key


For the copyright, license, warranty and privacy terms for the usage of this website please see the license, privacy, copyright and the plagiarism pages.