bw logo
Chapter 26. options.xml
Prev     Next

Chapter 26. options.xml

Table of Contents

26.1. CAT
26.2. Model Editor
26.3. Particle Editor
26.4. World Editor

Different tools use a configuration file named options.xml. Their grammars are described in the following sections:

26.1. CAT

For details on the Client Access Tools, see the Client Programming Guide's section Debugging → Client Access Tool (CAT).

Located under bigworld/tools/cat, the grammar of options.xml is listed below: 

<options.xml>

  ?<additionalSearchPath>  list_of_folders  </additionalSearchPath>
  ?<scriptDirectory>       list_of_folders  </scriptDirectory>

</options.xml>

Grammar of bigworld/tools/cat/options.xml

26.2. Model Editor

For details on the Model Editor, see the document Content Tools Reference Guide's section Model Editor.

Located under bigworld/tools/modeleditor, the grammar of options.xml is listed below: 

<root>
   <help>
     <toolsReferenceGuide>   folder/file  </toolsReferenceGuide>
     <contentCreationManual> folder/file  </contentCreationManual>
     <shortcutsHtml>         folder/file  </shortcutsHtml>
   </help>

   <app>
      <maxTimeDelta>  float  </maxTimeDelta>
      <timeScale>     float  </timeScale>
   </app>

   <consoles>
      <darkenBackground> [true|false] </darkenBackground>
      <numMessageLines>  integer      </numMessageLines>
   </consoles>

   <space>  folder/file  </space>

   <ualConfigPath> folder/file </ualConfigPath>

   <camera>
      <speed>  {Slow|Medium|Fast|SuperFast}
         <{Slow|Medium|Fast|SuperFast}>  integer
            <turbo>   integer   </turbo>
         </{Slow|Medium|Fast|SuperFast}>
      </speed>
      <invert>     [0|1]        </invert>
      <mode>       [0|1|2|3|4]  </mode>
      <orbitSpeed> float        </orbitSpeed>
      <rotDir>     [-1|1]       </rotDir>
   </camera>

   <input>
      <exclusive> [true|false] </exclusive>
   </input>

   <graphics>
      <bpp>        [16|32]      </bpp>
      <fullScreen> [true|false] </fullScreen>
      <height>     integer      </height>
      <shadows>    [true|false] </shadows>
      <width>      integer      </width>
   </graphics>

   <render>
      <environment>           [0|1]
         <drawFog>            [0|1]  </drawFog>
         <drawShimmer>        [0|1]  </drawShimmer>
         <drawBloom>          [0|1]  </drawBloom>
         <drawClouds>         [0|1]  </drawClouds>
         <drawSky>            [0|1]  </drawSky>
         <drawSunAndMoon>     [0|1]  </drawSunAndMoon>
         <drawDetailObjects>  [0|1]  </drawDetailObjects>
         <drawStars>          [0|1]  </drawStars>
         <drawStaticSky>      [0|1]  </drawStaticSky>      
      </environment>
      <misc>
          <nearPlane>  float  </nearPlane>
          <farPlane>   float  </farPlane>
      </misc>
      <scenery>
          <wireFrame> [0|1] </wireFrame>
          <drawWater> 
             <refraction> [0|1] </refraction>
             <reflection> [0|1] </reflection>
             <simulation> [0|1] </simulation>
          </drawWater>  
      </scenery>
      <lighting> [0|1|2] </lighting>
      <terrain>  [0|1]
          <wireFrame> [0|1] </wireFrame>
      </terrain>
   </render>

   <renderer>
      <shadows>
         <quality> [0|1|2] </quality>
      </shadows>
   </renderer>

   <precompileEffects> [0|1] </precompileEffects>

   <settings>
      <animateZoom>       [0|1]             </animateZoom>
      <bkgColour>         float float float </bkgColour>
      <centreModel>       [0|1]             </centreModel>
      <checkForSparkles>  [0|1]             </checkForSparkles>
      <floorGrid>         float             </floorGrid>
      <floorTexture>      folder/file       </floorTexture>
      <floraDensity>      [0|1|2|3|4]       </floraDensity>
      <gameTime>          time              </gameTime>
      <sunAngle>          angle             </sunAngle>
      <groundModel>       [0|1]             </groundModel>
      <lastNewTintFX>     [0|1]             </lastNewTintFX>
      <lockLodParents>    [0|1]             </lockLodParents>
      <regenBBOnLoad>     [0|1]             </regenBBOnLoad>
      <showActions>       [0|1]             </showActions>
      <showAxes>          [0|1]             </showAxes>
      <showBinormals>     [0|1]             </showBinormals>
      <showBoundingBox>   [0|1]             </showBoundingBox>
      <showBsp>           [0|1]             </showBsp>
      <showCustomHull>    [0|1]             </showCustomHull>
      <showEditorProxy>   [0|1]             </showEditorProxy>
      <showHardPoints>    [0|1]             </showHardPoints>
      <showLightModels>   [0|1]             </showLightModels>
      <showModel>         [0|1]             </showModel>
      <showNormals>       [0|1]             </showNormals>
      <showOriginalAnim>  [0|1]             </showOriginalAnim>
      <showPortals>       [0|1]             </showPortals>
      <showShadowing>     [0|1]             </showShadowing>
      <showSkeleton>      [0|1]             </showSkeleton>
      <showWireframe>     [0|1]             </showWireframe>
      <useCustomLighting> [0|1]             </useCustomLighting>
      <useFloor>          [0|1]             </useFloor>
      <useTerrain>        [0|1]             </useTerrain>
      <zoomDuration>      float             </zoomDuration>
      <zoomOnLoad>        [0|1]             </zoomOnLoad>
   </setting>

   <startup>
      <lastLoadOK>       [true|false]      </lastLoadOK>
      <lastOrigin>       float float float </lastOrigin>
      <lastView>         matrix            </lastView>
      <loadLastLights>   [0|1]             </loadLastLights>      
      <loadLastModel>    [0|1]             </loadLastModel>
      <showSplashScreen> [0|1]             </showSplashScreen>
   </startup>

   <messages>
      <assetMsgs>    [0|1] </assetMsgs>
      <errorMsgs>    [0|1] </errorMsgs>
      <infoMsgs>     [0|1] </infoMsgs>
      <showDate>     [0|1] </showDate>
      <showPriority> [0|1] </showPriority>
      <showTime>     [0|1] </showTime>
      <noticeMsgs>   [0|1] </noticeMsgs>
      <warningMsgs>  [0|1] </warningMsgs>
   </messages>
   
   <fx>
      <file0> folder/file </file0>
      ...
      <file9> folder/file </file9>
   </fx>
   
   <lights>
      <file0> folder/file </file0>
      ...
      <file9> folder/file </file9>
   </lights>

   <models>
      <file0> folder/file </file0>
      ...
      <file9> folder/file </file9>
   </models>
