From 6c9f3de6150c4642b0796dfec4eb37bed00e3e21 Mon Sep 17 00:00:00 2001
From: AJ Kelly <aj187@ajworld.net>
Date: Sun, 20 Apr 2008 00:05:46 +0000
Subject: [PATCH] RageFileUtil and more RageFile

---
 stepmania/Docs/LuaDocumentation.xml | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/stepmania/Docs/LuaDocumentation.xml b/stepmania/Docs/LuaDocumentation.xml
index ff9a688e3a..db542538fb 100644
--- a/stepmania/Docs/LuaDocumentation.xml
+++ b/stepmania/Docs/LuaDocumentation.xml
@@ -159,6 +159,11 @@
 		Flushes log files to disk.
 	</Function>
 </Namespace>
+<Namespace name='RageFileUtil'>
+	<Function name='CreateRageFile' return='RageFile' arguments=''>
+		Creates a RageFile handle with which one can use the commands in <Link class='RageFile' />.
+	</Function>
+</Namespace>
 <Namespace name='ScreenSystemLayerHelpers'>
 	<Function name='GetCreditsMessage' return='string' arguments='PlayerNumber pn'>
 		Gets the credits message for Player <code>pn</code>.
@@ -970,9 +975,18 @@
 	</Function>
 </Class>
 <Class name='RageFile'>
+	<Description>
+		These commands require a RageFile handle. You can create one using
+		<Link class='RageFileUtil' />.
+	</Description>
 	<Function name='Close' return='void' arguments=''>
 		Closes the file and releases it from memory.
 	</Function>
+	<Function name='Open' return='bool' arguments='string sPath, int iAccessType'>
+		Opens a file at <code>sPath</code> (relative to the StepMania root directory).<br />
+		<code>iAccessType</code> can be set to read (<code>1</code>), write (<code>2</code>), stream (<code>4</code>) or flush to disk on close (<code>8</code>).<br />
+		These can also be combined with addition. For example, to set up read and write, set <code>iAccessType</code> to <code>3</code> (1+2).
+	</Function>
 </Class>
 <Class name='RageInput'>
 	<Function name='GetDescriptions' return='{string}' arguments=''>