Platform Namespace Reference

Classes

struct LocalTime

struct FileInfo

struct VolumeInformation

struct SystemInfo_struct

struct KeyboardInputExclusion

Description of a keyboard input we want to ignore. More...

Namespaces

namespace FS

Functions

void getLocalTime (LocalTime &)

U32 getTime ()

U32 getVirtualMilliseconds ()

U32 getRealMilliseconds ()

void advanceTime (U32 delta)

S32 getBackgroundSleepTime ()

void init ()

void initConsole ()

void shutdown ()

void process ()

U32 getMathControlState ()

void setMathControlState (U32 state)

void setMathControlStateKnown ()

void sleep (U32 ms)

bool excludeOtherInstances (const char *string)

bool checkOtherInstances (const char *string)

void restartInstance ()

void postQuitMessage (const U32 in_quitVal)

void forceShutdown (S32 returnValue)

void outputDebugString (const char *string)

void debugBreak ()

float getRandom ()

void setWindowLocked (bool locked)

void minimizeWindow ()

void setWindowSize (U32 newWidth, U32 newHeight, bool fullScreen)

void closeWindow ()

bool doCDCheck ()

StringTableEntry createPlatformFriendlyFilename (const char *filename)

bool cdFileExists (const char *filePath, const char *volumeName, S32 serialNum)

void fileToLocalTime (const FileTime &ft, LocalTime *lt)

S32 compareFileTimes (const FileTime &a, const FileTime &b)

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

bool stringToFileTime (const char *string, FileTime *time)

bool fileTimeToString (FileTime *time, char *string, U32 strLen)

StringTableEntry getCurrentDirectory ()

bool setCurrentDirectory (StringTableEntry newDir)

StringTableEntry getTemporaryDirectory ()

StringTableEntry getTemporaryFileName ()

StringTableEntry getExecutableName ()

Returns the filename of the torque executable.

StringTableEntry getExecutablePath ()

Returns full pathname of the torque executable without filename.

StringTableEntry getMainDotCsDir ()

Returns the full path to the directory that contains main.cs.

void setMainDotCsDir (const char *dir)

Set main.cs directory. Used in runEntryScript().

StringTableEntry getPrefsPath (const char *file=NULL)

char * makeFullPathName (const char *path, char *buffer, U32 size, const char *cwd=NULL)

StringTableEntry stripBasePath (const char *path)

bool isFullPath (const char *path)

StringTableEntry makeRelativePathName (const char *path, const char *to)

bool dumpPath (const char *in_pBasePath, Vector< FileInfo > &out_rFileVector, S32 recurseDepth=-1)

bool dumpDirectories (const char *path, Vector< StringTableEntry > &directoryVector, S32 depth=0, bool noBasePath=false)

bool hasSubDirectory (const char *pPath)

bool getFileTimes (const char *filePath, FileTime *createTime, FileTime *modifyTime)

bool isFile (const char *pFilePath)

S32 getFileSize (const char *pFilePath)

bool isDirectory (const char *pDirPath)

bool isSubDirectory (const char *pParent, const char *pDir)

void addExcludedDirectory (const char *pDir)

void clearExcludedDirectories ()

bool isExcludedDirectory (const char *pDir)

bool createPath (const char *path)

Given a directory path, create all necessary directories for that path to exist.

void AlertOK (const char *windowTitle, const char *message)

bool AlertOKCancel (const char *windowTitle, const char *message)

bool AlertRetry (const char *windowTitle, const char *message)

void getVolumeNamesList (Vector< const char * > &out_rNameVector, bool bOnlyFixedDrives=false)

void getVolumeInformationList (Vector< VolumeInformation > &out_rVolumeInfoVector, bool bOnlyFixedDrives=false)

bool openWebBrowser (const char *webAddress)

void openFolder (const char *path)

const char * getLoginPassword ()

bool setLoginPassword (const char *password)

const char * getClipboard ()

bool setClipboard (const char *text)

StringTableEntry getUserHomeDirectory ()

StringTableEntry getUserDataDirectory ()

bool getUserIsAdministrator ()

S32 messageBox (const UTF8 *title, const UTF8 *message, MBButtons buttons=MBOkCancel, MBIcons icon=MIInformation)

void clearKeyboardInputExclusion ()

Reset the keyboard input exclusion list.

void addKeyboardInputExclusion (const KeyboardInputExclusion &kie)

Add a new keyboard exclusion.

const bool checkKeyboardInputExclusion (const InputEventInfo *info)

Check if a given input event should be excluded.

Variables

VolumeInformation * PVolumeInformation

SystemInfo_struct SystemInfo

Function Documentation

void Platform::getLocalTime ( LocalTime & )

U32 Platform::getTime ( )

U32 Platform::getVirtualMilliseconds ( )

U32 Platform::getRealMilliseconds ( )

void Platform::advanceTime ( U32 delta )

S32 Platform::getBackgroundSleepTime ( )

void Platform::init ( )

void Platform::initConsole ( )

void Platform::shutdown ( )

void Platform::process ( )

U32 Platform::getMathControlState ( )

void Platform::setMathControlState ( U32 state )

void Platform::setMathControlStateKnown ( )

void Platform::sleep ( U32 ms )

