TorqueScript Reference
Public Member Functions | List of all members
FileStreamObject Class Reference

Inherits StreamObject.

Public Member Functions

void close ()
 
Boolean open (filename, mode)
 
- Public Member Functions inherited from StreamObject
Boolean copyFrom (StreamObject other)
 
Integer getPosition ()
 
const char * getStatus ()
 
Integer getStreamSize ()
 
Boolean isEOF ()
 
Boolean isEOS ()
 
const char * readLine ()
 
const char * readLongString (maxLength)
 
const char * readString ()
 
const char * readSTString ([caseSensitive=false])
 
Boolean setPosition (newPosition)
 
void writeLine (line)
 
void writeLongString (maxLength, string)
 
void writeString (string, [maxLength=255])
 
- Public Member Functions inherited from SimObject
Integer clone ([copyDynamicFields=false]?)
 
void delete ()
 
Integer getId ()
 
void setName (newName)
 
String getName ()
 
String getClassNamespace ()
 
String getSuperClassNamespace ()
 
void setClassNamespace (nameSpace)
 
void setSuperClassNamespace ()
 
Boolean isMethod (string methodName)
 
String call (methodName, [args]*)
 
void dumpClassHierarchy ()
 
void dump ()
 
Boolean isMemberOfClass (string classname)
 
String getClassName ()
 
String getFieldValue (fieldName)
 
Boolean setFieldValue (fieldName, value)
 
Integer getDynamicFieldCount ()
 
String getDynamicField (index)
 
Integer getFieldCount ()
 
String getField (int index)
 
void setProgenitorFile (file)
 
String getProgenitorFile ()
 
Integer getType ()
 
String getFieldType (fieldName)
 
void setInternalName (string InternalName)
 
String getInternalName ()
 
Boolean isChildOfGroup (groupID)
 
Integer getGroup ()
 
Boolean startTimer (callbackFunction, float timePeriod, [repeat]?)
 
void stopTimer ()
 
Boolean isTimerActive ()
 
Integer schedule (time, command, [arg]*)
 
Boolean save (fileName, [selectedOnly]?)
 
void addFieldFilter (fieldName)
 
void removeFieldFilter (fieldName)
 

Member Function Documentation

void close ( )

Close the file.

Boolean open ( filename  ,
mode   
)

Open a file. Mode can be one of Read, Write, ReadWrite or WriteAppend.