https://wiki.frictionalgames.com/page?action=history&feed=atom&title=HPL3%2FSOMA%2FScripting%2FScripting_Api%2FcSystem HPL3/SOMA/Scripting/Scripting Api/cSystem - Revision history 2026-04-28T12:03:30Z Revision history for this page on the wiki MediaWiki 1.34.2 https://wiki.frictionalgames.com/page?title=HPL3/SOMA/Scripting/Scripting_Api/cSystem&diff=5027&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! ==Summary== {{CodeDocSummaryTop}} {{CodeDocSummaryIte..." 2020-08-24T20:52:04Z <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! ==Summary== {{CodeDocSummaryTop}} {{CodeDocSummaryIte...&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 /> ==Summary==<br /> {{CodeDocSummaryTop}}<br /> {{CodeDocSummaryItem|bool|[[#cSystem_CloneFile|cSystem_CloneFile]](const [[../../tWString|tWString]] &amp;in asSrcFileName, const [[../../tWString|tWString]] &amp;in asDestFileName, bool abFailIfExists)|}}<br /> {{CodeDocSummaryItem|void|[[#cSystem_CopyTextToClipboard|cSystem_CopyTextToClipboard]](const [[../../tWString|tWString]] &amp;in asText)|}}<br /> {{CodeDocSummaryItem|bool|[[#cSystem_CreateFolder|cSystem_CreateFolder]](const [[../../tWString|tWString]] &amp;in asPath)|}}<br /> {{CodeDocSummaryItem|[[../../cDate|cDate]]|[[#cSystem_FileCreationDate|cSystem_FileCreationDate]](const [[../../tWString|tWString]] &amp;in asFilePath)|}}<br /> {{CodeDocSummaryItem|bool|[[#cSystem_FileExists|cSystem_FileExists]](const [[../../tWString|tWString]] &amp;in asFileName)|}}<br /> {{CodeDocSummaryItem|[[../../cDate|cDate]]|[[#cSystem_FileModifiedDate|cSystem_FileModifiedDate]](const [[../../tWString|tWString]] &amp;in asFilePath)|}}<br /> {{CodeDocSummaryItem|void|[[#cSystem_FindFilesInDir|cSystem_FindFilesInDir]]([[../../array|array]]&lt;[[../../tWString|tWString]]&gt; &amp;inout avStrings, const [[../../tWString|tWString]] &amp;in asDir, const [[../../tWString|tWString]] &amp;in asMask, bool abAddHidden)|}}<br /> {{CodeDocSummaryItem|void|[[#cSystem_FindFoldersInDir|cSystem_FindFoldersInDir]]([[../../array|array]]&lt;[[../../tWString|tWString]]&gt; &amp;inout avtStrings, const [[../../tWString|tWString]] &amp;in asDir, bool abAddHidden, bool abAddUpFolder)|}}<br /> {{CodeDocSummaryItem|bool|[[#cSystem_FolderExists|cSystem_FolderExists]](const [[../../tWString|tWString]] &amp;in asPath)|}}<br /> {{CodeDocSummaryItem|uint|[[#cSystem_GetApplicationTime|cSystem_GetApplicationTime]]()|}}<br /> {{CodeDocSummaryItem|void|[[#cSystem_GetAvailableVideoDrivers|cSystem_GetAvailableVideoDrivers]]([[../../array|array]]&lt;[[../../tString|tString]]&gt; &amp;inout avDrivers)|}}<br /> {{CodeDocSummaryItem|void|[[#cSystem_GetAvailableVideoModes|cSystem_GetAvailableVideoModes]]([[../../array|array]]&lt;[[../../cVector2l|cVector2l]]&gt; &amp;inout avScreenSizes, [[../../array|array]]&lt;int&gt; &amp;inout avBpps, [[../../array|array]]&lt;int&gt; &amp;inout avMinRefreshRates, int alMinBpp, int alMinRefreshRate, bool abRemoveDuplicates)|}}<br /> {{CodeDocSummaryItem|[[../../cDate|cDate]]|[[#cSystem_GetDate|cSystem_GetDate]]()|}}<br /> {{CodeDocSummaryItem|uint|[[#cSystem_GetFileSize|cSystem_GetFileSize]](const [[../../tWString|tWString]] &amp;in asFileName)|}}<br /> {{CodeDocSummaryItem|[[../../tWString|tWString]]|[[#cSystem_GetFullFilePath|cSystem_GetFullFilePath]](const [[../../tWString|tWString]] &amp;in asFilePath)|}}<br /> {{CodeDocSummaryItem|[[../../tString|tString]]|[[#cSystem_GetPlatformName|cSystem_GetPlatformName]]()|}}<br /> {{CodeDocSummaryItem|uint|[[#cSystem_GetSystemAvailableDrives|cSystem_GetSystemAvailableDrives]]()|}}<br /> {{CodeDocSummaryItem|[[../../tWString|tWString]]|[[#cSystem_GetSystemSpecialPath|cSystem_GetSystemSpecialPath]]([[../../eSystemPath|eSystemPath]] aPathType)|}}<br /> {{CodeDocSummaryItem|[[../../tWString|tWString]]|[[#cSystem_GetWorkingDir|cSystem_GetWorkingDir]]()|}}<br /> {{CodeDocSummaryItem|bool|[[#cSystem_HasWindowFocus|cSystem_HasWindowFocus]](const [[../../tWString|tWString]] &amp;in asWindowCaption)|}}<br /> {{CodeDocSummaryItem|[[../../tWString|tWString]]|[[#cSystem_LoadTextFromClipboard|cSystem_LoadTextFromClipboard]]()|}}<br /> {{CodeDocSummaryItem|void|[[#cSystem_ProfileEnd|cSystem_ProfileEnd]](const [[../../tString|tString]] &amp;in asName)|}}<br /> {{CodeDocSummaryItem|void|[[#cSystem_ProfileStart|cSystem_ProfileStart]](const [[../../tString|tString]] &amp;in asName)|}}<br /> {{CodeDocSummaryItem|void|[[#cSystem_RemoveFile|cSystem_RemoveFile]](const [[../../tWString|tWString]] &amp;in asFileName)|}}<br /> {{CodeDocSummaryItem|bool|[[#cSystem_RemoveFolder|cSystem_RemoveFolder]](const [[../../tWString|tWString]] &amp;in asPath, bool abDeleteAllFiles, bool abDeleteAllSubFolders)|}}<br /> {{CodeDocSummaryItem|void|[[#cSystem_Sleep|cSystem_Sleep]](uint alMilliSecs)|}}<br /> {{CodeDocSummaryItem|void|[[#cSystem_Wrapper_CreateMessageBox|cSystem_Wrapper_CreateMessageBox]]([[../../eMsgBoxType|eMsgBoxType]] aType, const [[../../tWString|tWString]] &amp;in asCaption, const [[../../tWString|tWString]] &amp;in asMessage)|}}<br /> {{CodeDocSummaryBottom}}<br /> <br /> ==Function Detail==<br /> {{CodeDocDetailTop|cSystem_CloneFile}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;bool cSystem_CloneFile(const tWString &amp;in asSrcFileName,<br /> const tWString &amp;in asDestFileName,<br /> bool abFailIfExists)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|asSrcFileName|[[../../tWString|tWString]]|}}<br /> {{CodeDocDetailParam|asDestFileName|[[../../tWString|tWString]]|}}<br /> {{CodeDocDetailParam|abFailIfExists|bool|}}<br /> {{CodeDocDetailReturn|bool|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|cSystem_CopyTextToClipboard}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void cSystem_CopyTextToClipboard(const tWString &amp;in asText)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|asText|[[../../tWString|tWString]]|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|cSystem_CreateFolder}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;bool cSystem_CreateFolder(const tWString &amp;in asPath)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|asPath|[[../../tWString|tWString]]|}}<br /> {{CodeDocDetailReturn|bool|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|cSystem_FileCreationDate}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;cDate cSystem_FileCreationDate(const tWString &amp;in asFilePath)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|asFilePath|[[../../tWString|tWString]]|}}<br /> {{CodeDocDetailReturn|cDate|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|cSystem_FileExists}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;bool cSystem_FileExists(const tWString &amp;in asFileName)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|asFileName|[[../../tWString|tWString]]|}}<br /> {{CodeDocDetailReturn|bool|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|cSystem_FileModifiedDate}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;cDate cSystem_FileModifiedDate(const tWString &amp;in asFilePath)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|asFilePath|[[../../tWString|tWString]]|}}<br /> {{CodeDocDetailReturn|cDate|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|cSystem_FindFilesInDir}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void cSystem_FindFilesInDir(tWString &amp;inout avStrings,<br /> const tWString &amp;in asDir,<br /> const tWString &amp;in asMask,<br /> bool abAddHidden)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|avStrings|[[../../tWString|tWString]]|}}<br /> {{CodeDocDetailParam|asDir|[[../../tWString|tWString]]|}}<br /> {{CodeDocDetailParam|asMask|[[../../tWString|tWString]]|}}<br /> {{CodeDocDetailParam|abAddHidden|bool|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|cSystem_FindFoldersInDir}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void cSystem_FindFoldersInDir(tWString &amp;inout avtStrings,<br /> const tWString &amp;in asDir,<br /> bool abAddHidden,<br /> bool abAddUpFolder)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|avtStrings|[[../../tWString|tWString]]|}}<br /> {{CodeDocDetailParam|asDir|[[../../tWString|tWString]]|}}<br /> {{CodeDocDetailParam|abAddHidden|bool|}}<br /> {{CodeDocDetailParam|abAddUpFolder|bool|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|cSystem_FolderExists}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;bool cSystem_FolderExists(const tWString &amp;in asPath)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|asPath|[[../../tWString|tWString]]|}}<br /> {{CodeDocDetailReturn|bool|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|cSystem_GetApplicationTime}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;uint cSystem_GetApplicationTime()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|uint|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|cSystem_GetAvailableVideoDrivers}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void cSystem_GetAvailableVideoDrivers(tString &amp;inout avDrivers)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|avDrivers|[[../../tString|tString]]|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|cSystem_GetAvailableVideoModes}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void cSystem_GetAvailableVideoModes(cVector2l &amp;inout avScreenSizes,<br /> int &amp;inout avBpps,<br /> int &amp;inout avMinRefreshRates,<br /> int alMinBpp,<br /> int alMinRefreshRate,<br /> bool abRemoveDuplicates)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|avScreenSizes|[[../../cVector2l|cVector2l]]|}}<br /> {{CodeDocDetailParam|avBpps|int|}}<br /> {{CodeDocDetailParam|avMinRefreshRates|int|}}<br /> {{CodeDocDetailParam|alMinBpp|int|}}<br /> {{CodeDocDetailParam|alMinRefreshRate|int|}}<br /> {{CodeDocDetailParam|abRemoveDuplicates|bool|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|cSystem_GetDate}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;cDate cSystem_GetDate()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|cDate|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|cSystem_GetFileSize}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;uint cSystem_GetFileSize(const tWString &amp;in asFileName)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|asFileName|[[../../tWString|tWString]]|}}<br /> {{CodeDocDetailReturn|uint|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|cSystem_GetFullFilePath}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;tWString cSystem_GetFullFilePath(const tWString &amp;in asFilePath)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|asFilePath|[[../../tWString|tWString]]|}}<br /> {{CodeDocDetailReturn|tWString|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|cSystem_GetPlatformName}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;const tString&amp; cSystem_GetPlatformName()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|const tString&amp;|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|cSystem_GetSystemAvailableDrives}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;uint cSystem_GetSystemAvailableDrives()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|uint|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|cSystem_GetSystemSpecialPath}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;tWString cSystem_GetSystemSpecialPath(eSystemPath aPathType)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|aPathType|[[../../eSystemPath|eSystemPath]]|}}<br /> {{CodeDocDetailReturn|tWString|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|cSystem_GetWorkingDir}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;tWString cSystem_GetWorkingDir()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|tWString|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|cSystem_HasWindowFocus}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;bool cSystem_HasWindowFocus(const tWString &amp;in asWindowCaption)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|asWindowCaption|[[../../tWString|tWString]]|}}<br /> {{CodeDocDetailReturn|bool|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|cSystem_LoadTextFromClipboard}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;tWString cSystem_LoadTextFromClipboard()&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailReturn|tWString|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|cSystem_ProfileEnd}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void cSystem_ProfileEnd(const tString &amp;in asName)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|asName|[[../../tString|tString]]|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|cSystem_ProfileStart}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void cSystem_ProfileStart(const tString &amp;in asName)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|asName|[[../../tString|tString]]|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|cSystem_RemoveFile}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void cSystem_RemoveFile(const tWString &amp;in asFileName)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|asFileName|[[../../tWString|tWString]]|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|cSystem_RemoveFolder}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;bool cSystem_RemoveFolder(const tWString &amp;in asPath,<br /> bool abDeleteAllFiles,<br /> bool abDeleteAllSubFolders)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|asPath|[[../../tWString|tWString]]|}}<br /> {{CodeDocDetailParam|abDeleteAllFiles|bool|}}<br /> {{CodeDocDetailParam|abDeleteAllSubFolders|bool|}}<br /> {{CodeDocDetailReturn|bool|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|cSystem_Sleep}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void cSystem_Sleep(uint alMilliSecs)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|alMilliSecs|uint|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}<br /> <br /> {{CodeDocDetailTop|cSystem_Wrapper_CreateMessageBox}}<br /> &lt;syntaxhighlight lang=&quot;c++&quot;&gt;void cSystem_Wrapper_CreateMessageBox(eMsgBoxType aType,<br /> const tWString &amp;in asCaption,<br /> const tWString &amp;in asMessage)&lt;/syntaxhighlight&gt;<br /> {{CodeDocDetailBody|}}<br /> {{CodeDocDetailParamStart}}<br /> {{CodeDocDetailParam|aType|[[../../eMsgBoxType|eMsgBoxType]]|}}<br /> {{CodeDocDetailParam|asCaption|[[../../tWString|tWString]]|}}<br /> {{CodeDocDetailParam|asMessage|[[../../tWString|tWString]]|}}<br /> {{CodeDocDetailReturn|void|}}<br /> {{CodeDocDetailBottom}}</div> Abion47