HPL3/Amnesia: Rebirth/Scripting/cLuxModHandler

Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!

Fields

cLuxModHandler has no public fields.

Functions

Return Type	Function And Description
bool	CleanUpListing()
float	GetDownloadProgress(uint32 alModID)
bool	GetIsRunningMod()
bool	GetModDownloadDetails(uint32 alModID, eLuxModContentType &out aType, tString &out asOutModName)
bool	GetModEntriesByName(eLuxModContentType aType, array<uint32> avOutModIDs, array<tString> avOutModNames, array<tWString> avOutModAuthors, array<tString> avOutModPics, bool abAscending = true)
tWString	GetModLocatorFromModID(uint32 alModID)
uint32	GetProviderIndexFromModID(uint32 alModID)
bool	GetProviderIsAvailable(const tString &in asName)
tString	GetProviderName(uint32 alIndex)
uint32	GetProviderNum()
bool	HasNextListEvent()
bool	LaunchMod(uint32 alModID)
void	NextListEvent(eLuxModEntryListEventType &out aOutType, array<uint32> avOutEntryIDs)
bool	OpenContentAcquisitionWindow(const tString &in asProvider)
bool	PrepareListing()
bool	UninstallModEntry(uint32 alModID)

Details

CleanUpListing

bool CleanUpListing()

Returns:

• bool—

GetDownloadProgress

float GetDownloadProgress(uint32 alModID)

Parameters

• alModID (uint32) —

Returns:

• float—

GetIsRunningMod

bool GetIsRunningMod()

Returns:

• bool—

GetModDownloadDetails

bool GetModDownloadDetails(uint32 alModID,
                           eLuxModContentType &out aType,
                           tString &out asOutModName)

Parameters

• alModID (uint32) —
• aType (eLuxModContentType) —
• asOutModName (tString) —

Returns:

• bool—

GetModEntriesByName

bool GetModEntriesByName(eLuxModContentType aType,
                         uint32 avOutModIDs,
                         tString avOutModNames,
                         tWString avOutModAuthors,
                         tString avOutModPics,
                         bool abAscending = true)

Parameters

• aType (eLuxModContentType) —
• avOutModIDs (uint32) —
• avOutModNames (tString) —
• avOutModAuthors (tWString) —
• avOutModPics (tString) —
• abAscending (bool) —

Returns:

• bool—

GetModLocatorFromModID

const tWString& GetModLocatorFromModID(uint32 alModID)

Parameters

• alModID (uint32) —

Returns:

• const tWString&—

GetProviderIndexFromModID

uint32 GetProviderIndexFromModID(uint32 alModID)

Parameters

• alModID (uint32) —

Returns:

• uint32—

GetProviderIsAvailable

bool GetProviderIsAvailable(const tString &in asName)

Parameters

• asName (tString) —

Returns:

• bool—

GetProviderName

const tString& GetProviderName(uint32 alIndex)

Parameters

• alIndex (uint32) —

Returns:

• const tString&—

GetProviderNum

uint32 GetProviderNum()

Returns:

• uint32—

HasNextListEvent

bool HasNextListEvent()

Returns:

• bool—

LaunchMod

bool LaunchMod(uint32 alModID)

Parameters

• alModID (uint32) —

Returns:

• bool—

NextListEvent

void NextListEvent(eLuxModEntryListEventType &out aOutType,
                   uint32 avOutEntryIDs)

Parameters

• aOutType (eLuxModEntryListEventType) —
• avOutEntryIDs (uint32) —

Returns:

• void

OpenContentAcquisitionWindow

bool OpenContentAcquisitionWindow(const tString &in asProvider)

Parameters

• asProvider (tString) —

Returns:

• bool—

PrepareListing

bool PrepareListing()

Returns:

• bool—

UninstallModEntry

bool UninstallModEntry(uint32 alModID)

Parameters

• alModID (uint32) —

Returns:

• bool—

References

• HPL3/Amnesia: Rebirth/Scripting/Scripting Api ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/Scripting Api/cLux ‎ (← links)

See all references...