Uranium
Application Framework
UM.Resources.Resources Class Reference

Public Member Functions

def getPath
 
def getAllResourcesOfType
 
def getStoragePath
 
def getAllPathsForType
 
def getStoragePathForType
 
def addSearchPath
 
def removeSearchPath
 
def addType
 
def addStorageType
 
def getConfigStoragePath (cls)
 
def getDataStoragePath (cls)
 
def getCacheStoragePath (cls)
 
def getSearchPaths (cls)
 
def removeType
 
def factoryReset (cls)
 
def copyVersionFolder
 
def addExpectedDirNameInData
 

Public Attributes

 ApplicationVersion
 

Static Public Attributes

int Resources = 1
 
int Preferences = 2
 
int Meshes = 3
 
int Shaders = 4
 
int i18n = 5
 
int Images = 6
 
int Themes = 7
 
int DefinitionContainers = 8
 
int InstanceContainers = 9
 
int ContainerStacks = 10
 
int Cache = 11
 
int Plugins = 12
 
int BundledPackages = 13
 
int Texts = 14
 
int UserType = 128
 
string ApplicationIdentifier = "UM"
 
string ApplicationVersion = "unknown"
 

Detailed Description

Class to look up any form of resource used by Uranium or an application using Uranium

Member Function Documentation

◆ factoryReset()

def UM.Resources.Resources.factoryReset (   cls,
  None 
)
Performs a factory reset, compressing the current state of configuration
into an archive and emptying the resource folders.

When calling this function, be sure to quit the application immediately
afterwards, lest the save function write the configuration anew.

◆ getCacheStoragePath()

def UM.Resources.Resources.getCacheStoragePath (   cls,
  str 
)
Gets the cache storage path.

This is where the application stores cache files.

◆ getConfigStoragePath()

def UM.Resources.Resources.getConfigStoragePath (   cls,
  str 
)
Gets the configuration storage path.

This is where the application stores user configuration, such as
preferences.

◆ getDataStoragePath()

def UM.Resources.Resources.getDataStoragePath (   cls,
  str 
)
Gets the data storage path.

This is where the application stores user files, such as profiles.

◆ getSearchPaths()

def UM.Resources.Resources.getSearchPaths (   cls,
  Generator,
  str,
  None,
  None 
)
Gets the search paths for resources.

:return: A sequence of paths where resources might be.

The documentation for this class was generated from the following file: