HPL3/SOMA/Scripting/Scripting Api/cSystem

From Frictional Wiki
< HPL3‎ | SOMA‎ | Scripting‎ | Scripting Api
Revision as of 21:52, 24 August 2020 by Abion47 (talk | contribs) (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...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Info icon.png

This page has been automatically generated, but it needs descriptions added to the various fields/functions in order to be complete.

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

Summary

Return Type Function and Description
bool cSystem_CloneFile(const tWString &in asSrcFileName, const tWString &in asDestFileName, bool abFailIfExists)
void cSystem_CopyTextToClipboard(const tWString &in asText)
bool cSystem_CreateFolder(const tWString &in asPath)
cDate cSystem_FileCreationDate(const tWString &in asFilePath)
bool cSystem_FileExists(const tWString &in asFileName)
cDate cSystem_FileModifiedDate(const tWString &in asFilePath)
void cSystem_FindFilesInDir(array<tWString> &inout avStrings, const tWString &in asDir, const tWString &in asMask, bool abAddHidden)
void cSystem_FindFoldersInDir(array<tWString> &inout avtStrings, const tWString &in asDir, bool abAddHidden, bool abAddUpFolder)
bool cSystem_FolderExists(const tWString &in asPath)
uint cSystem_GetApplicationTime()
void cSystem_GetAvailableVideoDrivers(array<tString> &inout avDrivers)
void cSystem_GetAvailableVideoModes(array<cVector2l> &inout avScreenSizes, array<int> &inout avBpps, array<int> &inout avMinRefreshRates, int alMinBpp, int alMinRefreshRate, bool abRemoveDuplicates)
cDate cSystem_GetDate()
uint cSystem_GetFileSize(const tWString &in asFileName)
tWString cSystem_GetFullFilePath(const tWString &in asFilePath)
tString cSystem_GetPlatformName()
uint cSystem_GetSystemAvailableDrives()
tWString cSystem_GetSystemSpecialPath(eSystemPath aPathType)
tWString cSystem_GetWorkingDir()
bool cSystem_HasWindowFocus(const tWString &in asWindowCaption)
tWString cSystem_LoadTextFromClipboard()
void cSystem_ProfileEnd(const tString &in asName)
void cSystem_ProfileStart(const tString &in asName)
void cSystem_RemoveFile(const tWString &in asFileName)
bool cSystem_RemoveFolder(const tWString &in asPath, bool abDeleteAllFiles, bool abDeleteAllSubFolders)
void cSystem_Sleep(uint alMilliSecs)
void cSystem_Wrapper_CreateMessageBox(eMsgBoxType aType, const tWString &in asCaption, const tWString &in asMessage)

Function Detail

cSystem_CloneFile

bool cSystem_CloneFile(const tWString &in asSrcFileName,
                       const tWString &in asDestFileName,
                       bool abFailIfExists)


Parameters

  • asSrcFileName (tWString) —
  • asDestFileName (tWString) —
  • abFailIfExists (bool) —

Returns:

  • bool—

cSystem_CopyTextToClipboard

void cSystem_CopyTextToClipboard(const tWString &in asText)


Parameters

Returns:

  • void

cSystem_CreateFolder

bool cSystem_CreateFolder(const tWString &in asPath)


Parameters

Returns:

  • bool—

cSystem_FileCreationDate

cDate cSystem_FileCreationDate(const tWString &in asFilePath)


Parameters

Returns:

  • cDate—

cSystem_FileExists

bool cSystem_FileExists(const tWString &in asFileName)


Parameters

Returns:

  • bool—

cSystem_FileModifiedDate

cDate cSystem_FileModifiedDate(const tWString &in asFilePath)


Parameters

Returns:

  • cDate—

cSystem_FindFilesInDir

void cSystem_FindFilesInDir(tWString &inout avStrings,
                            const tWString &in asDir,
                            const tWString &in asMask,
                            bool abAddHidden)


Parameters

Returns:

  • void

cSystem_FindFoldersInDir

void cSystem_FindFoldersInDir(tWString &inout avtStrings,
                              const tWString &in asDir,
                              bool abAddHidden,
                              bool abAddUpFolder)


Parameters

  • avtStrings (tWString) —
  • asDir (tWString) —
  • abAddHidden (bool) —
  • abAddUpFolder (bool) —

Returns:

  • void

cSystem_FolderExists

bool cSystem_FolderExists(const tWString &in asPath)


Parameters

Returns:

  • bool—

cSystem_GetApplicationTime

uint cSystem_GetApplicationTime()

Returns:

  • uint—

cSystem_GetAvailableVideoDrivers

void cSystem_GetAvailableVideoDrivers(tString &inout avDrivers)


Parameters

Returns:

  • void

cSystem_GetAvailableVideoModes

void cSystem_GetAvailableVideoModes(cVector2l &inout avScreenSizes,
                                    int &inout avBpps,
                                    int &inout avMinRefreshRates,
                                    int alMinBpp,
                                    int alMinRefreshRate,
                                    bool abRemoveDuplicates)


Parameters

  • avScreenSizes (cVector2l) —
  • avBpps (int) —
  • avMinRefreshRates (int) —
  • alMinBpp (int) —
  • alMinRefreshRate (int) —
  • abRemoveDuplicates (bool) —

Returns:

  • void

cSystem_GetDate

cDate cSystem_GetDate()

Returns:

  • cDate—

cSystem_GetFileSize

uint cSystem_GetFileSize(const tWString &in asFileName)


Parameters

Returns:

  • uint—

cSystem_GetFullFilePath

tWString cSystem_GetFullFilePath(const tWString &in asFilePath)


Parameters

Returns:

  • tWString—

cSystem_GetPlatformName

const tString& cSystem_GetPlatformName()

Returns:

  • const tString&—

cSystem_GetSystemAvailableDrives

uint cSystem_GetSystemAvailableDrives()

Returns:

  • uint—

cSystem_GetSystemSpecialPath

tWString cSystem_GetSystemSpecialPath(eSystemPath aPathType)


Parameters

Returns:

  • tWString—

cSystem_GetWorkingDir

tWString cSystem_GetWorkingDir()

Returns:

  • tWString—

cSystem_HasWindowFocus

bool cSystem_HasWindowFocus(const tWString &in asWindowCaption)


Parameters

Returns:

  • bool—

cSystem_LoadTextFromClipboard

tWString cSystem_LoadTextFromClipboard()

Returns:

  • tWString—

cSystem_ProfileEnd

void cSystem_ProfileEnd(const tString &in asName)


Parameters

Returns:

  • void

cSystem_ProfileStart

void cSystem_ProfileStart(const tString &in asName)


Parameters

Returns:

  • void

cSystem_RemoveFile

void cSystem_RemoveFile(const tWString &in asFileName)


Parameters

Returns:

  • void

cSystem_RemoveFolder

bool cSystem_RemoveFolder(const tWString &in asPath,
                          bool abDeleteAllFiles,
                          bool abDeleteAllSubFolders)


Parameters

  • asPath (tWString) —
  • abDeleteAllFiles (bool) —
  • abDeleteAllSubFolders (bool) —

Returns:

  • bool—

cSystem_Sleep

void cSystem_Sleep(uint alMilliSecs)


Parameters

  • alMilliSecs (uint) —

Returns:

  • void

cSystem_Wrapper_CreateMessageBox

void cSystem_Wrapper_CreateMessageBox(eMsgBoxType aType,
                                      const tWString &in asCaption,
                                      const tWString &in asMessage)


Parameters

Returns:

  • void
Retrieved from "https://wiki.frictionalgames.com/page?title=HPL3/SOMA/Scripting/Scripting_Api/cSystem&oldid=5027"