Package mekhq

Class MHQStaticDirectoryManager

java.lang.Object
megamek.client.ui.tileset.MMStaticDirectoryManager
mekhq.MHQStaticDirectoryManager
public class MHQStaticDirectoryManager extends megamek.client.ui.tileset.MMStaticDirectoryManager

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    MHQStaticDirectoryManager()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static megamek.common.util.fileUtils.AbstractDirectory
    getAwardIcons()
    Returns an AbstractDirectory object containing all award icon filenames found in MekHQ's award icon folder.
    static megamek.common.util.fileUtils.AbstractDirectory
    getForceIcons()
    Returns an AbstractDirectory object containing all force icon filenames found in MekHQ's force icon folder.
    static megamek.common.util.fileUtils.AbstractDirectory
    getStorySplash()
    Returns an AbstractDirectory object containing all story icon filenames found in MekHQ's story arc icon folder.
    static megamek.common.util.fileUtils.AbstractDirectory
    getUserStoryPortraits()
    Returns an AbstractDirectory object containing all story portrait filenames found in the user's story arc portraits folder.
    static megamek.common.util.fileUtils.AbstractDirectory
    getUserStorySplash()
    Returns an AbstractDirectory object containing all story arc image filenames found in the user's story arc folder.
    static void
    initialize()
    This initializes all the directories under this manager
    static void
    initializeUserStoryPortraits(String path)
    Parses the user's Story Arc portraits directory when first called or when it was refreshed
    static void
    initializeUserStorySplash(String path)
    Parses the user's Story Arc story arcs directory when first called or when it was refreshed
    static megamek.common.util.fileUtils.AbstractDirectory
    refreshAwardIcons()
    Re-reads MekHQ's award icon folder and returns the updated AbstractDirectory object.
    static megamek.common.util.fileUtils.AbstractDirectory
    refreshForceIcons()
    Re-reads MekHQ's force icon folder and returns the updated AbstractDirectory object.
    static megamek.common.util.fileUtils.AbstractDirectory
    refreshStorySplash()
    Re-reads MekHQ's story icon folder and returns the updated AbstractDirectory object.

    Methods inherited from class megamek.client.ui.tileset.MMStaticDirectoryManager

    getCamouflage, getMekTileset, getPortraits, refreshCamouflageDirectory, refreshMekTileset, refreshPortraitDirectory

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • MHQStaticDirectoryManager

      protected MHQStaticDirectoryManager()

  • Method Details

    • initialize

      public static void initialize()
      This initializes all the directories under this manager

    • initializeUserStoryPortraits

      public static void initializeUserStoryPortraits(String path)
      Parses the user's Story Arc portraits directory when first called or when it was refreshed

    • initializeUserStorySplash

      public static void initializeUserStorySplash(String path)
      Parses the user's Story Arc story arcs directory when first called or when it was refreshed

    • getForceIcons

      @Nullable public static megamek.common.util.fileUtils.AbstractDirectory getForceIcons()
      Returns an AbstractDirectory object containing all force icon filenames found in MekHQ's force icon folder.
      Returns:
      an AbstractDirectory object with the force icon folders and filenames. May be null if the directory cannot be parsed.

    • getAwardIcons

      @Nullable public static megamek.common.util.fileUtils.AbstractDirectory getAwardIcons()
      Returns an AbstractDirectory object containing all award icon filenames found in MekHQ's award icon folder.
      Returns:
      an AbstractDirectory object with the award icon folders and filenames. May be null if the directory cannot be parsed.

    • getStorySplash

      @Nullable public static megamek.common.util.fileUtils.AbstractDirectory getStorySplash()
      Returns an AbstractDirectory object containing all story icon filenames found in MekHQ's story arc icon folder.
      Returns:
      an AbstractDirectory object with the story icon folders and filenames. May be null if the directory cannot be parsed.

    • getUserStoryPortraits

      @Nullable public static megamek.common.util.fileUtils.AbstractDirectory getUserStoryPortraits()
      Returns an AbstractDirectory object containing all story portrait filenames found in the user's story arc portraits folder.
      Returns:
      an AbstractDirectory object with the story portrait folders and filenames. May be null if the directory cannot be parsed.

    • getUserStorySplash

      @Nullable public static megamek.common.util.fileUtils.AbstractDirectory getUserStorySplash()
      Returns an AbstractDirectory object containing all story arc image filenames found in the user's story arc folder.
      Returns:
      an AbstractDirectory object with the story portrait folders and filenames. May be null if the directory cannot be parsed.

    • refreshForceIcons

      public static megamek.common.util.fileUtils.AbstractDirectory refreshForceIcons()
      Re-reads MekHQ's force icon folder and returns the updated AbstractDirectory object. This will update the AbstractDirectory object with changes to the force icons (like added image files and folders) while MekHQ is running.
      See Also:

    • refreshAwardIcons

      public static megamek.common.util.fileUtils.AbstractDirectory refreshAwardIcons()
      Re-reads MekHQ's award icon folder and returns the updated AbstractDirectory object. This will update the AbstractDirectory object with changes to the award icons (like added image files and folders) while MekHQ is running.
      See Also:

    • refreshStorySplash

      public static megamek.common.util.fileUtils.AbstractDirectory refreshStorySplash()
      Re-reads MekHQ's story icon folder and returns the updated AbstractDirectory object. This will update the AbstractDirectory object with changes to the story icons (like added image files and folders) while MekHQ is running.
      See Also: