java.lang.Object
- worldBuilder.Parameters

```
public class Parameters
extends java.lang.Object
```
a Singleton class containing global program parameters. values may be default or overridden from command line or dialogs

Field Summary

Fields
Modifier and Type	Field	Description
`int`	`alt_max`	world altitude slider range
`int`	`alt_scale`	world altitude slider unit
`double`	`artery_flux`	min artery flux (m^3/s)
`java.lang.String`	`author_name`	world author name
`int`	`border`	display border width (px)
`double`	`Cd`	of sediment that could come out of this water, what fraction can deposit per mesh point
`double`	`Ce`	of rock this water could erode, what fraction can be eroded per mesh point
`java.lang.String`	`config_directory`
`static int`	`CONICAL`	mountain shape: triangular
`double`	`Cs`	in very slow moving water, what is the maximum silt deposition (m) per m^3/s of flow
`static int`	`CYLINDRICAL`	mountain shape: plauteau
`int`	`dAltitude`	default mountain altitude
`int`	`dAltLevels`	default outside altitude levels
`int`	`dAmount`	default rainfall amount (cm/y)
`int`	`dDiameter`	default mountain diameter
`int`	`dDirection`	default slope axis (deg)
`int`	`debug_level`	verbose/debug level
`double`	`deep_threshold`	min deep water (m)
`int`	`delta_h_max`	export hydro slider range
`int`	`delta_t_max`	export temp slider range
`int`	`delta_z_max`	soil height slider range
`int`	`descr_height`	display descript height (px)
`int`	`descr_width`	display descript width (px)
`java.lang.String`	`description`	world description string
`int`	`dFaunaMax`	default export % metal
`int`	`dFaunaMin`	default export % structural
`int`	`dFaunaPct`	default export % mineral deps
`int`	`dFloraMax`	default export % brush
`int`	`dFloraMin`	default export % tall grass
`int`	`dFloraPct`	default export % plant cover
`int`	`dGroundMax`	default outside % ground
`int`	`dGroundMin`	default outside % pit
`int`	`dHillMax`	default overworld % hill (by height)
`int`	`dHillMin`	default overworld % ground (by height)
`int`	`dialogBorder`	display dialog border (px)
`int`	`diam_grain`	world diameter slider ticks
`int`	`diam_scale`	world diameter slider unit
`int`	`diameter_max`	world diameter slider range
`int`	`display_options`	map views to be displayed
`int`	`dOutline`	chosen mountain outline
`double`	`Dp`	depth (m) of rain pentration into the soil (or how much water the soil can hold)
`int`	`dRockMax`	default export % metal
`int`	`dRockMin`	default export % structural
`int`	`dRockPct`	default export % mineral deps
`int`	`dShape`	default mountain shape
`int`	`dSlopeMin`	default overworld % ground (by slope)
`int`	`dTileSize`	default export tile size (m)
`double`	`dTimeClimb`	vertical minutes/km
`double`	`dTimeCross`	crossing minutes/m^3/s
`double`	`dTimeTravel`	horizontal minutes/km
`double`	`dTravelDay`	travel minutes per day
`double`	`dTravelMax`	max days between cities
`int`	`dTribute`	default river flow (m^3/s)x
`int`	`dWaterMax`	default export % shallow
`int`	`dWaterMin`	default export % marsh
`double`	`E35C`	transpiration half-time (days), time (at 35C) to evaporate half of the water
`double`	`Edeg`	evaporation vs temperature (degC) temperature reduction to halve evaporation rate
`static int`	`ELIPSE`	mountain outline: elipse
`java.lang.String`	`export_dir`	simple export dir
`java.util.LinkedList<java.lang.String>`	`exportRules`	selected export rules
`java.lang.String`	`fauna_rules`	default fauna configuration
`double`	`flood_mult`	spring flood vs mean water flow
`java.lang.String`	`flora_rules`	default flora configuration
`int`	`height`	display sceern height (px)
`int`	`improvements`	new mesh smooth iterations
`double`	`lapse_rate`	adiabatic lapse rate (degC/M): used to compute temperature changes associated w/altitude
`double`	`latitude`	default world latitude (deg)
`int`	`levels_max`	export max height/alt levels
`int`	`levels_min`	export min height/alt levels
`double`	`longitude`	default world longitude (deg)
`int`	`m_width_divisor`	mountain width slider range
`java.lang.String`	`map_name`	name of this map
`java.lang.String`	`mineral_rules`	default mineral resources
`int`	`msl_range`	MSL slider range
`java.lang.String`	`Out_palette`	default export outsde palette
`java.lang.String`	`overlay_objects`	default export overlay objects
`java.lang.String`	`OW_palette`	default export overworld palette
`java.lang.String`	`parent_name`	RPGMaker parent map
`int`	`points`	new mesh initial points
`java.lang.String`	`project_dir`	project export dir
`int`	`radius`	planetary radius (km)
`int`	`rain_max`	rain slider range
`java.lang.String`	`region_name`	world region name
`double`	`river_flux`	min river flux (m^3/s)
`java.lang.String`	`rule_debug`	export rule to trace
`double`	`sea_level`	default map sea level (m)
`double`	`sediment`	mountain height (m) above which the soil ceases to be sedimentary but becomes igneous/metamorphic
`double`	`slope_init`	new mesh initial dz/dx
`double`	`Smax`	max soil in moving water (liters/liter)
`static int`	`SPHERICAL`	mountain shape: rounded
`static int`	`SQUARE`	mountain outline: square
`double`	`stream_flux`	min stream flux (m^3/s)
`int`	`tiles_max`	export # tiles warn limit
`double`	`tilt`	planeteary axis tilt (deg)
`java.lang.String`	`title`	program name/version
`double`	`Tmax`	mean equitorial temp (degC)
`double`	`Tmin`	mean polar temp (degC)
`int`	`topo_major`	topo minor lines/major
`int`	`topo_minor`	topo meters/minor line
`int`	`tribute_max`	river flow slider range
`static java.lang.String`	`unit_d`	Unit: compass dir
`static java.lang.String`	`unit_f`	Unit: flow rate
`static java.lang.String`	`unit_p`	Unit: screen res
`static java.lang.String`	`unit_r`	Unit: rainfall
`static java.lang.String`	`unit_s`	Unit: slope
`static java.lang.String`	`unit_t`	Unit: temperature
`static java.lang.String`	`unit_v`	Unit: velocity
`static java.lang.String`	`unit_V`	Unit: volume
`static java.lang.String`	`unit_xy`	Unit: distance
`static java.lang.String`	`unit_xy2`	Unit: land area
`static java.lang.String`	`unit_z`	Unit: altitude
`double`	`Vd`	transition from deposition to silt (m/s)
`double`	`Ve`	transition from erosion to deposition (m/s)
`double`	`Vmax`	maximum possible water velocity (m/s)
`double`	`Vmin`	minimum possible water velocity (m/s)
`int`	`width`	display screen width (px)
`java.lang.String`	`world_dir`	world open/save dir
`static double`	`x_extent`	map: X-range
`int`	`xy_range`	default world max width (km)
`static double`	`y_extent`	map: Y-range
`static double`	`z_extent`	map: Z-range
`int`	`z_range`	default world max altitude (m)

