LIVING WORLD CONFIGURATION DEFINITIONS

The LWcfg.xml file should be formatted as follows:

<?xml version="1.0" encoding="UTF-8"?>
<SimBase.Document>
    <LivingWorld.LivingWorldSettings>
        <GeneralSettings>
            <!-- GENERAL DATA HERE -->
        </GeneralSettings>
        <LivingWorldRegion RegionID="<REGION>" RightSideDrive="TRUE/FALSE">
            <!-- REGION DATA HERE -->
        </LivingWorldRegion>
        <!-- FURTHER REGION DEFINITIONS HERE -->
    </LivingWorld.LivingWorldSettings>
</SimBase.Document>

Within the <SimBase.Document> element you would always have the <LivingWorld.LivingWorldSettings> element, which acts as a container for everything else. This element can have the following sub-elements, which are explained in detail below:

 

 

<LivingWorld.LivingWorldSettings>

This is a mandatory base element that acts as a container element for defining the general living world settings. This element can contain the following sub-elements: <GeneralSettings>, <LivingWorldRegion>.

 

 

 

<GeneralSettings>

This element is a container element for some General settings of the living world, without limits to regions. It has no attributes and can contain the following sub-elements: <AmbientVehiclesQuantityByParking>, <ParkedAircraftsQuantityByParking>, <FrequencyOfServicesOnEmptyParkings>, <RatioOfAmbientVehiclesThatAreImmobile>.

 

 

<AmbientVehiclesQuantityByParking>

This element determines how many ambient vehicles will be generated in each airport, and will affect all airports in the region. The number and type of parkings spots in the airport correlates with the type and size of the airport, and thus the number of vehicles to generate. This element has no attributes and acts as a container for the <ParkingEntry> element.

 

<ParkingEntry>

This element defines a parking type with an associated number of ambient vehicles to spawn per parking of this type on an airport. It is a self-closing element that has the following attributes:

 

Attribute Description Type Required
ParkingType The type of parking being defined.

Enum:

NONE
DOCK_GA
FUEL
GATE_HEAVY
GATE_MEDIUM
GATE_SMALL
RAMP_CARGO
RAMP_GA
RAMP_GA_LARGE
RAMP_GA_MEDIUM
RAMP_GA_SMALL
RAMP_MIL_CARGO
RAMP_MIL_COMBAT
VEHICLE
RAMP_GA_EXTRA
GATE_EXTRA

 Yes
Rate Amount of ambient vehicles created for each parking of this type. Float Yes

 

 

<ParkedAircraftsQuantityByParking>

With this element you can list parking types, and determine how likely it is to generate a Parked Aircraft on each such parking, as well as how much the best matching of parking radius impacts the model of aircraft chosen. This element has no attributes and acts as a container for the <ParkingEntryWeighted> element.

 

<ParkingEntryWeighted>

This element defines a parking type with an associated number of Parked Aircraft to spawn per parking of this type in an airport. Note that any parking type not present in the list of <ParkingEntryWeighted> will behave as if it was explicitly defined with a Rate of 0. This is a self-closing element that has the following attributes:

 

Attribute Description Type Required
ParkingType The type of parking being defined.

Enum:

NONE
DOCK_GA
FUEL
GATE_HEAVY
GATE_MEDIUM
GATE_SMALL
RAMP_CARGO
RAMP_GA
RAMP_GA_LARGE
RAMP_GA_MEDIUM
RAMP_GA_SMALL
RAMP_MIL_CARGO
RAMP_MIL_COMBAT
VEHICLE
RAMP_GA_EXTRA
GATE_EXTRA

 Yes
Rate Amount of parked aircraft created for each parking of this type. Float Yes
GoodToBadMatchRate Factor (between 0.0 and 1.0) that determines how much more likely aircraft that best match the parking radius will be spawned rather than aircraft with smaller wingspans. Note that a GoodToBadMatchRate of 0.0 means that only the aircraft that best match the parking radius will be spawned. A value of 1.0 means any aircraft that fits in the parking is as likely to be spawned. A value 0.5 means that aircraft that best match the parking radius are twice as likely to be spawned than other aircraft. Float Yes

 

 

<FrequencyOfServicesOnEmptyParkings>

This element will determine how many of the parking spots that are not occupied by aircraft will still generate service vehicles around them to "populate" the airport. This is a self-closing element that has the following attribute:

 

Attribute Description Type Required
rate Rate (between 0.0 and 1.0) of empty parking spots that will have service vehicles spawned around them.

Float

 Yes

 

 

<RatioOfAmbientVehiclesThatAreImmobile>

This element determines how many of the ambient vehicles will stay immobile instead of moving around the airport. This is a self-closing element that has the following attribute:

 

Attribute Description Type Required
rate Proportion (between 0.0 and 1.0) of ambient vehicles that will never move and just stay at their designated parking spot.

Float

 Yes

 

 

<LivingWorldRegion>

This element is for defining regions and corresponds to one of the 24 different regions of the world. Here you list various types of vehicles, boats, and/or human characters that can be used to populate the given region. The different regions are explained in more detail here:

