STFReader overview
Public Instance Constructors
STFReader
|
Overloaded. Initializes a new instance of the STFReader class. |
Public Instance Properties
 Eof | Property that returns true when the EOF has been reached |
| FileName | Filename property for the file being parsed - for reporting purposes |
| LineNumber | Line Number property for the file being parsed - for reporting purposes |
| SimisSignature | SIMIS header read from the first line of the file being parsed |
| Tree | Property returning the last {item} read using ReadItem() prefixed with string describing the nested block hierachy. The string returned is formatted 'rootnode(nestednode(childnode(previous_item'. |
Public Instance Methods
| Dispose | Overloaded. Implements the IDisposable interface so this class can be implemented with the 'using(STFReader r = new STFReader(...)) {...}' C# statement. |
| EndOfBlock | Returns true if the next character is the end of block, or end of file. Consuming the closing ")" all other values are not consumed. |
| EOF | |
| Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object. |
| GetHashCode (inherited from Object) | Serves as a hash function for a particular type. |
| GetType (inherited from Object) | Gets the Type of the current instance. |
| MustMatch | Reports a critical error if the next {item} does not match the target. |
| ParseBlock | Overloaded. Parse an STF file until the end of block ')' marker, using the array of lower case tokens, with a processor delegate/lambda |
| ParseFile | Overloaded. Parse an STF file until the EOF, using the array of lower case tokens, with a processor delegate/lambda |
| PeekPastWhitespace | |
| ReadBoolBlock | Reads the first item from a block in the STF format '( {double_constant} ... )' and return true if is not-zero or 'true' |
| ReadDouble | Read an double precision floating point number {constant_item} |
| ReadDoubleBlock | Read an double precision constant from the STF format '( {double_constant} ... )' |
| ReadFloat | Read an single precision floating point number {constant_item} |
| ReadFloatBlock | Read an single precision constant from the STF format '( {float_constant} ... )' |
| ReadHex | Read an hexidecimal encoded number {constant_item} |
| ReadHexBlock | Read an hexidecimal encoded number from the STF format '( {int_constant} ... )' |
| ReadInt | Read an signed integer {constant_item} |
| ReadIntBlock | Read an integer constant from the STF format '( {int_constant} ... )' |
| ReadItem | Returns the next whitespace delimited {item} from the STF file skipping comments, etc. |
| ReadString | Return next whitespace delimited string from the STF file. |
| ReadStringBlock | Read an string constant from the STF format '( {string_constant} ... )' |
| ReadUInt | Read an unsigned integer {constant_item} |
| ReadUIntBlock | Read an unsigned integer constant from the STF format '( {uint_constant} ... )' |
| ReadVector2Block | Read a Vector3 object in the STF format '( {X} {Y} ... )' |
| ReadVector3Block | Read a Vector3 object in the STF format '( {X} {Y} {Z} ... )' |
| ReadVector4Block | Read a Vector4 object in the STF format '( {X} {Y} {Z} {W} ... )' |
| SkipBlock | Read a block open (, and then consume the rest of the block without processing. If we find an immediate close ), then produce a warning, and return without consuming the parenthesis. |
| SkipRestOfBlock | Skip to the end of this block, ignoring any nested blocks |
| StepBackOneItem | Calling this function causes ReadItem() to repeat the last {item} that was read from the STF file |
| ToString (inherited from Object) | Returns a String that represents the current Object. |
| VerifyStartOfBlock | |
Protected Instance Methods
See Also
STFReader Class | Orts.Parsers.Msts Namespace
Dispose