</root>

Grammar of bigworld/tools/modeleditor/options.xml

The list below describes the tags in bigworld/tools/modeleditor/options.xml:

26.3. Particle Editor

For details on the Particle Editor, see the document Content Tools Reference Guide's section Particle Editor.

Located under bigworld/tools/particleeditor, the grammar of options.xml is listed below: 

<root>
   <space>  folder/file  </space>
   <app>
      <maxTimeDelta>  float  </maxTimeDelta>
   </app>
   <romp>
      <watcherValues>
        <Client Settings/Time of Day>   time </Client Settings/Time of Day>
        <Client Settings/Secs Per Hour> int  </Client Settings/Secs Per Hour>
      </watcherValues>
   </romp>

   <camera>
      <speed>  float  </speed>
   </camera>

   <render>
      <misc>
         <drawFog>         [true|false]  </drawFog>
         <drawBloom>       [true|false]  </drawBloom>
         <drawShimmer>     [true|false]  </drawShimmer>
         <drawSunAndMoon>  [true|false]  </drawSunAndMoon>
         <drawClouds>      [true|false]  </drawClouds>
         <drawSky>         [true|false]  </drawSky>
      </misc>
   </render>

   <settings>
      <floorTexture> folder/file  </floorTexture>
      <floorGrid>    float        </floorGrid>
   </settings>

   <defaults>
      <backgroundColour>  float float float float  </backgroundColour>
      <startDirectory>    folder                   </startDirectory>
      <renderer>
         <blurTexture>    folder/file  </blurTexture>
         <spriteTexture>  folder/file  </spriteTexture>
         <ampTexture>     folder/file  </ampTexture>
         <meshVisual>     folder/file  </meshVisual>
         <trailTexture>   folder/file  </trailTexture>
      </renderer>
      <flareXML> folder/file          </flareXML>
      <bkgmode>  [Terrain|Floor|None] </drawScene>
   </defaults>

   <resourceGlue>
      <environment>
         <sunFlareXML>  folder/file  </sunFlareXML>
      </environment>
   </resourceGlue>

</root>

Grammar of bigworld/tools/particleeditor/options.xml

