Apollolux: /* Files */ removed GetFileList, updated

2013-05-22T17:46:30Z

Files: removed GetFileList, updated

← Older revision		Revision as of 17:46, 22 May 2013
Line 1:		Line 1:
	== Files ==		== Files ==

	* [[API:~~RemoveFile~~\|~~RemoveFile~~]]~~(''filename'')~~: ~~Deletes a~~ file.		* Sphere [[API:File\|File]] object is a handle to an [http://en.wikipedia.org/wiki/INI_file INI-like] key=value structured text file.
	* [[API:~~GetFileList~~\|~~GetFileList~~]]~~(''directory''): Gets an array of strings containing the filenames in 'directory'~~.		* Sphere [[API:RawFile\|RawFile]] object is a handle to a raw file with no inference as to structure and by default processes as binary; scripts have been written to process RawFiles according to their proper formats.
	* [[API:OpenFile\|OpenFile]](''filename''): Returns a Sphere [[API:File\|File]] object with the filename.		* [[API:OpenFile\|OpenFile]](''filename''): Returns a Sphere [[API:File\|File]] object with the filename.
	* [[API:OpenRawFile\|OpenRawFile]](''filename'' [, ''writeable'']): Open or create a file, and grab a [[API:RawFile\|RawFile]] handle to it.		* [[API:OpenRawFile\|OpenRawFile]](''filename'' [, ''writeable'']): Open or create a file, and grab a [[API:RawFile\|RawFile]] handle to it.

Apollolux: created

2013-05-22T17:29:07Z

created

New page

== Files ==

* [[API:RemoveFile|RemoveFile]](''filename''): Deletes a file.
* [[API:GetFileList|GetFileList]](''directory''): Gets an array of strings containing the filenames in 'directory'.
* [[API:OpenFile|OpenFile]](''filename''): Returns a Sphere [[API:File|File]] object with the filename.
* [[API:OpenRawFile|OpenRawFile]](''filename'' [, ''writeable'']): Open or create a file, and grab a [[API:RawFile|RawFile]] handle to it.

=== File object ===

* [[API:File/read|File.read]](key, default): reads a value from the key; the value type returned depends on the default value:
** if the default is a number, read will return a number.
** if the default is a text or string, read will return a string.
** if the default is a boolean, read will return a boolean
** if the key is not present in the file, it will return the default value.
* [[API:File/write|File.write]](key, value): writes a value (string, number, boolean) to the file under the key name
* [[API:File/flush|File.flush]](): writes the file to disk immediately; this way you don't have to wait for it to save when the file object is garbage collected
* [[API:File/close|File.close]](): closes the File object, after which it cannot be used anymore.
*: Always remember to close opened files.

==== File keys ====

* [[API:File/getNumKeys|File.getNumKeys]](): returns the number of keys in the file
* [[API:File/getKey|File.getKey]](index): returns a string of the key at 'index'

=== RawFile object ===

* [[API:RawFile/read|RawFile.read]](''num_bytes''): Read ''num_bytes'' from the file, and return that data as a [[API:ByteArray|ByteArray]].
* [[API:RawFile/write|RawFile.write]](''byte_array''): Write the data in ''byte_array'' into the file.
* [[API:RawFile/close|RawFile.close]](): Close (and flush) the [[API:RawFile|RawFile]] object.

==== Size ====

* [[API:RawFile/getSize|RawFile.getSize]](): Get the size of the file in bytes.

==== File pointer position ====

* [[API:RawFile/getPosition|RawFile.getPosition]](): Get the current position which the data is read from.
* [[API:RawFile/setPosition|RawFile.setPosition]](''position''): Set the position that the file will be read from.

==== Hashing raw files ====

* [[API:HashFromFile|HashFromFile]](''filename''): Generate the MD5 'fingerprint' of a file. Identical files produce the same MD5 hash.

Legacy:Functions/Files - Revision history

Apollolux: /* Files */ removed GetFileList, updated

Apollolux: created