This element is a container element for the following sub-elements: <FreewayTraffic>, <Airport>, <Boats> and <InlandBoats>. The element also has the following attributes:

 

Attribute Description Type Required
RegionID A single capital letter (from A to X in the roman alphabet) identifying the current region of the world

String

 Yes
RightSideDrive Sets whether vehicles on the roads drive on the right side (TRUE), or the left side (FALSE) Bool No

 

 

<FreewayTraffic>

This container element is used to list the vehicles that are to be used for Road Traffic in this region, as well as the relative weight between various models. It has no attributes and will contain the <ModelEntry> sub-element.

NOTE: Legacy files may have this element with the attribute TrafficSpeed. This attribute is deprecated in Microsoft Flight Simulator and will be ignored (nor is it required for new files).

 

<ModelEntry>

This element defines a single model of a vehicle along with its associated weight. This is a self-closing element that has the following attributes:

 

Attribute Description Type Required
ModelID The GUID of the SceneryObject to use.

String

 Yes
EntryWeight

Integer weight to determine the relative frequency of this model compared to any other (higher weight means higher chances of choosing this model). More information can be found in the Examples Of EntryWeight section.

NOTE: An EntryWeight might be 0, but the sum of the EntryWeights of a list must be strictly greater than 0 and strictly less than 2147483647

 Integer Yes

 

 

<Airport>

The airport element is used to define the various types of vehicles and human characters to be generated in this region. Most vehicle types have their own specifics explained in their respective sections around the Ground Vehicles section.

 

This element is essentially a container element and will hold the following sub-elements: <AmbientTraffic>, <PushbackTugs>, <SmallPushbacks>, <FuelTrucks>, <BaggageLoaders>, <BaggageCarts>, <BaggageDollies>, <CateringTrucks>, <BoardingRamps>, <GroundPowerUnits>, <IdleWorkers>, <GroundVehiclePilots>, <Marshaller>.

 

<AmbientTraffic>

This container element is used to list vehicle models to be used for Ambient Traffic wandering across the airport for this region. It has no attributes and will contain one or more of the <ContainerEntry /> sub-element.

 

<PushbackTugs>

This container element is used to list the Pushback vehicle models in this region. It has no attributes and will contain one or more of the <ContainerEntry /> sub-element.

 

<SmallPushbacks>

This container element is used to list the Small Pushback vehicle models in this region. It has no attributes and will contain one or more of the <ContainerEntry /> sub-element.

 

<FuelTrucks>

This container element is used to list the Fuel Truck vehicle models in this region. It has no attributes and will contain one or more of the <ContainerEntry /> sub-element.

 

<BaggageLoaders>

This container element is used to list the vehicle models to be used as baggage loaders in airports of this region. It has no attributes and will contain one or more of the <ContainerEntry /> sub-element.

 

<BaggageCarts>

This container element is used to list the vehicle models to be used as baggage carts/tugs in airports of this region. It has no attributes and will contain one or more of the <ContainerEntry /> sub-element.

 

<BaggageDollies>

This container element is used to list vehicles to be used as baggage dollies in airports of this region. It has no attributes and will contain one or more of the <ContainerEntry /> sub-element.

 

<CateringTrucks>

This container element is used to list the vehicle models to be used as catering trucks in airports of this region. It has no attributes and will contain one or more of the <ContainerEntry /> sub-element.

 

<BoardingRamps>

This container element is used to list the vehicle models to be used as boarding ramps in airports of this region. It has no attributes and will contain one or more of the <ContainerEntry /> sub-element.

 

<GroundPowerUnits>

This container element is used to list Lists the vehicle models to be used as ground power units in airports of this region. It has no attributes and will contain one or more of the <ContainerEntry /> sub-element.

 

<IdleWorkers>

This container element is used to list the human character models to be used as idle workers in airports of this region. It has no attributes and will contain one or more of the <ContainerEntry /> sub-element.

 

<GroundVehiclePilots>

This container element is used to list the human character models to be used as vehicle drivers in airports of this region. It has no attributes and will contain one or more of the <ContainerEntry /> sub-element.

 

<Marshaller>

This container element is used to list the human character models to be used as marshallers in airports of this region. It has no attributes and will contain one or more of the <ContainerEntry /> sub-element.

 

 

<Boats> and <InlandBoats>

The <Boats> element is a container element for the boat models used in the region. It must contain the sub-element <InlandBoats>, which in turn will contain a list of one or more of the <ContainerEntry /> sub-elements defining the actual models to be used.

 

 

<ContainerEntry />

This element defines a single ground or water vehicle model, or human character model, along with its associated weight. This is a self-closing element that has the following attributes:

 

Attribute Description Type Required
ContainerTitle Unique title identifying the variant of the SimObject to use.

String

 Yes
EntryWeight

Integer weight to determine the relative frequency of this model compared to any other (higher weight means higher chances of choosing this model). More information can be found in the Examples Of EntryWeight section.

NOTE: An EntryWeight might be 0, but the sum of the EntryWeights of a list must be strictly greater than 0 and strictly less than 2147483647

 Integer Yes