The list below describes the tags in bigworld/tools/particleeditor/options.xml:

  • ampTexture (section defaults/renderer)

    Default texture to be displayed if the Amp option button is selected in the Renderer Properties sub-panel.

  • backgroundColour (section defaults)

    Colour to be displayed on the background.

  • bkgMode (section defaults)

    Type of background to be displayed on the viewport.

  • blurTexture (section defaults/renderer)

    Default texture to be displayed if the Blur option button is selected in the Renderer Properties sub-panel.

  • Client Settings/ Secs per Hour (section romp/watcherValues)

    Number of real-time seconds in one game-time hour.

  • Client Settings/ Time of Day (section romp/watcherValues)

    Initial time of day in which to render the background. This determines the sun position and colouration.

  • drawBloom (section render/misc)

    Toggles the use of bloom effect.

  • drawClouds (section render/misc)

    Toggles rendering of clouds.

  • drawFog (section render/misc)

    Toggles rendering of fog.

  • drawShimmer (section render/misc)

    Toggles the use of shimmer effect.

  • drawSky (section render/misc)

    Toggles rendering of the sky.

  • drawSunAndMoon (section render/misc)

    Toggles rendering of the sun and the moon.

  • flareXML (section defaults)

    Default light configuration file to display when user adds a Flare sub-system component in the Sub System Components panel's list box

  • floorGrid (section settings)

    Size of the tiles of the background floor.

  • floorTexture (section settings)

    File containing the image to use as floor background.

  • maxTimeDelta (section app)

    Maximum amount of game time that can elapse between two frames.

  • meshVisual (section defaults/renderer)

    Default texture to be displayed if the Mesh option button is selected in the Renderer Properties sub-panel.

  • space

    Folder containing the space to load.

    The path is relative to the resource folder (bigworld/res).

  • speed (section camera)

    Current camera speed.

  • startDirectory (section defaults)

    Folder which particle systems will be displayed in the Select or Enter a Particle System panel's drop-down list box.

  • sunFlareXML (section resourceGlue/environment)

    XML file to use for the sun flare effect when rendering in background mode.

  • trailTexture (section defaults/renderer)

    Default texture to be displayed if the Trail option button is selected in the Renderer Properties sub-panel.

26.4. World Editor

For details on the World Editor, see the document Content Tools Reference Guide's chapter World Editor.

Located under bigworld/tools/World Editor, the grammar of options.xml is listed below: 