Constructor Summary

Constructors
Constructor Description

Parameters(java.lang.String filename, int debug)
read parameter values from a configuration file

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`double`	`altitude(double z)`	turn a map z coordinate into a world altitude
`void`	`checkDefaults()`	ensure defaults are consistent w/(updated) world size
`java.lang.String`	`getDescription()`
`static Parameters`	`getInstance()`
`double`	`height(double z)`	turn a map z value into a world height
`double`	`km(double d)`	turn a map distance into world km
`double`	`latitude(double y)`	translate map coordinate into a latitude
`double`	`longitude(double x)`	translate map coordinate into a longitude
`double`	`meanSummer()`	mean Summer temperature (for this latitude)
`double`	`meanTemp()`	mean temperature (for this latitude)
`double`	`meanWinter()`	mean Winter temperature (for this latitude)
`static int`	`niceTics(int min, int max, boolean major)`	attractive slider calibration
`void`	`setDescription(java.lang.String descr)`	set world description string
`void`	`worldParms()`	print out the world configuration (after changes and reloads)
`double`	`x(double km)`	turn a world distance into a map x/y value
`double`	`z(double height)`	turn a world height into a map z value

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - title
```
public java.lang.String title
```
    program name/version
  - map_name
```
public java.lang.String map_name
```
    name of this map
  - parent_name
```
public java.lang.String parent_name
```
    RPGMaker parent map
  - project_dir
```
public java.lang.String project_dir
```
    project export dir
  - export_dir
```
public java.lang.String export_dir
```
    simple export dir
  - world_dir
```
public java.lang.String world_dir
```
    world open/save dir
  - exportRules
```
public java.util.LinkedList<java.lang.String> exportRules
```
    selected export rules
  - config_directory
```
public java.lang.String config_directory
```
  - unit_xy
```
public static final java.lang.String unit_xy
```
    Unit: distance
    
    See Also:
    
    Constant Field Values
  - unit_xy2
