Monkey Documentation

Class FileStream

A filestream allows you to read/write data from/to a file.

Extends:	Stream
Functions:	Open : FileStream ( path:String, mode:String )
Inherited Properties:	Eof : Int () Length : Int () Position : Int ()
Inherited Methods:	Close : Void () Read : Int ( buffer:DataBuffer, offset:Int, count:Int ) ReadAll : Void ( buffer:DataBuffer, offset:int, count:int ) ReadAll : DataBuffer () ReadByte : Int () ReadFloat : Float () ReadInt : Int () ReadShort : Int () ReadString : String ( count:Int, encoding:String="utf8" ) ReadString : String ( encoding:String="utf8" ) Seek : Int ( position:Int ) Write : Int ( buffer:DataBuffer, offset:Int, count:Int ) WriteAll : Void ( buffer:DataBuffer, offset:Int, count:Int ) WriteByte : Void ( value:Int ) WriteFloat : Void ( value:Float ) WriteInt : Void ( value:Int ) WriteShort : Void ( value:Int ) WriteString : Void ( value:String, encoding:String="utf8" )

Function Documentation

Function Open : FileStream ( path:String, mode:String )

Opens a new filestream. The mode parameter should be one of the following:

Mode	Description
"r"	Open a filestream for reading.
"w"	Open a filestream for writing. If the file does not already exist, it will be created. If the file already exists, it will be emptied.
"u"	Open a filestream for read/write updating. If the file does not already exist, it will be created.
"a"	Open a filestream for read/write appending. This is the same as opening a filestream for updating and seeking to the end.

See also Resource paths