There is a change on how we stream UnitLoadContainer and its unit loads. This is so that failing to unstream one unit load will not cause the entire UnitLoadContainer to fail to unstream.

UnitLoadDialog Redesign Changes

In 15.5 Minor we introduced a new UnitLoadDialog design while still retaining all the logic used for the old design. In 16.0 Major we are now removing all the old logic and will only be maintaining the new design. If you would like to maintain the old design in your extension, you will need to copy over the removed interfaces and logic into your dialog class.

The following fields and methods were only used for the old design and have been removed:

public class UnitLoadDialog extends DialogWindow {
    //Fields.
    public TreeView userRegisteredTree;
    public DropDownTreeView systemRegisteredTree;

    // Methods.
    extend public SubWindow buildAddTemplateWin(Window parent) {
    extend public void buildUserUnitLoadWin(Window sub, Window templateInsert) {
    extend public void buildApplyButtons() {
    extend public pointI paneMargin() {
    extend public void updateUnitLoadSelectorWin() {
    extend public void updatePreviewWin() {
    extend public void updatePropsWin() {
    extend public void updatePanes() {
    extend public void addSelectedTemplateToUserRegistry(bool refresh) {
    extend public str propsLabel(UnitLoad unitLoad) {
    extend public TreeViewItem getSelectedSystemUnitLoad() {
}

The following fields and methods were temporarily added in 15.5 Minor to support the new design without removing the old design. They have been removed or modified (renamed) now that the old design is no longer supported:

public class UnitLoadDialog extends DialogWindow {
    //Fields.
    Removed: public bool useV2;

    // Methods.
    Removed: public constructor(bool useV2, Window parent=null, pointI pos=(-1, -1)) {

    Removed: extend public void buildUnitLoadSelectorWin2() {
    Replacement: extend public void buildUnitLoadSelectorWin() {

    Removed: extend public void buildPropertiesWin2() {
    Replacement: extend public void buildPropertiesWin() {
    
    Removed: extend public void buildPreviewWin2() {
    Replacement: extend public void buildPreviewWin() {

    Removed: extend public void renameUnitLoadItem(UnitLoadTreeViewItem2 item, str newName) {
    Replacement: extend public void renameUnitLoadItem(UnitLoadTreeViewItem item, str newName) {
    
    Removed: extend public UnitLoadTreeViewItem2 getSelectedUnitLoadTVI() {
    Replacement: extend public UnitLoadTreeViewItem getSelectedUnitLoadTVI() {

The logic of the following methods in UnitLoadDialog have been modified to fit the new design. We have removed the logic used for the old design.

public class UnitLoadDialog extends DialogWindow {
    extend public void build() {
    extend public void buildUnitLoadSelectorWin() {
    extend public void buildPropertiesWin() {
    extend public void buildPreviewWin() {
    extend public void unitLoadSelectionChanged() {
    public void rebuild() {
    extend public void populatePropsWindow(UnitLoad mtbh) {
    extend public void removeProps() {
    extend public void createPropsUI(UnitLoad mtbh) {
    extend public void animApplyCallback() {
    extend public void applyAllCallback(UnitLoad[] applyUnitLoads) {
    extend public void afterPropertyChanged(CoreProperty property, Object oldValue) {
    extend public void clearModifiedUnitLoads(str->UnitLoad newLoads=null) {
    extend public UnitLoad getSelectedUserUnitLoad(bool actual=false) {
    extend public bool selectUserUnitLoad(UnitLoad mtbh) {
    extend public void validateUserUnitLoadsInUse() {
}

Removed the temporary function introduced in 15.5 Minor to choose between using the old or new dialog design.

Removed:
/**
 * Temporary interface to useV2 dialog. FIXME 16.0 remove
 */
public void showUnitLoadDialog(bool useV2, bool closeIfValid=false,
                               UnitLoad selectUnitLoad=null) {

Replacement:
/**
 * Show the current Material to be Handled dialog or 
 *  create a new one and show that.
 */
public void showUnitLoadDialog(bool closeIfValid=false,
                               UnitLoad selectUnitLoad=null) {

Removed the following globals:

Removed: public pointI unitLoadGetLastDialogPos() : deprecated { return lastDialogPos; } 
Removed: public const str cUnitLoadDialogTreeKey = "mhmtbhDialogTree";

The class UnitLoadTreeViewItem2 has been removed and the current state of UnitLoadTreeViewItem is now identical to UnitLoadTreeViewItem2 in 15.5 Minor.

Removed:
/**
 * Unit load tree view item.
 * FIXME 16.0 Rename to UnitLoadTreeViewItem.
 */
public class UnitLoadTreeViewItem2 extends TreeViewItem : inherit constructors {

Some other details to be mentioned:

1. When using the new design, refer to registeredUnitLoadTV instead for the list of unit loads in the drawing.

public class UnitLoadDialog extends DialogWindow {
    Old: public TreeView userRegisteredTree;
    New: public UnitLoadDropDownTreeView registeredUnitLoadTV;
}

2. The feature of adding new unit loads objects into the drawing has been modified. systemRegisteredTree is not used in the new design and has been replaced with a new dialog UnitLoadTemplateSelectorDialog.

public class UnitLoadDialog extends DialogWindow {
    Old: public DropDownTreeView systemRegisteredTree;
    New:
    /**
     * Open unit load template selector dialog.
     */
    extend public void openTemplateSelectorDialog() {
        UnitLoadTemplateSelectorDialog(this);
    }


    Old: extend public void addSelectedTemplateToUserRegistry(bool refresh) {
    New: extend public void addSelectedTemplateToUserRegistry(UnitLoad ul, UnitLoadGroup grp) {
}

3. We have moved the responsibility of duplicating/renaming/removing unit loads from UnitLoadTreeViewItem into UnitLoadDialog for the new design. If you have extended UnitLoadTreeViewItem and modified these features, considering extending these methods in your UnitLoadDialog class.

public class UnitLoadDialog extends DialogWindow {
    // Methods.
    extend public bool allowModifyUnitLoad() {
    extend public bool allowRemoveUnitLoad() {
    extend public void openRenamePopup() {
    extend public void renameUnitLoadItem(UnitLoadTreeViewItem item, str newName) {
    extend public void duplicateUnitLoad() {
    extend public void removeUnitLoad() {
    extend public int promptUserRemoveUnitLoad() {
}

This class has been greatly simplified. We have removed the custom draw logic, ability to drag and reposition UnitLoadTreeViewItem objects in the TreeView, and the custom drawn buttons used to rename/copy/remove the UnitLoadTreeViewItem object. Below are the removed fields and methods in UnitLoadTreeViewItem.

public class UnitLoadTreeViewItem extends TreeViewItem : inherit constructors {
    // Fields.
    public rectI editButtonRect;
    public rectI cpyButtonRect;
    public rectI rmButtonRect;
    public byte over = 0;

    // Methods.
    extend public void drawColoredRect(PixelDevice c, rectI r, rectI clipRect, treeViewItemState state, treeViewSelectionStyle style) {
    extend public void drawMainArrow(PixelDevice d, rectI r, rectI clipRect) {
    extend public int btnMult(str btnName) {
    extend public bool allowModify() {
    extend public bool allowRemove() {
    extend public rectI drawBtn(str btnK, Image img, PixelDevice d, rectI r, rectI clipRect) {
    extend public rectI drawBtn(str btnK, Image img, PixelDevice d, rectI r, rectI clipRect, bool disable) {
    extend public pointI getBtnPos(str btnK, Image img, rectI r) {
    extend public Brush backgroundBrush(treeViewItemState state) {
    extend public bool showSelectedAsWhite(treeViewItemState state, treeViewSelectionStyle style) {
    extend public ScrollBar vScrollBar(bool ifVisible=false) {
    extend public void updateApplyButtons(TreeView tv) {
    extend public void openEditNamePopup(TreeView tv) {
    extend public void editName(str newName, TreeView tv) {
    extend public void copyUnitLoadDown(TreeView tv) {
    extend public void removeUnitLoad(TreeView tv) {
    extend public void updateTreeView(TreeView tv) {
    extend public bool isMainSelection() {
    extend public bool isMultiSelect() {

UnitLoadContainer Changes

Instead of saving UnitLoadContainer in world's auxillary, now we save it in world's cache instead. This is because we dont want to stream UnitLoadContainer together with the world.

Old:
    public UserUnitLoadContainer userUnitLoadContainer(World w=null) {
        if (!w or w.nonDrawing) w = mainWorld(selectWorldIfNull=false);
        if (!w) return null;
        UserUnitLoadContainer res = w.getAuxillaryObject(cUnitLoadContainer).UserUnitLoadContainer;

        if (!res) {
            res = UserUnitLoadContainer();
            w.putAuxillaryObject(cUnitLoadContainer, res);
        ...

New:
    public UserUnitLoadContainer userUnitLoadContainer(World w=null) {
        if (!w or w.nonDrawing) w = mainWorld(selectWorldIfNull=false);
        if (!w) return null;

        // handle old drawing - old way of keeping contianer
        if (?UserUnitLoadContainer cont = w.getAuxillaryObject(cUnitLoadContainer)) {
            w.putCached(cUnitLoadContainer, cont);
            w.removeAuxillaryObject(cUnitLoadContainer);
        }

        UserUnitLoadContainer res = w.getCached(cUnitLoadContainer).UserUnitLoadContainer;

        if (!res) {
            res = UserUnitLoadContainer();
            w.putCached(cUnitLoadContainer, res);
        ...

Hooks added - new way of streaming unit loads

Since now we dont stream UnitLoadContainer anymore, we need to stream the unit loads inside the container individually in the world. We put the unit loads into auxillary during saveWorldHooks. Then we remove them in postSaveWorldHooks so that we dont have double instances of the unit loads in auxillary and container.

New: 
    /**
    * Append individual uls to aux.
    */
    package void putUlOnAuxHook(World world, userSaveAction action) {
        for (ul in userUnitLoadContainer(world).unitLoads) {
        world.putAuxillaryObject(cUnitLoadGrpsKey#";"#ul.gid.hex, ul);
        }
    }


    /**
    * Remove uls from aux.
    */
    package void removeUlFromAuxHook(World world, userSaveAction action) {
        for (ul in userUnitLoadContainer(world).unitLoads) {
        world.removeAuxillaryObject(cUnitLoadGrpsKey#";"#ul.gid.hex);
        }
    }

The unit loads will then get appended back to the container during earlyLoadWorldHooks.

New:
    /**
    * Unload individual ul from aux hook.
    */
    package void unloadUlFromAuxHook(World world) {
        UserUnitLoadContainer cont = userUnitLoadContainer(world);
        for (k, o in world.allAuxillary) {
        if (o as MemoryStream) {
            if (k.beginsWith(cUnitLoadGrpsKey)) {
            if (?UnitLoad ul = memoryStreamToObject(o)) {
                str name = userFriendlyUnitLoadName(ul.?name);
                UnitLoad load = findEqualUnitLoad(ul, world);
                if (load) {
                load.gid = ul.gid;
                } else if (!unitLoadFromName(name, world)) {
                cont << ul;
                }
            }
            world.removeAuxillaryObject(k);
            }
        }
        }
    }