```
public static final java.lang.String unit_xy2
```
    Unit: land area
    
    See Also:
    
    Constant Field Values
  - unit_z
```
public static final java.lang.String unit_z
```
    Unit: altitude
    
    See Also:
    
    Constant Field Values
  - unit_r
```
public static final java.lang.String unit_r
```
    Unit: rainfall
    
    See Also:
    
    Constant Field Values
  - unit_s
```
public static final java.lang.String unit_s
```
    Unit: slope
    
    See Also:
    
    Constant Field Values
  - unit_f
```
public static final java.lang.String unit_f
```
    Unit: flow rate
    
    See Also:
    
    Constant Field Values
  - unit_v
```
public static final java.lang.String unit_v
```
    Unit: velocity
    
    See Also:
    
    Constant Field Values
  - unit_V
```
public static final java.lang.String unit_V
```
    Unit: volume
    
    See Also:
    
    Constant Field Values
  - unit_t
```
public static final java.lang.String unit_t
```
    Unit: temperature
    
    See Also:
    
    Constant Field Values
  - unit_d
```
public static final java.lang.String unit_d
```
    Unit: compass dir
    
    See Also:
    
    Constant Field Values
  - unit_p
```
public static final java.lang.String unit_p
```
    Unit: screen res
    
    See Also:
    
    Constant Field Values
  - x_extent
```
public static final double x_extent
```
    map: X-range
    
    See Also:
    
    Constant Field Values
  - y_extent
```
public static final double y_extent
```
    map: Y-range
    
    See Also:
    
    Constant Field Values
  - z_extent
```
public static final double z_extent
```
    map: Z-range
    
    See Also:
    
    Constant Field Values
  - points
```
public int points
```
    new mesh initial points
  - improvements
```
public int improvements
```
    new mesh smooth iterations
  - slope_init
```
public double slope_init
```
    new mesh initial dz/dx
  - radius
```
public int radius
```
    planetary radius (km)
  - tilt
```
public double tilt
```
    planeteary axis tilt (deg)
  - Tmin
```
public double Tmin
```
    mean polar temp (degC)
  - Tmax
```
public double Tmax
```
    mean equitorial temp (degC)
  - height
```
public int height
```
    display sceern height (px)
  - width
```
public int width
```
    display screen width (px)
  - border
```
public int border
```
    display border width (px)
  - dialogBorder
```
public int dialogBorder
```
    display dialog border (px)
  - descr_width
```
public int descr_width
```
    display descript width (px)
  - descr_height
```
public int descr_height
```
    display descript height (px)
  - stream_flux
```
public double stream_flux
```
    min stream flux (m^3/s)
  - river_flux
```
public double river_flux
```
    min river flux (m^3/s)
  - artery_flux
```
public double artery_flux
```
    min artery flux (m^3/s)
  - deep_threshold
```
public double deep_threshold
```
    min deep water (m)
  - topo_minor
```
public int topo_minor
```
    topo meters/minor line
  - topo_major
```
public int topo_major
```
    topo minor lines/major
  - display_options
```
public int display_options
```
    map views to be displayed
  - alt_max
```
public int alt_max
```
    world altitude slider range
  - alt_scale
```
public int alt_scale
```
    world altitude slider unit
  - diameter_max
```
public int diameter_max
```
    world diameter slider range
  - diam_scale
```
public int diam_scale
```
    world diameter slider unit
  - diam_grain
```
public int diam_grain
```
    world diameter slider ticks
  - msl_range
```
public int msl_range
```
    MSL slider range
  - rain_max
```
public int rain_max
```
    rain slider range
  - m_width_divisor
```
public int m_width_divisor
```
    mountain width slider range
  - CONICAL
```
public static final int CONICAL
```
    mountain shape: triangular
    
    See Also:
    
    Constant Field Values
  - SPHERICAL
```
public static final int SPHERICAL
```
    mountain shape: rounded
    
    See Also:
    
    Constant Field Values
  - CYLINDRICAL
```
public static final int CYLINDRICAL
```
    mountain shape: plauteau
    
    See Also:
    
    Constant Field Values
  - ELIPSE
```
public static final int ELIPSE
```
    mountain outline: elipse
    
    See Also:
    
    Constant Field Values
  - SQUARE
```
public static final int SQUARE
```
    mountain outline: square
    
    See Also:
    
    Constant Field Values
  - delta_z_max
```
public int delta_z_max
```
    soil height slider range
  - tribute_max
```
public int tribute_max
```
    river flow slider range
  - tiles_max
