https://wiki.frictionalgames.com/page?action=history&feed=atom&title=HPL3%2FAmnesia%3A_Rebirth%2FScripting%2FcLuxModHandler HPL3/Amnesia: Rebirth/Scripting/cLuxModHandler - Revision history 2026-05-02T03:52:14Z Revision history for this page on the wiki MediaWiki 1.34.2 https://wiki.frictionalgames.com/page?title=HPL3/Amnesia:_Rebirth/Scripting/cLuxModHandler&diff=5787&oldid=prev Abion47: Created page with "{{ScriptingStub}} 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. ==Fu..." 2020-11-15T21:33:55Z <p>Created page with &quot;{{ScriptingStub}} 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. ==Fu...&quot;</p> <p><b>New page</b></p><div>{{ScriptingStub}}<br /> <br /> Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!<br /> <br /> ==Fields==<br /> cLuxModHandler has no public fields.<br /> <br /> ==Functions==<br /> {{CodeDocSummaryTop|Return Type|Function And Description}}<br /> {{CodeDocSummaryItem|bool|[[#CleanUpListing|CleanUpListing]]()|}}<br /> {{CodeDocSummaryItem|float|[[#GetDownloadProgress|GetDownloadProgress]](uint32 alModID)|}}<br /> {{CodeDocSummaryItem|bool|[[#GetIsRunningMod|GetIsRunningMod]]()|}}<br /> {{CodeDocSummaryItem|bool|[[#GetModDownloadDetails|GetModDownloadDetails]](uint32 alModID, [[../eLuxModContentType|eLuxModContentType]] &amp;out aType, [[../tString|tString]] &amp;out asOutModName)|}}<br /> {{CodeDocSummaryItem|bool|[[#GetModEntriesByName|GetModEntriesByName]]([[../eLuxModContentType|eLuxModContentType]] aType, [[../array|array]]&lt;uint32&gt; avOutModIDs, [[../array|array]]&lt;[[../tString|tString]]&gt; avOutModNames, [[../array|array]]&lt;[[../tWString|tWString]]&gt; avOutModAuthors, [[../array|array]]&lt;[[../tString|tString]]&gt; avOutModPics, bool abAscending &lt;nowiki&gt;=&lt;/nowiki&gt; true)|}}<br /> {{CodeDocSummaryItem|[[../tWString|tWString]]|[[#GetModLocatorFromModID|GetModLocatorFromModID]](uint32 alModID)|}}<br /> {{CodeDocSummaryItem|uint32|[[#GetProviderIndexFromModID|GetProviderIndexFromModID]](uint32 alModID)|}}<br /> {{CodeDocSummaryItem|bool|[[#GetProviderIsAvailable|GetProviderIsAvailable]](const [[../tString|tString]] &amp;in asName)|}}<br /> {{CodeDocSummaryItem|[[../tString|tString]]|[[#GetProviderName|GetProviderName]](uint32 alIndex)|}}<br /> {{CodeDocSummaryItem|uint32|[[#GetProviderNum|GetProviderNum]]()|}}<br /> {{CodeDocSummaryItem|bool|[[#HasNextListEvent|HasNextListEvent]]()|}}<br /> {{CodeDocSummaryItem|bool|[[#LaunchMod|LaunchMod]](uint32 alModID)|}}<br /> {{CodeDocSummaryItem|void|[[#NextListEvent|NextListEvent]]([[../eLuxModEntryListEventType|eLuxModEntryListEventType]] &amp;out aOutType, [[../array|array]]&lt;uint32&gt; avOutEntryIDs)|}}<br /> {{CodeDocSummaryItem|bool|[[#OpenContentAcquisitionWindow|OpenContentAcquisitionWindow]](const [[../tString|tString]] &amp;in asProvider)|}}<br /> {{CodeDocSummaryItem|bool|[[#PrepareListing|PrepareListing]]()|}}<br /> {{CodeDocSummaryItem|bool|[[#UninstallModEntry|UninstallModEntry]](uint32 alModID)|}}<br /> {{CodeDocSummaryBottom}}<br /> <br /> ==Details==<br /> {{CodeDocDetailTop|CleanUpListing}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;bool CleanUpListing()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|bool|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetDownloadProgress}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;float GetDownloadProgress(uint32 alModID)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|alModID|uint32|}}<br /> {{CodeDocDetailReturn|float|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetIsRunningMod}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;bool GetIsRunningMod()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|bool|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetModDownloadDetails}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;bool GetModDownloadDetails(uint32 alModID,<br /> eLuxModContentType &amp;out aType,<br /> tString &amp;out asOutModName)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|alModID|uint32|}}<br /> {{CodeDocDetailParam|aType|[[../eLuxModContentType|eLuxModContentType]]|}}<br /> {{CodeDocDetailParam|asOutModName|[[../tString|tString]]|}}<br /> {{CodeDocDetailReturn|bool|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetModEntriesByName}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;bool GetModEntriesByName(eLuxModContentType aType,<br /> uint32 avOutModIDs,<br /> tString avOutModNames,<br /> tWString avOutModAuthors,<br /> tString avOutModPics,<br /> bool abAscending = true)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|aType|[[../eLuxModContentType|eLuxModContentType]]|}}<br /> {{CodeDocDetailParam|avOutModIDs|uint32|}}<br /> {{CodeDocDetailParam|avOutModNames|[[../tString|tString]]|}}<br /> {{CodeDocDetailParam|avOutModAuthors|[[../tWString|tWString]]|}}<br /> {{CodeDocDetailParam|avOutModPics|[[../tString|tString]]|}}<br /> {{CodeDocDetailParam|abAscending|bool|}}<br /> {{CodeDocDetailReturn|bool|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetModLocatorFromModID}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;const tWString&amp; GetModLocatorFromModID(uint32 alModID)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|alModID|uint32|}}<br /> {{CodeDocDetailReturn|const tWString&amp;|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetProviderIndexFromModID}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;uint32 GetProviderIndexFromModID(uint32 alModID)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|alModID|uint32|}}<br /> {{CodeDocDetailReturn|uint32|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetProviderIsAvailable}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;bool GetProviderIsAvailable(const tString &amp;in asName)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|asName|[[../tString|tString]]|}}<br /> {{CodeDocDetailReturn|bool|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetProviderName}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;const tString&amp; GetProviderName(uint32 alIndex)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|alIndex|uint32|}}<br /> {{CodeDocDetailReturn|const tString&amp;|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|GetProviderNum}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;uint32 GetProviderNum()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|uint32|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|HasNextListEvent}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;bool HasNextListEvent()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|bool|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|LaunchMod}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;bool LaunchMod(uint32 alModID)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|alModID|uint32|}}<br /> {{CodeDocDetailReturn|bool|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|NextListEvent}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void NextListEvent(eLuxModEntryListEventType &amp;out aOutType,<br /> uint32 avOutEntryIDs)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|aOutType|[[../eLuxModEntryListEventType|eLuxModEntryListEventType]]|}}<br /> {{CodeDocDetailParam|avOutEntryIDs|uint32|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|OpenContentAcquisitionWindow}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;bool OpenContentAcquisitionWindow(const tString &amp;in asProvider)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|asProvider|[[../tString|tString]]|}}<br /> {{CodeDocDetailReturn|bool|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|PrepareListing}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;bool PrepareListing()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|bool|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|UninstallModEntry}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;bool UninstallModEntry(uint32 alModID)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|alModID|uint32|}}<br /> {{CodeDocDetailReturn|bool|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{ReferencesSection}}<br /> <br /> {{HPL3SOMAScriptingCategories}}</div> Abion47