Name 

Description 

 

addExcludedDirectory 

This is function Platform::addExcludedDirectory. 

 

addKeyboardInputExclusion 

Add a new keyboard exclusion. 

 

advanceTime 

This is function Platform::advanceTime. 

 

AlertAssert 

This is function Platform::AlertAssert. 

 

AlertOK 

Alerts
 

 

AlertOKCancel 

 

 

AlertRetry 

 

 

cdFileExists 

[tom, 7/12/2005] Rather then converting this to unicode, just using the ANSI versions of the Win32 API as its quicker for testing. 

 

checkKeyboardInputExclusion 

Check if a given input event should be excluded. 

 

checkOtherInstances 

just check if the app's global mutex exists, and if so, return true - otherwise, false. Should be called before ExcludeOther at very start of app execution. 

 

clearExcludedDirectories 

This is function Platform::clearExcludedDirectories. 

 

clearKeyboardInputExclusion 

Reset the keyboard input exclusion list. 

 

closeSplashWindow 

close Splash Window 

 

closeWindow 

This is function Platform::closeWindow. 

 

compareFileTimes 

compare file times returns < 0 if a is earlier than b, >0 if b is earlier than a
 

 

compareModifiedTimes 

Compares the last modified time between two file paths. Returns < 0 if the first file is earlier than the second, > 0 if the second file is earlier than the first, and 0 if the files are equal.
If either of the files doesn't exist it returns -1. 

 

createPath 

create a directory path
 

 

createPlatformFriendlyFilename 

This is function Platform::createPlatformFriendlyFilename. 

 

debugBreak 

 

 

displaySplashWindow 

display Splash Window 

 

doCDCheck 

File stuff 

 

dumpDirectories 

This is function Platform::dumpDirectories. 

 

dumpPath 

This is function Platform::dumpPath. 

 

excludeOtherInstances 

 

 

fileTimeToString 

This is untested -- BJG 

 

fileToLocalTime 

This is function Platform::fileToLocalTime. 

 

forceShutdown 

 

 

getBackgroundSleepTime 

This is function Platform::getBackgroundSleepTime. 

 

getClipboard 

 

 

getCurrentDirectory 

Directory functions. Dump path returns false iff the directory cannot be opened.
 

 

getExecutableName 

Returns the filename of the torque executable. On Win32, this is the .exe file. On Mac, this is the .app/ directory bundle. 

 

getExecutablePath 

Returns full pathname of the torque executable without filename 

 

getFileSize 

 

 

getFileTimes 

 

 

getLocalTime 

 

 

getLoginPassword 

This is function Platform::getLoginPassword. 

 

getMainDotCsDir 

Returns the full path to the directory that contains main.cs. Tools scripts are validated as such if they are in this directory or a subdirectory of this directory. 

 

getMathControlState 

Math control state
source http://msdn.microsoft.com/en-us/library/c9676k6h.aspx 

 

getPrefsPath 

 

 

getRandom 

Random
 

 

getRealMilliseconds 

Returns the milliseconds since the system was started. You should not depend on this for high precision timing. @see PlatformTimer
Gets the time in milliseconds since some epoch. In this case, system start time. Storing milliseconds in a U32 overflows every 49.71 days 

 

getTemporaryDirectory 

 

 

getTemporaryFileName 

This is function Platform::getTemporaryFileName. 

 

getTime 

Gets the time in seconds since the Epoch 

 

getUserDataDirectory 

 

 

getUserHomeDirectory 

User Specific Functions
 

 

getUserIsAdministrator 

This is function Platform::getUserIsAdministrator. 

 

getVirtualMilliseconds 

This is function Platform::getVirtualMilliseconds. 

 

getVolumeInformationList 

This is function Platform::getVolumeInformationList. 

 

getVolumeNamesList 

Volume functions.
Volume Functions 

 

getWebDeployment 

Set/Get whether this is a web deployment 

 

hasSubDirectory 

This is function Platform::hasSubDirectory. 

 

init 

Platform control
 

 

initConsole 

This is function Platform::initConsole. 

 

isDirectory 

 

 

isExcludedDirectory 

This is function Platform::isExcludedDirectory. 

 

isFile 

 

 

isFullPath 

This is function Platform::isFullPath. 

 

isSubDirectory 

 

 

localTimeToString 

Converts the local time to a formatted string appropriate for the current platform. 

 

makeFullPathName 

 

 

makeRelativePathName 

 

 

messageBox 

Displays a fancy platform specific message box
 

 

minimizeWindow 

This is function Platform::minimizeWindow. 

 

openFile 

Open file at the OS level, according to registered file-types. 

 

openFolder 

This is function Platform::openFolder. 

 

openWebBrowser 

Web page launch function:
Spawn the default Operating System web browser with a URL @param webAddress URL to pass to browser @return true if browser successfully spawned 

 

outputDebugString 

Debug
 

 

postQuitMessage 

 

 

process 

This is function Platform::process. 

 

restartInstance 

 

 

setClipboard 

 

 

setCurrentDirectory 

 

 

setLoginPassword 

 

 

setMainDotCsDir 

Set main.cs directory. Used in runEntryScript() 

 

setMathControlState 

This is function Platform::setMathControlState. 

 

setMathControlStateKnown 

This is function Platform::setMathControlStateKnown. 

 

setWebDeployment 

This is function Platform::setWebDeployment. 

 

setWindowLocked 

Window state 

 

setWindowSize 

const Point2I &getWindowSize();
 

 

shutdown 

 

 

sleep 

Process control
Asks the operating system to put the process to sleep for at least ms milliseconds 

 

stringToFileTime 

This is function Platform::stringToFileTime. 

 

stripBasePath 

This is function Platform::stripBasePath. 

 

stripExtension 

Return "fileName" stripped of its extension. Only extensions contained in "validExtensions" will be stripped from the filename.
@note Extensions in "validExtension" should include the dot.