Revision Difference
file.AsyncRead#529560
<function name="AsyncRead" parent="file" type="libraryfunc">⤶
<description>⤶
Returns the content of a file asynchronously.⤶
⤶
All limitations of <page>file.Read</page> also apply.⤶
</description>⤶
<realm>Shared and Menu</realm>⤶
<added>2021.03.31</added>⤶
<args>⤶
<arg name="fileName" type="string">The name of the file.</arg>⤶
<arg name="gamePath" type="string">The path to look for the files and directories in. See <page text="this list">File_Search_Paths</page> for a list of valid paths.</arg>⤶
<arg name="callback" type="function">⤶
A callback function that will be called when the file read operation finishes. Arguments are:⤶
* <page>string</page> fileName - The `fileName` argument above.⤶
* <page>string</page> gamePath - The `gamePath` argument above.⤶
* <page>number</page> status - The status of the operation.⤶
* <page>string</page> data - The entirety of the data of the file.⤶
</arg>⤶
<arg name="sync" type="boolean" default="false">If `true` the file will be read synchronously.</arg>⤶
</args>⤶
</function>