bw logo
Chapter 32. space.settings
Prev     Next

Chapter 32. space.settings

Contains environment settings, bounding rectangle of grid squares, etc...

Mentioned in document Client Programming Guide's section Chunks, Implementation files.

The grammar for space.settings is described below: 

<root>
   <timeOfDay>        file  </timeOfDay>
   <skyGradientDome>  file  
    ?<farPlane>      float </farPlane>
   </skyGradientDome>
  ?<seas>
    ?<seaLevel>         float                    </seaLevel>
    ?<wavePeriod>       float                    </wavePeriod>
    ?<waveExtent>       float                    </waveExtent>
    ?<tidePeriod>       float                    </tidePeriod>
    ?<tideExtent>       float                    </tideExtent>
    ?<surfaceTopColour> float float float float  </surfaceTopColour>
    ?<surfaceBotColour> float float float float  </surfaceBotColour>
    ?<underwaterColour> float float float float  </underwaterColour>
   </seas>
  ?<farPlane>        float              </farPlane>
  ?<singleDir>       [true|false]       </singleDir>
  ?<startPosition>   float float float  </startPosition>
  ?<startDirection>  float float float  </startDirection>
  ?<bounds>
     <minX>  integer  </minX>
     <minY>  integer  </minY>
     <maxX>  integer  </maxX>
     <minY>  integer  </minY>
   </bounds>
  ?<navmeshGenerator>  string  </navmeshGenerator>
  ?<clientNavigation>
    ?<enable>  [true|false]  </enable>
   </clientNavigation>
</root>

Grammar of space.settings

The list below describes the tags in space.settings:

  • bounds

    The bounds in X- and Z-axis - the Y here is actually Z-axis in world space.

    The unit is the grid size.

  • clientNavigation

    This is the section that determines how client navigation can be used. For details about client-side navigation, see Navigation.

  • enable (section clientNavigation)

    Whether or not navigation methods can be used by the client.

  • farPlane

    Space's far plane.

  • maxX (section bounds)

    Max grid bounds in X

  • maxY (section bounds)

    Max grid bounds in Z

  • minX (section bounds)

    Min grid bounds in X

  • minY (section bounds)

    Min grid bounds in Z

  • navmeshGenerator

    The type of process used to generate navigation meshes. If this value is changed, chunks will not automatically be dirtied, so the next navmesh generation will have to be run in overwrite mode.

    Valid values are "navgen", "recast" and "none". "navgen" will be set for new spaces, and will be used as the default if no entry exists.

  • singleDir

    If this is set to true, all chunk files will reside in one folder. If this is set to false, all chunk files will be put into different folders (for a large space).

  • skyGradientDome

    Sky configuration file.A

    The path is relative to game's resource folder — <res>.

  • startDirection

    The direction a player faces when he starts the game

  • startPosition

    The location of a player when he starts the game

  • timeOfDay

    Sky configuration file.A

    The path is relative to the game's resource folder — <res>.

A — For details, see the document Client Programming Guide's section 3D Engine (Moo), Features, Lighting, Light maps, Sky light map. For details on this file's grammar, see <sky>.xml.

Prev     Next
Chapter 31. shadows.xml  Home  Chapter 33. .texanim
Copyright 1999-2012 BigWorld Pty. Ltd. All rights reserved. Proprietary commercial in confidence.