Package mekhq
Class MHQStaticDirectoryManager
java.lang.Object
megamek.client.ui.swing.tileset.MMStaticDirectoryManager
mekhq.MHQStaticDirectoryManager
public class MHQStaticDirectoryManager
extends megamek.client.ui.swing.tileset.MMStaticDirectoryManager
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic megamek.common.util.fileUtils.AbstractDirectory
Returns an AbstractDirectory object containing all award icon filenames found in MekHQ's award icon folder.static megamek.common.util.fileUtils.AbstractDirectory
Returns an AbstractDirectory object containing all force icon filenames found in MekHQ's force icon folder.static megamek.common.util.fileUtils.AbstractDirectory
Returns an AbstractDirectory object containing all story icon filenames found in MekHQ's storyarc icon folder.static megamek.common.util.fileUtils.AbstractDirectory
Returns an AbstractDirectory object containing all story portrait filenames found in the user's storyarc portraits folder.static megamek.common.util.fileUtils.AbstractDirectory
Returns an AbstractDirectory object containing all story arc image filenames found in the user's storyarc folder.static void
This initializes all of the directories under this managerstatic void
Parses the user's Story Arc portraits directory when first called or when it was refreshedstatic void
Parses the user's Story Arc storyarcs directory when first called or when it was refreshedstatic megamek.common.util.fileUtils.AbstractDirectory
Re-reads MekHQ's award icon folder and returns the updated AbstractDirectory object.static megamek.common.util.fileUtils.AbstractDirectory
Re-reads MekHQ's force icon folder and returns the updated AbstractDirectory object.static megamek.common.util.fileUtils.AbstractDirectory
Re-reads MekHQ's story icon folder and returns the updated AbstractDirectory object.Methods inherited from class megamek.client.ui.swing.tileset.MMStaticDirectoryManager
getCamouflage, getMekTileset, getPortraits, refreshCamouflageDirectory, refreshMekTileset, refreshPortraitDirectory
-
Constructor Details
-
MHQStaticDirectoryManager
protected MHQStaticDirectoryManager()
-
-
Method Details
-
initialize
public static void initialize()This initializes all of the directories under this manager -
initializeUserStoryPortraits
Parses the user's Story Arc portraits directory when first called or when it was refreshed -
initializeUserStorySplash
Parses the user's Story Arc storyarcs 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 storyarc 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 storyarc 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 storyarc 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:
-