bool Platform::excludeOtherInstances ( const char * string )

bool Platform::checkOtherInstances ( const char * string )

void Platform::restartInstance ( )

void Platform::postQuitMessage ( const U32 in_quitVal )

void Platform::forceShutdown ( S32 returnValue )

void Platform::outputDebugString ( const char * string )

void Platform::debugBreak ( )

float Platform::getRandom ( )

void Platform::setWindowLocked ( bool locked )

void Platform::minimizeWindow ( )

void Platform::setWindowSize	(	U32	newWidth,
		U32	newHeight,
		bool	fullScreen
	)

void Platform::closeWindow ( )

bool Platform::doCDCheck ( )

StringTableEntry Platform::createPlatformFriendlyFilename ( const char * filename )

bool Platform::cdFileExists	(	const char *	filePath,
		const char *	volumeName,
		S32	serialNum
	)

void Platform::fileToLocalTime	(	const FileTime &	ft,
		LocalTime *	lt
	)

S32 Platform::compareFileTimes	(	const FileTime &	a,
		const FileTime &	b
	)

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

bool Platform::stringToFileTime	(	const char *	string,
		FileTime *	time
	)

bool Platform::fileTimeToString	(	FileTime *	time,
		char *	string,
		U32	strLen
	)

StringTableEntry Platform::getCurrentDirectory ( )

bool Platform::setCurrentDirectory ( StringTableEntry newDir )

StringTableEntry Platform::getTemporaryDirectory ( )

StringTableEntry Platform::getTemporaryFileName ( )

StringTableEntry Platform::getExecutableName ( )

Returns the filename of the torque executable.

On Win32, this is the .exe file. On Mac, this is the .app/ directory bundle.

StringTableEntry Platform::getExecutablePath ( )

Returns full pathname of the torque executable without filename.

StringTableEntry Platform::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.

void Platform::setMainDotCsDir ( const char * dir )

Set main.cs directory. Used in runEntryScript().

StringTableEntry Platform::getPrefsPath ( const char * file = NULL )

char* Platform::makeFullPathName	(	const char *	path,
		char *	buffer,
		U32	size,
		const char *	cwd = `NULL`
	)

StringTableEntry Platform::stripBasePath ( const char * path )

bool Platform::isFullPath ( const char * path )

StringTableEntry Platform::makeRelativePathName	(	const char *	path,
		const char *	to
	)

bool Platform::dumpPath	(	const char *	in_pBasePath,
		Vector< FileInfo > &	out_rFileVector,
		S32	recurseDepth = `-1`
	)

bool Platform::dumpDirectories	(	const char *	path,
		Vector< StringTableEntry > &	directoryVector,
		S32	depth = `0`,
		bool	noBasePath = `false`
	)

bool Platform::hasSubDirectory ( const char * pPath )

bool Platform::getFileTimes	(	const char *	filePath,
		FileTime *	createTime,
		FileTime *	modifyTime
	)

bool Platform::isFile ( const char * pFilePath )

S32 Platform::getFileSize ( const char * pFilePath )

bool Platform::isDirectory ( const char * pDirPath )

bool Platform::isSubDirectory	(	const char *	pParent,
		const char *	pDir
	)

void Platform::addExcludedDirectory ( const char * pDir )

void Platform::clearExcludedDirectories ( )

bool Platform::isExcludedDirectory ( const char * pDir )

bool Platform::createPath ( const char * path )

Given a directory path, create all necessary directories for that path to exist.

void Platform::AlertOK	(	const char *	windowTitle,
		const char *	message
	)

bool Platform::AlertOKCancel	(	const char *	windowTitle,
		const char *	message
	)

bool Platform::AlertRetry	(	const char *	windowTitle,
		const char *	message
	)

void Platform::getVolumeNamesList	(	Vector< const char * > &	out_rNameVector,
		bool	bOnlyFixedDrives = `false`
	)

void Platform::getVolumeInformationList	(	Vector< VolumeInformation > &	out_rVolumeInfoVector,
		bool	bOnlyFixedDrives = `false`
	)

bool Platform::openWebBrowser ( const char * webAddress )

void Platform::openFolder ( const char * path )

const char* Platform::getLoginPassword ( )

bool Platform::setLoginPassword ( const char * password )

const char* Platform::getClipboard ( )

bool Platform::setClipboard ( const char * text )

StringTableEntry Platform::getUserHomeDirectory ( )

StringTableEntry Platform::getUserDataDirectory ( )

bool Platform::getUserIsAdministrator ( )

S32 Platform::messageBox	(	const UTF8 *	title,
		const UTF8 *	message,
		MBButtons	buttons = `MBOkCancel`,
		MBIcons	icon = `MIInformation`
	)

void Platform::clearKeyboardInputExclusion ( )

Reset the keyboard input exclusion list.

void Platform::addKeyboardInputExclusion ( const KeyboardInputExclusion & kie )

Add a new keyboard exclusion.

const bool Platform::checkKeyboardInputExclusion ( const InputEventInfo * info )

Check if a given input event should be excluded.

Variable Documentation

struct VolumeInformation* Platform::PVolumeInformation

struct SystemInfo_struct Platform::SystemInfo