SIMPROPCONTAINER XML PROPERTIES

The <container_name.xml file should be formatted as follows:

<?xml version="1.0" encoding="UTF-8"?>
<SimBase.Document>
    <SimPropContainer.SimPropContainers>
        <SimPropContainer [attributes]>
            <GUID>guid_here</GUID>
            <Descr>SimProp-Container-Description-Here</Descr>
            <SimPropBase [attributes]>
                <!-- SIMPROP BASE PROPERTIES HERE -->
            </SimPropBase>
            <SimPropAttachs [attributes]>
                <SimPropAttach [attributes]>
                    <!-- OBJECT PROPERTIES HERE -->
                </SimPropAttach>
                <SimPropAttach [attributes]>
                    <!-- OBJECT PROPERTIES HERE -->
                </SimPropAttach>
                <!-- FURTHER OBJECTS HERE -->
            </SimPropAttachs>
        </SimPropContainer>
    </SimPropContainer.SimPropContainers>
</SimBase.Document>

 

Here you must include the <SimBase.Document> element and within that the <SimPropContainer.SimPropContainers> element (with no attributes).

IMPORTANT! The file details given here are meant purely for reference purposes and we do not recommend that you manually create these files but instead always use The Scenery Editor.

 

 

<SimPropContainer>

This element is used as a container element for all the other objects that comprise the SimPropContainer object. It has the following attribute:

 

Attribute Description Type Required
instanceId The GUID used to identify this instance of the element. You can find more information on GUID's here: GUIDs String Yes

 

Within this container the following elements are required:

  1. <GUID>
  2. <Descr>
  3. <SimPropInclude>
  4. <GLTFMerges>
  5. <SimPropBase>
  6. <SimPropAttachs>
  7. <Override>

 

 

<GUID>

This is a sub-element of the <SimPropContainer>, <SimPropInclude>, and <SimPropContainerInstance> elements, and is used to give a GUID to the SimPropContainer object/instance or included object. This GUID will be used as a reference in other files for missions and scenery. The element is formatted like this:

<GUID>{FDE1EC0B-7021-45E9-AC3B-066E307B4979}</GUID>

You can find more information on GUID's here: GUIDs

 

 

<Descr>

This is a sub-element of <SimPropContainer> and is used to give a name to the SimPropContainer object. The element is formatted like this:

<Descr>Building-NE-Carpark</Descr>

 

 

<SimPropInclude>

 

Within this container the following element is required:

  1. <GUID>

 

 

<GLTFMerges>

 

 

 

<Override>

 

 

 

<SimPropBase>

This is a sub-element of <SimPropContainer> and is used to define the base "pivot" object around which the SimPropContainer will be based. This element can take one of the following sub-elements:

  1. <EmptyWorldObject />
  2. <LibraryObject>
  3. <Container>

 

Optionally you can use the following sub-element:

  1. <Overridable>

 

<SimPropBase> has the following attributes:

 

Attribute Description Type Required
instanceId The GUID used to identify this instance of the element. You can find more information on GUID's here: GUIDs String Yes
BaseType String No
Title String No

 

 

<EmptyWorldObject />

This element is used to define the "pivot" point for a SimPropContainer. It is used when you do not wish to use a Scenery or SimObj for the pivot (root), and only requires a single attribute:

 

Attribute Description Type Required
instanceId The GUID used to identify this instance of the element. You can find more information on GUID's here: GUIDs String Yes

 

 

<Overridable>

 

 

 

 

 

<SimPropAttachs>

This is a sub-element of <SimPropContainer> and is used as a "container" element to hold all the different objects that will be used in the SimPropContainer (except the "pivot" object). This element can take the following sub-element:

  1. <SimPropAttach>

 

This element requires a single attribute:

 

Attribute Description Type Required
instanceId The GUID used to identify this instance of the element. You can find more information on GUID's here: GUIDs String Yes

 

<SimPropAttach>

