mirrors/CC-Tweaked
1
0
Fork 0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-12-14 04:00:30 +00:00
Code Issues Releases Wiki Activity

Fix fs.getCapacity docs

Browse Source 
Slightly embarassing the state this was in
This commit is contained in:
Jonathan Coates 2021-07-29 09:59:21 +00:00
parent 0285260e97
commit 7b8650bbc8
1 changed files with 3 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/main/java/dan200/computercraft/core/apis/FSAPI.java
View File

@ -457,6 +457,7 @@ public class FSAPI implements ILuaAPI
* @param path The path to check the free space for. * @param path The path to check the free space for.
* @return The amount of free space available, in bytes. * @return The amount of free space available, in bytes.
* @throws LuaException If the path doesn't exist. * @throws LuaException If the path doesn't exist.
* @see #getCapacity To get the capacity of this drive.
* @cc.treturn number|"unlimited" The amount of free space available, in bytes, or "unlimited". * @cc.treturn number|"unlimited" The amount of free space available, in bytes, or "unlimited".
*/ */
@LuaFunction @LuaFunction
@ -500,15 +501,12 @@ public class FSAPI implements ILuaAPI
} }
/** /**
* Returns true if a path is mounted to the parent filesystem. * Returns the capacity of the drive the path is located on.
*
* The root filesystem "/" is considered a mount, along with disk folders and the rom folder. Other programs
* (such as network shares) can extend this to make other mount types by correctly assigning their return value for
* getDrive.
* *
* @param path The path of the drive to get. * @param path The path of the drive to get.
* @return The drive's capacity. * @return The drive's capacity.
* @throws LuaException If the capacity cannot be determined. * @throws LuaException If the capacity cannot be determined.
* @see #getFreeSpace To get the free space available on this drive.
* @cc.treturn number|nil This drive's capacity. This will be nil for "read-only" drives, such as the ROM or * @cc.treturn number|nil This drive's capacity. This will be nil for "read-only" drives, such as the ROM or
* treasure disks. * treasure disks.
*/ */