Nuclide
Software Development Kit for id Tech
updates.h File Reference

Go to the source code of this file.

Classes

struct  updaterPackage_t
 Data holding Updater Package entries. More...
 

Enumerations

enum  updateType_t {
  UPDATE_NAME , UPDATE_CATEGORY , UPDATE_TITLE , UPDATE_VERSION ,
  UPDATE_DESCRIPTION , UPDATE_LICENSE , UPDATE_AUTHOR , UPDATE_WEBSITE ,
  UPDATE_STATE , UPDATE_ACTION , UPDATE_FILESIZE , UPDATE_PREVIEWIMAGE ,
  UPDATE_STATUSSTRING , UPDATE_DLPERCENTAGE
}
 Different options you can pass to Updates_GetInfo() to retrieve details about a given Update entry. More...
 
enum  updateState_t {
  UPDATESTATE_NONE , UPDATESTATE_DISABLED , UPDATESTATE_ENABLED , UPDATESTATE_CORRUPT ,
  UPDATESTATE_PENDING
}
 Return values from passing UPDATE_STATE to Updates_GetInfo() More...
 
enum  updateAction_t {
  UPDATEACTION_NONE , UPDATEACTION_INSTALL , UPDATEACTION_REINSTALL , UPDATEACTION_UNINSTALL ,
  UPDATEACTION_AUTOINSTALL , UPDATEACTION_DISABLE , UPDATEACTION_RETAIN
}
 Return values from passing UPDATE_ACTION to Updates_GetInfo() More...
 
enum  updaterStatus_t { UPDATER_NONE , UPDATER_UNAVAILABLE , UPDATER_PENDING , UPDATER_INITIALIZED }
 These are the possible return values from Updates_GetUpdaterStatus(). More...
 

Functions

void Updates_Init (void)
 Call this in order to contact the update server and fill the list of updates. More...
 
updaterStatus_t Updates_GetUpdaterStatus (void)
 Retrieve the status of the updater. More...
 
int Updates_GetPackageCount (void)
 Returns the total amount of updates available for the currently running game. More...
 
__variant Updates_GetInfo (int, updateType_t)
 Query a package (by ID) for its various info fields. More...
 
bool Updates_Available (void)
 Returns if our current game has updates available for any installed packages. More...
 
bool Updates_Toggle (int)
 Toggle the installation/disabling of an update. More...
 
bool Updates_Install (int)
 Mark an update as pending installion. More...
 
bool Updates_Remove (int)
 Mark an update as pending deletion. More...
 
bool Updates_Destroy (int)
 Mark an update as pending uninstallation. More...
 
bool Updates_ApplyPendingChanges (void)
 Apply all pending changes to packages. More...