loads.lbl

This file is used to list the different SimProp Container XML files along with the information required to use them on specific aircraft as part of the cargo setup, whether for a career mission or for artistic reasons (like adding cases into the aircraft hold). This file goes in the loads folder of the attachment being used to add the cargo to the modular SimObject, and requires a sub folder - SimPropContainers - containing the SimProp Container XML files the loads.lbl file will reference. For more information, please see the following page:

 

Before listing the different keys that the LBL file requires, here is an example showing a single cargo load definition which can be used for reference when setting up your own:

{
  "LabeledSimPropContainers": [
        {
            "Name": "B737_Cargo_Load_Low",
            "SimPropContainerGUID":"{451AF3B8-1676-4234-A503-58FA03B9855C}",
            "Labels": [
            {
                "Key": "Weight",
                "Values":["Light"]
            },
            {
                "Key": "LoadType",
                "Values":["Boxes"]
            },
            {
                "Key": "Aircraft",
                "Values":["b737max8_passengers","b737max8_bbj"]
            }
            ]
        }
    ]
}

 

 

"LabeledSimPropContainers"

This is the top level key of the loads.lbl file, and must be included otherwise the file will be invalid. The value for this element is an array, where each object in the array is a single cargo load definition containing the "Name", "SimPropContainerGUID", and "Labels" keys. There should be one SimProp Container XML file for each cargo load contained in the SimPropContainers folder (which is placed in the loads folder).

 

 

"Name"

This key expects a single value, which is a string defining the name of the SimProp container for the load. This name is purely orientative and is not used in the simulation. It is simply to help clearly identify each load within the file.

 

 

"SimPropContainerGUID"

This key expects a GUID which comes from a pre-created SimProp Container. You can find this from the <GUID> element in the SimProp Container XML file.

 

 

"Labels"

This key expects an array of 1 or more objects, where each object is a "key" and "value" pair. Label keys are used to further filter the list of SimProp Containers available such that only one is possible under any given situation.

 

 

"Key"

This key is used to define a key parameter to be used as a filter to find the correct SimProp Container to use. The available keys (and expected values) are as follows:

 

  • Aircraft - This gives the name of the aircraft variation(s) that can use this cargo load. The variation name(s)s given are taken from the folder name of the Presets, written in lower case.

 

  • NodeName - This is the name of the node to spawn the SimProp Container on, as defined by the node name parameter in the navigation_graph.cfg. If this is defined, the SimProp Container will only spawn on this node, however if there is no node name defined, the SimProp Container will spawn on any node that meets the other label requirements. Note that the node must also be listed by name in the nodes (Main Graph) parameter. This isn't always required, but is useful if you have, for example, left and right versions of a load, or wish to split a load into various areas within a mass section.

 

  • LoadType - This defines the kind of load that the cargo represents. Can only be one of the following strings (which is purely orientative, and is simply used to help filter the SimProp Containers):
    1. Boxes - Any static object, including cases, packages, palettes, etc... This is used for most cargo/loads.
    2. Animals - Any "live" object.

 

  • Weight - This defines the general "bulk" of the load, ie: how full the station load using the SimProp Container is. This corresponds to the setting for "Cargo" in the EFB for example: if the aircraft can carry 300lbs <100 is "Light", >100 and <200 is "medium" and >200 is "Heavy". Can only be one of the following strings:
    1. Light
    2. Medium
    3. Heavy

 

 

"Value"

This is an array of values that accompany the given key to generate the filter used to find the correct cargo load to use. See the list of possible keys given above for relevant values.