```
public int tiles_max
```
    export # tiles warn limit
  - levels_min
```
public int levels_min
```
    export min height/alt levels
  - levels_max
```
public int levels_max
```
    export max height/alt levels
  - delta_t_max
```
public int delta_t_max
```
    export temp slider range
  - delta_h_max
```
public int delta_h_max
```
    export hydro slider range
  - xy_range
```
public int xy_range
```
    default world max width (km)
  - z_range
```
public int z_range
```
    default world max altitude (m)
  - latitude
```
public double latitude
```
    default world latitude (deg)
  - longitude
```
public double longitude
```
    default world longitude (deg)
  - description
```
public java.lang.String description
```
    world description string
  - author_name
```
public java.lang.String author_name
```
    world author name
  - region_name
```
public java.lang.String region_name
```
    world region name
  - sea_level
```
public double sea_level
```
    default map sea level (m)
  - dDirection
```
public int dDirection
```
    default slope axis (deg)
  - dAmount
```
public int dAmount
```
    default rainfall amount (cm/y)
  - dDiameter
```
public int dDiameter
```
    default mountain diameter
  - dAltitude
```
public int dAltitude
```
    default mountain altitude
  - dShape
```
public int dShape
```
    default mountain shape
  - dOutline
```
public int dOutline
```
    chosen mountain outline
  - dTimeTravel
```
public double dTimeTravel
```
    horizontal minutes/km
  - dTimeClimb
```
public double dTimeClimb
```
    vertical minutes/km
  - dTimeCross
```
public double dTimeCross
```
    crossing minutes/m^3/s
  - dTravelDay
```
public double dTravelDay
```
    travel minutes per day
  - dTravelMax
```
public double dTravelMax
```
    max days between cities
  - dTribute
```
public int dTribute
```
    default river flow (m^3/s)x
  - dTileSize
```
public int dTileSize
```
    default export tile size (m)
  - dWaterMin
```
public int dWaterMin
```
    default export % marsh
  - dWaterMax
```
public int dWaterMax
```
    default export % shallow
  - dFloraPct
```
public int dFloraPct
```
    default export % plant cover
  - dFloraMin
```
public int dFloraMin
```
    default export % tall grass
  - dFloraMax
```
public int dFloraMax
```
    default export % brush
  - dRockPct
```
public int dRockPct
```
    default export % mineral deps
  - dRockMin
```
public int dRockMin
```
    default export % structural
  - dRockMax
```
public int dRockMax
```
    default export % metal
  - dFaunaPct
```
public int dFaunaPct
```
    default export % mineral deps
  - dFaunaMin
```
public int dFaunaMin
```
    default export % structural
  - dFaunaMax
```
public int dFaunaMax
```
    default export % metal
  - OW_palette
```
public java.lang.String OW_palette
```
    default export overworld palette
  - dHillMin
```
public int dHillMin
```
    default overworld % ground (by height)
  - dHillMax
```
public int dHillMax
```
    default overworld % hill (by height)
  - dSlopeMin
```
public int dSlopeMin
```
    default overworld % ground (by slope)
  - Out_palette
```
public java.lang.String Out_palette
```
    default export outsde palette
  - dAltLevels
```
public int dAltLevels
```
    default outside altitude levels
  - dGroundMin
```
public int dGroundMin
```
    default outside % pit
  - dGroundMax
```
public int dGroundMax
```
    default outside % ground
  - overlay_objects
```
public java.lang.String overlay_objects
```
    default export overlay objects
  - flora_rules
```
public java.lang.String flora_rules
```
    default flora configuration
  - fauna_rules
```
public java.lang.String fauna_rules
```
    default fauna configuration
  - mineral_rules
```
public java.lang.String mineral_rules
```
    default mineral resources
  - Dp
```
public double Dp
```
    depth (m) of rain pentration into the soil (or how much water the soil can hold)
  - E35C
```
public double E35C
```
    transpiration half-time (days), time (at 35C) to evaporate half of the water
  - Edeg
```
public double Edeg
```
    evaporation vs temperature (degC) temperature reduction to halve evaporation rate
  - lapse_rate
```
public double lapse_rate
```
    adiabatic lapse rate (degC/M): used to compute temperature changes associated w/altitude
  - Vmin
```
public double Vmin
```
    minimum possible water velocity (m/s)
  - Vmax
```
public double Vmax
```
    maximum possible water velocity (m/s)
  - Ve
```
public double Ve
```
    transition from erosion to deposition (m/s)
  - Vd
```
public double Vd
```
    transition from deposition to silt (m/s)
  - Smax
