Constructor
new Workspace(pPath)
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
pPath |
* |
Members
mainAPK :APK
- Source:
Type:
- APK
path
- Source:
Working directory
Methods
_export() → {Stub}
- Source:
To export a Workspace instance to a Stub. It is used when Dexcalibur prepare the data to be save in a flat file.
Returns:
The Stub containing the Workspace instance data.
- Type
- Stub
_import(stub)
- Source:
To import the given Stub instance into the current Workspace. It is used when Dexcalibur want create a context from a save file.
Parameters:
| Name | Type | Description |
|---|---|---|
stub |
Stub | The Stub instance to import |
getNewSavefilePath() → {string}
- Source:
To generate a new timestamped save file path
Returns:
The timestamped save file path
- Type
- string
getPath() → {string}
- Source:
To get the Application working directory
Returns:
The Application worksing directory path
- Type
- string
getProjectCfgPath()
- Source:
getTimestampedFilePath(prefix, suffix) → {string}
- Source:
To generate a new timestamped file path
Parameters:
| Name | Type | Description |
|---|---|---|
prefix |
string | The string part before the timestamp |
suffix |
string | The string part after the timestamp |
Returns:
The timestamped save file path
- Type
- string
getWD() → {string}
- Source:
- Deprecated:
- Yes
To get the Application working directory
Returns:
The Application worksing directory path
- Type
- string
init()
- Source:
To initialize a new Application working directory. It creates a main folder and nested folders. If a folder already exists it will not be overwritten.
isWritable(path) → {boolean}
- Source:
To verifry if the given path is writable. Its use absolute path.
Parameters:
| Name | Type | Description |
|---|---|---|
path |
string | Absolute file path to check |
Returns:
Returns TRUE if the file is writable, else FALSE
- Type
- boolean
mkWDir(dirName)
- Source:
To create a directory into the application working directory.
Parameters:
| Name | Type | Description |
|---|---|---|
dirName |
string | The name of the directory to create |
rmWDir(dirName)
- Source:
To remove the directory with the given name from the application working directory.
Parameters:
| Name | Type | Description |
|---|---|---|
dirName |
string | The name of the directory to remove |