This is a sub-element of <SimPropAttachs> and is used to define a single object that is part of the SimPropContainer. It has no elements and can have the following sub-elements:

  1. <Transform>
  2. <LibraryObject>
  3. <Container>
  4. <SimPropContainerInstance>
  5. <ProceduralInstance>
  6. <DecalObject>
  7. <InGameUI>

 

This element requires a single attribute:

 

Attribute Description Type Required
instanceId The GUID used to identify this instance of the element. You can find more information on GUID's here: GUIDs String Yes

 

Each object being defined by this element should have a <Transform> and only one of the available object elements. The element is formatted like this:

<SimPropAttach InstanceId="{C382BACA-32F5-4EFF-88D1-73688CCD7EFC}">
    <Transform InstanceId="{74B0FA51-1172-4D1B-A293-3E813C869215}">
        <AttachedWorldObject>
            <OffsetXYZ>-2.786,1.382,15.162,0.000</OffsetXYZ>
            <Orientation>0.000,0.000,0.000</Orientation>
        </AttachedWorldObject>
    </Transform>
    <LibraryObject InstanceId="{FC686017-FDDF-4E3B-93C8-7A92F9C95723}">
        <MDLGuid>{D644CFFE-3CA0-481F-ADCA-291A1D3B99A5}</MDLGuid>
    </LibraryObject>
</SimPropAttach>

 

<Transform>

This element is used to contain the <AttachedWorldObject> element where the different values required to position and orientate the object are stored. This element requires a single attribute:

 

Attribute Description Type Required
instanceId The GUID used to identify this instance of the element. You can find more information on GUID's here: GUIDs String Yes

 

<AttachedWorldObject>

This is a sub-element of <Transform> and is used to define the spacial representation of the object within the SimPropContainer. It has no elements and can have the following sub-elements:

  1. <OffsetXYZ>
  2. <Orientation>

 

<OffsetXYZ>

This sub-element of <AttachedWorldObject> is used to define the position offset from the x/y/z position of the SimPropContainer "pivot" that the object is being attached to. The element has no attributes and requires 3 float values, separated by a comma, to define the X, Y and Z offsets.

 

<Orientation>

This element is used <AttachedWorldObject> to set the orientation of the attached object. It has no attributes, and requires 3 float values, separated by a comma for pitch, bank and heading (in degrees).

 

 

<LibraryObject>

This is a sub-element of either the <SimPropBase> or <SimPropAttachs> elements and is used to define a single scenery object that is part of the SimPropContainer. It can have the following sub-element:

  1. <MDLGuid>

 

This element requires a single attribute:

 

Attribute Description Type Required
instanceId The GUID used to identify this instance of the element. You can find more information on GUID's here: GUIDs String Yes

 

<MDLGuid>

This is a sub-element of the <LibraryObject> element, and is used to give a GUID to the scenery object instance. This GUID can be used as a reference in other files for missions and scenery. You can find more information on GUID's here: GUIDs

 

 

<Container>

This is a sub-element of either the <SimPropBase> or <SimPropAttachs> elements and is used to define a single SimObj object that is part of the SimPropContainer. It can have the following sub-element:

  1. <ContainerTitle>

 

This element requires a single attribute:

 

Attribute Description Type Required
instanceId The GUID used to identify this instance of the element. You can find more information on GUID's here: GUIDs String Yes

 

<ContainerTitle>

This is a sub-element of the <Container> element, and is used to give the container title of the SimObj object instance.

 

 

<SimPropContainerInstance>

This is a sub-element of either the <SimPropBase> or <SimPropAttachs> elements and is used to define a different SimPropContainer to be used within the one being defined. It can have the following sub-element:

  1. <ContainerTitle>

 

This element requires a single attribute:

 

Attribute Description Type Required
instanceId The GUID used to identify this instance of the element. You can find more information on GUID's here: GUIDs String Yes

 

 

<ProceduralInstance>

 

 

 

<DecalObject>

 

 

 

<InGameUI>

 

 

 

Related Topics

  1. SimPropContainer Objects
  2. The Scenery Editor
  3. Scenery Objects
  4. Modeling_SimProps