```
public double Smax
```
    max soil in moving water (liters/liter)
  - flood_mult
```
public double flood_mult
```
    spring flood vs mean water flow
  - Ce
```
public double Ce
```
    of rock this water could erode, what fraction can be eroded per mesh point
  - Cd
```
public double Cd
```
    of sediment that could come out of this water, what fraction can deposit per mesh point
  - Cs
```
public double Cs
```
    in very slow moving water, what is the maximum silt deposition (m) per m^3/s of flow
  - sediment
```
public double sediment
```
    mountain height (m) above which the soil ceases to be sedimentary but becomes igneous/metamorphic
  - debug_level
```
public int debug_level
```
    verbose/debug level
  - rule_debug
```
public java.lang.String rule_debug
```
    export rule to trace
- Constructor Detail
  - Parameters
```
public Parameters(java.lang.String filename,
                  int debug)
```
    read parameter values from a configuration file
    
    Parameters:
    
    filename - of configuration file to be read
    
    debug - level of output to be produced
- Method Detail
  - checkDefaults
```
public void checkDefaults()
```
    ensure defaults are consistent w/(updated) world size
  - getInstance
```
public static Parameters getInstance()
```
    Returns:
    
    Singleton Parameter instance
  - worldParms
```
public void worldParms()
```
    print out the world configuration (after changes and reloads)
  - niceTics
```
public static int niceTics(int min,
                           int max,
                           boolean major)
```
    attractive slider calibration
    
    Parameters:
    
    min - slider value
    
    max - slider value
    
    major - tic interval
    
    Returns:
    
    recommended minor tic interval
  - meanTemp
```
public double meanTemp()
```
    mean temperature (for this latitude)
    
    Returns:
    
    mean temperature (degC)
  - meanWinter
```
public double meanWinter()
```
    mean Winter temperature (for this latitude)
    
    Returns:
    
    mean temperature (degC)
  - meanSummer
```
public double meanSummer()
```
    mean Summer temperature (for this latitude)
    
    Returns:
    
    mean temperature (degC)
  - latitude
```
public double latitude(double y)
```
    translate map coordinate into a latitude
    
    Parameters:
    
    y - map coordinate (-0.5 to 0.5) return latitude (in degrees)
  - longitude
```
public double longitude(double x)
```
    translate map coordinate into a longitude
    
    Parameters:
    
    x - map coordinate (-0.5 to 0.5) return longitude (in degrees)
  - km
```
public double km(double d)
```
    turn a map distance into world km
    
    Parameters:
    
    d - (distance in map coordiantes)
    
    Returns:
    
    distance in kilometers
  - x
```
public double x(double km)
```
    turn a world distance into a map x/y value
    
    Parameters:
    
    km - - distance
    
    Returns:
    
    map delta-x (0.0-1.0)
  - height
```
public double height(double z)
```
    turn a map z value into a world height
    
    Parameters:
    
    z - (height in map coordinates)
    
    Returns:
    
    meters
  - altitude
```
public double altitude(double z)
```
    turn a map z coordinate into a world altitude
    
    Parameters:
    
    z - (height in map coordinates)
    
    Returns:
    
    meters (above sea level)
  - z
```
public double z(double height)
```
    turn a world height into a map z value
    
    Parameters:
    
    height - in meters
    
    Returns:
    
    map delta-z (0.0 - 1.0)
  - getDescription
```
public java.lang.String getDescription()
```
    Returns:
    
    world description string (\n escapes replaced by newlines)
  - setDescription
```
public void setDescription(java.lang.String descr)
```
    set world description string
    
    Parameters:
    
    descr - string (possibly containing newlines, which will be escaped)

Class Parameters

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

title

map_name

parent_name

project_dir

export_dir

world_dir

exportRules

config_directory

unit_xy

unit_xy2

unit_z

unit_r

unit_s

unit_f

unit_v

unit_V

unit_t

unit_d

unit_p

x_extent

y_extent

z_extent

points

improvements

slope_init

radius

tilt

Tmin

Tmax

height

width

border

dialogBorder

descr_width

descr_height

stream_flux

river_flux

artery_flux

deep_threshold

topo_minor

topo_major

display_options

alt_max

alt_scale

diameter_max

diam_scale

diam_grain

msl_range

rain_max

m_width_divisor

CONICAL

SPHERICAL

CYLINDRICAL

ELIPSE

SQUARE

delta_z_max

tribute_max

tiles_max

levels_min

levels_max

delta_t_max

delta_h_max

xy_range

z_range

latitude

longitude

description

author_name

region_name

sea_level

dDirection

dAmount

dDiameter

dAltitude