Members
(constant) SteamPaths
A set of strings representing the Steam configuration files SteamConfig can handle.
Properties:
| Name | Type | Description |
|---|---|---|
all |
String
|
All of the files. Handled specially by load |
appinfo |
String
|
appinfo => /appcache/appinfo.vdf |
config |
String
|
config => /config/config.vdf |
libraryfolders |
String
|
libraryfolders => /steamapps/libraryfolders.vdf |
localconfig |
String
|
localconfig => /userdata/{accountId}/config/localconfig.vdf |
packageinfo |
String
|
packageinfo => /appcache/packageinfo.vdf |
registry |
String
|
registry => ../registry.vdf on Linux, /registry.vdf on Mac or winreg on Windows. |
shortcuts |
String
|
shortcuts => /userdata/{accountId}/config/shortcuts.vdf |
sharedconfig |
String
|
sharedconfig => userdata/{accountId}/7/remote/sharedconfig.vdf |
skins |
String
|
skins => skins/ on Linux or Winows, /Steam.AppBundle/Steam/Contents/MacOS/skins on Mac. |
steamapps |
String
|
steamapps => /steamapps/ |
library |
String
|
library => {aSteamLibraryFolder}/steamapps/ |
- Source:
Methods
afterLoad(sc, name)
Internal function to do some special handling after loading specific files. So far it only handles "libraryfolders" by setting sc.libraries to the list of entries.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
sc |
SteamConfig
|
An instance of SteamConfig. |
name |
String
|
The name of the file that was loaded without the extension (as from SteamPaths. |
getAccountIdFromId64(id64) → {String}
Internal function to get a user's account ID from their SteamID 64.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
id64 |
String
|
The SteamID64 of the user to calculte the Steam3:accountId of. |
Throws:
-
- If cuint.UInt64 has an issue with the data.
- Type
-
Error
Returns:
- Type:
-
String
- The accountId of the user.
(async) loadApps(library) → {Array}
Internal method to load app data from a library folder.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
library |
Path
|
The path to the library to load the appmanifest_###.acf files from. |
Throws:
-
- If there is an error loading the app data.
- Type
-
Error
Returns:
- Type:
-
Array
- The app data as an Array of Objects.
(async) loadSkins(folder) → {Array}
Internal method to load skin names.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
folder |
Path
|
The folder to get the skin names from. |
Throws:
-
- If there is an error loading the skin data.
- Type
-
Error
Returns:
- Type:
-
Array
- The names of the skins as an Array of Strings.
prepareFileNames(names) → {Array}
Internal function to properly organize names array so that user-specific data is loaded last.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
names |
Array
|
The Array of String|Array entries that load was called with. |
Returns:
- Type:
-
Array
- The names Array, after organization.