Varregion/Protocol
From OpenSimulator
(→Simulator to Client Protocol) |
(More on varregion size info) |
||
| Line 14: | Line 14: | ||
EstablishAgentCommunication event message: at a point had integers 'region-size-x' and 'region-size-y', Those where not used, so removed. | EstablishAgentCommunication event message: at a point had integers 'region-size-x' and 'region-size-y', Those where not used, so removed. | ||
| + | ===Discovering region size=== | ||
| + | Current Open Simulator restrictions, as of 2023, are square regions only, with sizes multiples of 256x256m, aligned on boundaries which are multiples of 256. Regions of different sizes must not be neighbors. Maximum region size is 4096 x 4096 meters. {{citeneeded}}. However, a single grid may contain regions of more than one size. | ||
| + | |||
| + | There have been both simulators and viewers in the past with fewer restrictions. | ||
| + | ====First region after login=== | ||
| + | At login, the XML returned from the login reply should contain the fields "region_size_x" and "region_size_y", with the region dimensions as an integer. This is the size of the first region. | ||
| + | ====Other regions==== | ||
| + | "Some information for var regions is only sent using the HTTP region capability 'Event'"[http://opensimulator.org/pipermail/opensim-dev/2023-May/026946.html] | ||
===Terrain Patch=== | ===Terrain Patch=== | ||
| + | Terrain is sent in blocks of patches of 16 x 16 terrain heights, as with Second Life.[http://opensimulator.org/pipermail/opensim-dev/2023-May/026946.html]. Terrain squares are 4x4 meters regardless of region size. Larger regions have more patches. | ||
===Cloud Patch=== | ===Cloud Patch=== | ||
===Wind Patch=== | ===Wind Patch=== | ||
Revision as of 10:15, 17 May 2023
Varregion Protocol
Contents |
The communication protocols need extensions to pass around the size of the regions. These extensions are in the simulator to client protocols, the simulator to simulator protocols and the simulator to grid service protocols. This page documents most of the changes.
Simulator to Client Protocol
NOTE: These LLUDP messages are currently blacklisted and no longer used. This information is now passed via a capability.
- EnableSimulator event message: add integers 'RegionSizeX' and 'RegionSizeY'
- CrossRegion event message: add integers 'RegionSizeX' and 'RegionSizeY' to 'RegionData' section.
- TeleportFinish event message: add integers 'RegionSizeX' and 'RegionSizeY' to 'Info' section.
EstablishAgentCommunication event message: at a point had integers 'region-size-x' and 'region-size-y', Those where not used, so removed.
Discovering region size
Current Open Simulator restrictions, as of 2023, are square regions only, with sizes multiples of 256x256m, aligned on boundaries which are multiples of 256. Regions of different sizes must not be neighbors. Maximum region size is 4096 x 4096 meters. Template:Citeneeded. However, a single grid may contain regions of more than one size.
There have been both simulators and viewers in the past with fewer restrictions.
=First region after login
At login, the XML returned from the login reply should contain the fields "region_size_x" and "region_size_y", with the region dimensions as an integer. This is the size of the first region.
Other regions
"Some information for var regions is only sent using the HTTP region capability 'Event'"[1]
Terrain Patch
Terrain is sent in blocks of patches of 16 x 16 terrain heights, as with Second Life.[2]. Terrain squares are 4x4 meters regardless of region size. Larger regions have more patches.
Cloud Patch
Wind Patch
Simulator to Grid Service Protocol
Simulator to Simulator Protocol
- HelloNeighbor message: add 'region_size_x' and 'region_size_y' to region info.