<root>
    
   <userTag>  string  </userTag>

   ?<versionControl>
      <batchLimit>             integer         </batchLimit>
      <enable>                 [true|false]    </enable>
      <path>                   folder/file      </path>
   </versionControl>

   <panels>
      <saveLayoutOnExit> [true|false]       </saveLayoutOnExit>
   </panels>

   <help>
     <toolsReferenceGuide>   folder/file  </toolsReferenceGuide>
     <contentCreationManual> folder/file  </contentCreationManual>
     <shortcutsHtml>         folder/file  </shortcutsHtml>
   </help>

   <undoredo>
      <limit>           integer             </limit>
   </undoredo>

   <snaps>
      <movement>         float float float  </movement>
      <angle>            float              </angle>
      <xyzEnabled>      [0|1]               </xyzEnabled>
      <itemSnapMode>    [0|1]               </itemSnapMode>
   </snaps>

   <shellSnaps>
      <movement>         float float float  </movement>
      <angle>            float              </angle>
   </shellSnaps>

   <space>  folder
     *<folder>  folder   </folder>
   </space>

   <bwlockd>
     <use>                [true|false]      </use>
     <host>               server:port       </host>
   </bwlockd>

   <graphics>
      <graphicsPreferencesXML> folder/file </graphicsPreferencesXML>
      <shadows>        [true|false]  </shadows>
      <cameraHeight>    integer      </cameraHeight>
      <farclip>         integer      </farclip>
      <timeofday>       integer      </timeofday>
   </graphics>

   <input>
      <exclusive>       false        </exclusive>
     <legacyMouseWheel> [true|false] </legacyMouseWheel>
   </input>

   <consoles>
      <darkenBackground>  [true|false]  </darkenBackground>
      <numMessageLines>    integer      </numMessageLines>
   </consoles>

   <precompileEffects> [0|1] </precompileEffects>

   <app>
      <maxTimeDelta>  float  </maxTimeDelta>
      <timeScale>     float  </timeScale>
   </app>

   <itemEditor>
      <browsePath>    folder/file <browsePath>
      <lastY>         float       </lastY>
   </itemEditor>

   <tools>
      <alphaTool>                folder/file    </alphaTool>
      <alphaToolSize>            integer        </alphaToolSize>
      <alphaToolStrength>        integer        </alphaToolStrength>
      <alphaToolGUISize>         float          </alphaToolGUISize>
      <chunkVisualisation>       folder/file    </chunkVisualisation>
      <showChunkVisualisation>  [true|false]    </showChunkVisualisation>
      <selectFilter>             selection_opt  </selectFilter>
      <coordFilter>              coord_opt      </coordFilter>
      <optionsPage>              folder/file    </optionsPage>
   </tools>

   <romp>
      <watcherValues>
         <watcher_name> watcher_value </watcher_name>
      </watcherValues>
   </romp>

   <camera>
      <speed>  {Slow|Medium|Fast|SuperFast}
         <{Slow|Medium|Fast|SuperFast}>  integer
            <turbo>   integer   </turbo>
         </{Slow|Medium|Fast|SuperFast}>
      </speed>
      <ortho>  [0|1]  </ortho>
   </camera>

   <object>
      <bb_tab>
         <directory>     folder         </directory>
        ?<selectFilter>  selection_opt  </selectFilter>
      </bb_tab>
   </object>

   <dragOnSelect>  [0|1]    </dragOnSelect>
   <drawBSP>       [0|1|2]  </drawBSP>

   <objects>
      <rememberSelectFilter>  [0|1]  </rememberSelectFilter>
      <readOnlyMode>          [0|1]  </readOnlyMode>
      <materialOverrideMode>  [0|1]  </materialOverrideMode>
   </objects>

   <render>
      <hideOutsideObjects> [0|1]        </hideOutsideObjects>
      <lighting>          [0|1|2]       </lighting>
      <drawChunkPortals>  [true|false]  </drawChunkPortals>

      <environment>           [0|1]
         <drawFog>            [0|1]  </drawFog>
         <drawShimmer>        [0|1]  </drawShimmer>
         <drawBloom>          [0|1]  </drawBloom>
         <drawClouds>         [0|1]  </drawClouds>
         <drawSky>            [0|1]  </drawSky>
         <drawSunAndMoon>     [0|1]  </drawSunAndMoon>
         <drawDetailObjects>  [0|1]  </drawDetailObjects>
         <drawStars>          [0|1]  </drawStars>
         <drawStaticSky>      [0|1]  </drawStaticSky>       
      </environment>

      <scenery>  [0|1]
         <wireFrame>      [0|1]  </wireFrame>
         <particle>       [0|1]  </particle>
         <drawWater> 
            <reflection> [0|1] </reflection>
            <simulation> [0|1] </simulation>
         </drawWater> 
         <shells>  [0|1]
            <gameVisibility> [0|1]  </gameVisibility>
         </shells>
      </scenery>

      <terrain>  [0|1]
         <wireFrame>      [0|1]  </wireFrame>
         <LOD>            [0|1]  </LOD>
      </terrain>

      <lights>  [0|1]
         <drawStatic>     [0|1]  </drawStatic>
         <drawDynamic>    [0|1]  </drawDynamic>
         <drawSpecular>   [0|1]  </drawSpecular>
      </lights>

      <misc>  [0|1]
         <shadeReadOnlyAreas>  [0|1]  </shadeReadOnlyAreas>
         <drawHeavenAndEarth>  [0|1]  </drawHeavenAndEarth>
         <drawPatrolGraphs>    [0|1]  </drawPatrolGraphs>
         <drawEditorProxies>   [0|1]  </drawEditorProxies>
         <drawOverlayLocks>    [0|1]  </drawOverlayLocks>
      </misc>

      <project>
         <spaceMapAlpha>  float  </spaceMapAlpha>
      </project>

      <chunk>
         <vizMode> [0|1] </vizMode>
      </chunk>

      <numLayerWarning> [0|1] </numLayerWarning>

      <height>
         <selTopLeft>      float float </selTopLeft>
         <selBottomRight>  float float </selBottomRight>
         <maskBottomRight> float float </maskBottomRight>
         <maskTopLeft>     float float </maskTopLeft>
      </height>

      <maxFarPlane> float </maxFarPlane>

      <drawChunkPortals>    [true|false] </drawChunkPortals>
      <drawVLO>             [true|false] </drawVLO>
      <drawChunkFlares>     [true|false] </drawChunkFlares>
      <drawChunkLights>     [true|false] </drawChunkLights>
      <drawParticleSystems> [true|false] </drawParticleSystems>
      <drawEntities>        [true|false] </drawEntities>

      <links>
         <maxProcessingMillis>       integer      </maxProcessingMillis>
         <maxRecalcsPerFrame>        integer      </maxRecalcsPerFrame>
         <maxTimeBetweenRecalcs>     float        </maxTimeBetweenRecalcs>
         <maxTimeWaitForMoreChunks>  float        </maxTimeWaitForMoreChunks>
         <minLinkLength>             float        </minLinkLength>
      </links>

      <gameObjects>  [0|1]
         <drawEntities>         [0|1]  </drawEntities>
         <drawUserDataObjects>  [0|1]  </drawUserDataObjects>
      </gameObjects>

   </render>

   <terrain>
      <texture>
         <maxsizelimit>       float           </maxsizelimit>
         <maxsize>            float           </maxsize>
         <minsizelimit>       float           </minsizelimit>
         <minsize>            float           </minsize>
         <size>               float           </size>
         <strength>           float           </strength>
         <lodregentime>       float           </lodregentime>
      </texture>
      <height>
         <maxsizelimit>       float            </maxsizelimit>
         <maxsize>            float            </maxsize>
         <minsizelimit>       float            </minsizelimit>
         <minsize>            float            </minsize>
         <size>               float            </size>
         <maxstrengthlimit>   float            </maxstrengthlimit>
         <maxstrength>        float            </maxstrength>
         <minstrengthlimit>   float            </minstrengthlimit>
         <minstrength>        float            </minstrength>
         <strength>           float            </strength>
         <maxheightlimit>     float            </maxheightlimit>
         <maxheight>          float            </maxheight>
         <minheightlimit>     float            </minheightlimit>
         <minheight>          float            </minheight>
         <height>             float            </height>
         <brushFalloff>       float            </brushFalloff>
         <relative>           [0|1]            </relative>
      </height>
      <filter>
         <maxsizelimit>       float            </maxsizelimit>
         <maxsize>            float            </maxsize>
         <minsizelimit>       float            </minsizelimit>
         <minsize>            float            </minsize>
         <size>               float            </size>
         <index>              integer          </index>
     </filter>
     <cutRepair>
         <maxsizelimit>       float            </maxsizelimit>
         <maxsize>            float            </maxsize>
         <minsizelimit>       float            </minsizelimit>
         <minsize>            float            </minsize>
         <size>               float            </size>
         <brushMode>          [0|1]            </brushMode>
      </cutRepair>
   </terrain>

   <terrain2>
     <defaults>
         <heightMapSize>      integer          </heightMapSize>
         <normalMapSize>      integer          </normalMapSize>
         <holeMapSize>        integer          </holeMapSize>
         <shadowMapSize>      integer          </shadowMapSize>
         <blendMapSize>       integer          </blendMapSize>
         <heightMapUnits>     float            </heightMapUnits>
      </defaults>
      <blendsBuildInterval>   integer          </blendsBuildInterval> 
   </terrain2>

   <messages>
      <showDate>              [0|1]            </showDate>
      <showTime>              [0|1]            </showTime>
      <showPriority>          [0|1]            </showPriority>
      <errorMsgs>             [0|1]            </errorMsgs>
      <warningMsgs>           [0|1]            </warningMsgs>
      <noticeMsgs>            [0|1]            </noticeMsgs>
      <infoMsgs>              [0|1]            </infoMsgs>
      <assetMsgs>             [0|1]            </assetMsgs>
   </messages>

   <sendCrashDump>            [0|1]            </sendCrashDump>

   <project>
      <normalFont>            folder/file      </normalFont>
      <boldFont>              folder/file      </boldFont>
   </project>

   <userTag>                  string           </userTag>

   <placementPreset>          string          </placementPreset>

   <currentLanguage>          string           </currentLanguage>

   <chunkTexture>
      <numLayerWarning>       integer          </numLayerWarning>
      <showtrack>             [0|1]            </showtrack>
      <autotrack>             [0|1]            </autotrack>
      <latch>                 integer          </latch>
      <numLayerWarningShow>   integer          </numLayerWarningShow>
   </chunkTexture>

   <ualConfigPath>            folder/file      </ualConfigPath>

   <warningMemoryLoadLevel>   integer          </warningMemoryLoadLevel>

   <bspBoundingBox>           [0|1]            </bspBoundingBox>

   <fullSave>
      <chunkNumberBetweenSave> integer         </chunkNumberBetweenSave>
      <safeMemoryCountInMB>    integer         </safeMemoryCountInMB>
      <stripeSize>             integer         </stripeSize>
   </fullSave>

</root>

Grammar of bigworld/tools/worldeditor/options.xml

The list below describes the tags in bigworld/tools/worldeditor/options.xml:

Prev     Next
Chapter 25. navgen_settings.xml  Home  Chapter 27. PackedSection files
Copyright 1999-2012 BigWorld Pty. Ltd. All rights reserved. Proprietary commercial in confidence.