Load Oar
From OpenSimulator
(add since column) |
Misterblue (Talk | contribs) (Added examples of using 'load oar') |
||
| Line 7: | Line 7: | ||
The load oar command has the format: | The load oar command has the format: | ||
| − | <tt>load oar [parameters] OARFILE</tt> | + | <tt>load oar [parameters] OARFILE</tt> |
where "OARFILE" is the path to the OAR file to read in, and "[parameters]" is zero or more optional parameters from the following list: | where "OARFILE" is the path to the OAR file to read in, and "[parameters]" is zero or more optional parameters from the following list: | ||
| Line 52: | Line 52: | ||
== Notes On Regions of Different Sizes == | == Notes On Regions of Different Sizes == | ||
| + | With the addition of [[VarRegions]] there is the possibility of loading OARs to and from regions of different sizes. In general, loading an OAR from a smaller region into a larger region will do what you expect. Trying to load a larger region into a smaller region will generate many errors although, if you have adjacent smaller regions, some of the objects will be loaded into the adjacent regions. Try at your own risk. | ||
= Example Uses = | = Example Uses = | ||
== Replacing a region's contents with what's in an OAR file == | == Replacing a region's contents with what's in an OAR file == | ||
| + | Replacing a region with an OAR file for a region of the same size is as simple as: | ||
| − | == Merging together | + | <tt>load oar NewRegion.oar</tt> |
| + | |||
| + | == Merging together four region's worth of contents == | ||
| + | Say you have four adjacent 256x256 region ('Region00.oar', 'Region01.oar', ...) and you want to load them into a new 512x512 [[VarRegion]] ('BiggerRegion'). The commands would be: | ||
| + | |||
| + | <tt>change region BiggerRegion</tt> | ||
| + | <tt>load oar Region0.oar</tt> | ||
| + | <tt>load oar --merge --force-terrain --displacement <0,256,0> Region01.oar</tt> | ||
| + | <tt>load oar --merge --force-terrain --displacement <256,0,0> Region10.oar</tt> | ||
| + | <tt>load oar --merge --force-terrain --displacement <256,256,0> Region11.oar</tt> | ||
== Loading a 256x256 region's contents into the middle of a 512x512 sized region == | == Loading a 256x256 region's contents into the middle of a 512x512 sized region == | ||
| + | If you have an OAR file for a 256x256 region ('LegacyRegion.oar' for instance) and you want to set it into the middle of a 512x512 region with the loaded region rotated by 30 degrees without messing up the rest of the larger region, the command would be: | ||
| + | |||
| + | <tt>load oar --merge --force-terrain --force-parcels --displacement <128,128,0> --rotation 30.0 --rotation-center <128,128,0> LegacyRegion.oar</tt> | ||
Revision as of 09:19, 8 June 2014
 |
Languages: |
|
Contents |
Load Oar Console Command
Once you have saved regions in OAR files, the 'load oar' console command will load the OAR file into the current region. There are many parameters that enable replacing the region's current contents or merging the OAR file's contents with the objects and terrain already in the region.
Parameters
The load oar command has the format:
load oar [parameters] OARFILE
where "OARFILE" is the path to the OAR file to read in, and "[parameters]" is zero or more optional parameters from the following list:
| Parameter | Since | Description |
|---|---|---|
| --merge | 0.6.8 | Specify to merge the contents of the reading OAR with the existing contents in the region. |
| --skip-assets | 0.6.9 | If set, this will not load any of the assets from the OAR, though all other data will be loaded. This saves a lot of time and database operations if loading an OAR multiple times on a grid -- specify --skip-assets after the first time the OAR is loaded on a grid as the assets would have already been loaded the first time the OAR files was loaded. |
| --displacement | dev | Specify a displacement that is added to all objects in the OAR file as they are added to the region. The displacement MUST be specified as "<x,y,z>". So, for instance, to load an OAR from a 256x256 region into the middle of a larger 512x512 region, the parameter would be --displacement "<128,128,0>". Note that you can specify a "Z" displacement which will move the objects up or down. Thus --displacement "<0,0,1000>" will put all the OAR's objects up high for a sky box.
The displacement is also applied to the terrain if it is included. The 'z' component is added to the terrain's heights. |
| --rotation | dev | The degrees to rotate all the objects loaded from the OAR. |
| --rotation-center | dev | The center around which to rotate objects on load. |
| --no-objects | dev | Don't load any scene objects. |
| --force-terrain | dev | Force terrain loading on --merge. Normally, --merge does not overwrite the existing region's terrain. |
| --force-parcels | dev | Force parcel loading on --merge. Normally, --merge does not overwrite the existing region's parcel data. |
Notes On Regions of Different Sizes
With the addition of VarRegions there is the possibility of loading OARs to and from regions of different sizes. In general, loading an OAR from a smaller region into a larger region will do what you expect. Trying to load a larger region into a smaller region will generate many errors although, if you have adjacent smaller regions, some of the objects will be loaded into the adjacent regions. Try at your own risk.
Example Uses
Replacing a region's contents with what's in an OAR file
Replacing a region with an OAR file for a region of the same size is as simple as:
load oar NewRegion.oar
Merging together four region's worth of contents
Say you have four adjacent 256x256 region ('Region00.oar', 'Region01.oar', ...) and you want to load them into a new 512x512 VarRegion ('BiggerRegion'). The commands would be:
change region BiggerRegion load oar Region0.oar load oar --merge --force-terrain --displacement <0,256,0> Region01.oar load oar --merge --force-terrain --displacement <256,0,0> Region10.oar load oar --merge --force-terrain --displacement <256,256,0> Region11.oar
Loading a 256x256 region's contents into the middle of a 512x512 sized region
If you have an OAR file for a 256x256 region ('LegacyRegion.oar' for instance) and you want to set it into the middle of a 512x512 region with the loaded region rotated by 30 degrees without messing up the rest of the larger region, the command would be:
load oar --merge --force-terrain --force-parcels --displacement <128,128,0> --rotation 30.0 --rotation-center <128,128,0> LegacyRegion.oar
