FileIO API
Part of System
Typedefs
FileHandle | int[] | |
FindFileHandle | int[] | |
ParseHandle | int[] |
Enums
Values
ALL | ||
APPEND | ||
ARCHIVES | Looks for files in archive only. (.pak) | |
DIRECTORIES | Looks for files in fs directories only. | |
DIRECTORY | File is directory | |
HIDDEN | File is hidden | |
INVALID | ||
READ | ||
READONLY | File is read-only | |
WRITE |
Functions
proto native ParseHandle BeginParse(string filename) | ||
proto void CloseFile(FileHandle file) | Close the File | more… |
proto native void CloseFindFile(FindFileHandle handle) | more… | |
proto native bool CopyFile(string sourceName, string destName) | copy file. destName must be "$profile:" or "$saves:" location | more… |
proto native bool DeleteFile(string name) | delete file. Works only on "$profile:" and "$saves:" locations | more… |
proto native void EndParse(ParseHandle file) | ||
proto int FGets(FileHandle file, string var) | Get line from file, every next call of this function returns next line | more… |
proto bool FileExist(string name) | Check existence of file | more… |
proto FindFileHandle FindFile(string pattern, out string fileName, out FileAttr fileAttributes, FindFileFlags flags) | more… | |
proto bool FindNextFile(FindFileHandle handle, out string fileName, out FileAttr fileAttributes) | more… | |
proto void FPrint(FileHandle file, void var) | Write to file | more… |
proto void FPrintln(FileHandle file, void var) | Write to file and add new line | more… |
proto native bool MakeDirectory(string name) | Makes a directory | more… |
proto FileHandle OpenFile(string name, FileMode mode) | Opens File | more… |
proto int ParseLine(ParseHandle tp, int num, string tokens[]) | ||
proto int ReadFile(FileHandle file, void param_array, int length) | Reads raw data from file. | more… |
Function Documentation
CloseFile
proto void CloseFile(FileHandle file)Close the File
file- File handle ID of a opened file
Returns: void
usage :
FileHandle file = OpenFile("$profile:testiik.txt", FileMode.WRITE);
if (file != 0)
{
FPrintln(file, "line1");
FPrintln(file, "line2");
FPrintln(file, "line3");
CloseFile(file);
}Referenced by AutoTestFixture.SaveXMLReport(), ChernarusPlusData.WeatherOnBeforeChange(), ControlsXbox.GetControlMappingInfo()
Show 14 more
, Debug.ClearLogs(), Debug.SaveLog(), EnochData.WeatherOnBeforeChange(), JsonFileLoader.JsonLoadFile(), JsonFileLoader.JsonSaveFile(), JsonFileLoader.LoadFile(), JsonFileLoader.SaveFile(), MissionBenchmark.OnBenchmarkEnd(), PluginFileHandler.LoadFile(), PluginFileHandler.SaveFile(), PluginRecipesManager.GenerateHumanReadableRecipeList(), SakhalData.WeatherOnBeforeChange(), ScriptConsoleOutputTab.ReloadOutput(), and TutorialsMenu.GetControlMappingInfo()CloseFindFile
proto native void CloseFindFile(FindFileHandle handle)CopyFile
copy file. destName must be "$profile:" or "$saves:" location
Referenced by PluginFileHandler.FileDuplicate()
DeleteFile
delete file. Works only on "$profile:" and "$saves:" locations
Referenced by PluginFileHandler.FileDelete()
FGets
proto int FGets(FileHandle file, string var)Get line from file, every next call of this function returns next line
file- File handle ID of a opened file
var- Value to write
Returns: int Count of chars or -1 if is not any for read (end of file is EMPTY line)
usage :
FileHandle file_handle = OpenFile("$profile:testiik.txt", FileMode.READ);
string line_content;
while ( FGets( file_handle, line_content ) > 0 )
{
Print(line_content);
}
CloseFile(file_handle);FileExist
Check existence of file
Referenced by CameraToolsMenu.LoadData(), CameraToolsMenu.SaveData(), CfgGameplayHandler.LoadData()
Show 17 more
, CfgPlayerRestrictedAreaHandler.LoadData(), Debug.ClearLogs(), EffectAreaLoader.CreateZones(), JsonFileLoader.JsonLoadFile(), JsonFileLoader.LoadFile(), JsonMissionLoaderData.GetData(), ParticleList.RegisterParticle(), PluginConfigDebugProfile.GetFileName(), PluginConfigScene.GetSceneList(), PluginConfigScene.SceneDataLoad(), PluginConfigScene.SceneDuplicate(), PluginFileHandler.SaveFile(), PluginLocalEnscriptHistory.GetFileName(), PluginLocalEnscriptHistoryServer.GetFileName(), PluginLocalProfileScene.GetSceneList(), ScriptConsole.GetData(), and UndergroundAreaLoader.GetData()FindFile
proto FindFileHandle FindFile(string pattern, out string fileName, out FileAttr fileAttributes, FindFileFlags flags)Referenced by PluginConfigScene.GetSceneList(), PluginLocalProfileScene.GetSceneList(), VideoPlayer.InitVideoLoading()
Show 1 more
, WorldsMenu.LoadWorlds()FindNextFile
proto bool FindNextFile(FindFileHandle handle, out string fileName, out FileAttr fileAttributes)Referenced by PluginConfigScene.GetSceneList(), PluginLocalProfileScene.GetSceneList(), VideoPlayer.InitVideoLoading()
Show 1 more
, WorldsMenu.LoadWorlds()FPrint
proto void FPrint(FileHandle file, void var)Write to file
file- File handle ID of a opened file
var- Value to write
Returns: void
usage :
FileHandle file = OpenFile("$profile:testiik.txt", FileMode.WRITE);
if (file != 0)
{
FPrint(file, "A");
FPrint(file, "B");
FPrint(file, "C");
CloseFile(file);
}Referenced by AutoTestFixture.SaveXMLReport(), JsonFileLoader.JsonSaveFile(), and JsonFileLoader.SaveFile()
FPrintln
proto void FPrintln(FileHandle file, void var)Write to file and add new line
file- File handle ID of a opened file
var- Value to write
Returns: void
usage :
FileHandle file = OpenFile("$profile:testiik.txt", FileMode.WRITE);
if (file != 0)
{
FPrintln(file, "line1");
FPrintln(file, "line2");
FPrintln(file, "line3");
CloseFile(file);
}MakeDirectory
Makes a directory
Referenced by CameraToolsMenu.LoadData(), CameraToolsMenu.SaveData(), PluginConfigScene.GetSceneList()
Show 2 more
, PluginFileHandler.SaveFile(), and PluginLocalProfileScene.GetSceneList()OpenFile
proto FileHandle OpenFile(string name, FileMode mode)Opens File
name- of a file to open, (you can use filesystem prefixes ('$profile','$saves','$mission'). For accessing profile dir use '$profile', e.g. '$profile:myfilename.txt')
mode- constants FileMode.WRITE, FileMode.READ or FileMode.APPEND flag can be used
Returns: file handle ID or 0 if fails
usage :
FileHandle file = OpenFile("$profile:testiik.txt", FileMode.WRITE);
//FileHandle file = OpenFile("$profile:testiik.txt", FileMode.APPEND);
if (file != 0)
{
FPrintln(file, "line1");
FPrintln(file, "line2");
FPrintln(file, "line3");
CloseFile(file);
}Referenced by AutoTestFixture.SaveXMLReport(), Canvas.SaveToFile(), ChernarusPlusData.WeatherOnBeforeChange()
Show 15 more
, ControlsXbox.GetControlMappingInfo(), Debug.ClearLogs(), Debug.SaveLog(), EnochData.WeatherOnBeforeChange(), JsonFileLoader.JsonLoadFile(), JsonFileLoader.JsonSaveFile(), JsonFileLoader.LoadFile(), JsonFileLoader.SaveFile(), MissionBenchmark.CreateCSVLog(), PluginFileHandler.LoadFile(), PluginFileHandler.SaveFile(), PluginRecipesManager.GenerateHumanReadableRecipeList(), SakhalData.WeatherOnBeforeChange(), ScriptConsoleOutputTab.ReloadOutput(), and TutorialsMenu.GetControlMappingInfo()ReadFile
proto int ReadFile(FileHandle file, void param_array, int length)Reads raw data from file.
param_array- Receiving array for the data. Valid types are int[] or string
length- Length of data
Returns: number of read bytes
Referenced by JsonFileLoader.LoadFile()