Allium Docs

Content

• Constructors
• Instance Methods

Classes

• AlliumLib
• DefaultEventsLib$ChatMessageHandler
• ClassBuilder
• DefaultEventsLib$CommandRegistrationHandler
• ConfigLib
• DefaultEventsLib
• PackageLib$ExternScriptLoader
• FabricLib
• FsLib
• LibBuilder$Function
• LibBuilder$FunctionImpl
• GameLib
• JavaLib
• JsonLib
• LibBuilder
• LibBuilder$LuaLibraryImpl
• NbtLib
• PackageLib
• PackageLib$PathLoader
• DefaultEventsLib$PlayerBlockCollisionHandler
• DefaultEventsLib$PlayerBlockInteractHandler
• DefaultEventsLib$PlayerDeathHandler
• DefaultEventsLib$PlayerJoinHandler
• DefaultEventsLib$PlayerQuitHandler
• DefaultEventsLib$PlayerTickHandler
• PackageLib$PreloadLoader
• PackageLib$Require
• DefaultEventsLib$ServerTickHandler
• TextLib
• WrappedLuaLibrary
• ClassBuilder$WrappedType

Class me.hugeblank.allium.lua.api.FsLib

This description should be content pulled from the first comments of a lua file.

Constructors

Instance Methods

instance:attributes(arg0)	This description should be content pulled from the comments above a method in a lua file. Format: "--- @method m_id DESCRIPTION"
instance:combine(arg0, arg1)	This description should be content pulled from the comments above a method in a lua file. Format: "--- @method m_id DESCRIPTION"
instance:copy(arg0, arg1)	This description should be content pulled from the comments above a method in a lua file. Format: "--- @method m_id DESCRIPTION"
instance:create(arg0)	This description should be content pulled from the comments above a method in a lua file. Format: "--- @method m_id DESCRIPTION"
instance:delete(arg0)	This description should be content pulled from the comments above a method in a lua file. Format: "--- @method m_id DESCRIPTION"
instance:exists(arg0)	This description should be content pulled from the comments above a method in a lua file. Format: "--- @method m_id DESCRIPTION"
instance:find(arg0)	This description should be content pulled from the comments above a method in a lua file. Format: "--- @method m_id DESCRIPTION"
instance:getCapacity()	This description should be content pulled from the comments above a method in a lua file. Format: "--- @method m_id DESCRIPTION"
instance:getDir(arg0)	This description should be content pulled from the comments above a method in a lua file. Format: "--- @method m_id DESCRIPTION"
instance:getFreeSpace()	This description should be content pulled from the comments above a method in a lua file. Format: "--- @method m_id DESCRIPTION"
instance:getName(arg0)	This description should be content pulled from the comments above a method in a lua file. Format: "--- @method m_id DESCRIPTION"
instance:getSize(arg0)	This description should be content pulled from the comments above a method in a lua file. Format: "--- @method m_id DESCRIPTION"
instance:isDir(arg0)	This description should be content pulled from the comments above a method in a lua file. Format: "--- @method m_id DESCRIPTION"
instance:isReadOnly(arg0)	This description should be content pulled from the comments above a method in a lua file. Format: "--- @method m_id DESCRIPTION"
instance:list(arg0)	This description should be content pulled from the comments above a method in a lua file. Format: "--- @method m_id DESCRIPTION"
instance:makeDir(arg0)	This description should be content pulled from the comments above a method in a lua file. Format: "--- @method m_id DESCRIPTION"
instance:move(arg0, arg1)	This description should be content pulled from the comments above a method in a lua file. Format: "--- @method m_id DESCRIPTION"
instance:open(arg0, arg1)	This description should be content pulled from the comments above a method in a lua file. Format: "--- @method m_id DESCRIPTION"

Constructors

Instance Methods

instance:attributes(arg0)

This description should be content pulled from the comments above a method in a lua file. Format: "--- @method m_id DESCRIPTION"

Parameters:

• arg0 string This description should be content pulled from the comments above a method in a lua file. Format: "-- @param varName DESCRIPTION"

Returns:

userdata, Map This description should be content pulled from the comments above a method in a lua file. Format: "-- @return DESCRIPTION"

instance:combine(arg0, arg1)

This description should be content pulled from the comments above a method in a lua file. Format: "--- @method m_id DESCRIPTION"

Parameters:

• arg0 string This description should be content pulled from the comments above a method in a lua file. Format: "-- @param varName DESCRIPTION"
• arg1 userdata, String[] This description should be content pulled from the comments above a method in a lua file. Format: "-- @param varName DESCRIPTION"

Returns:

string This description should be content pulled from the comments above a method in a lua file. Format: "-- @return DESCRIPTION"

instance:copy(arg0, arg1)

This description should be content pulled from the comments above a method in a lua file. Format: "--- @method m_id DESCRIPTION"

Parameters:

• arg0 string This description should be content pulled from the comments above a method in a lua file. Format: "-- @param varName DESCRIPTION"
• arg1 string This description should be content pulled from the comments above a method in a lua file. Format: "-- @param varName DESCRIPTION"

instance:create(arg0)

This description should be content pulled from the comments above a method in a lua file. Format: "--- @method m_id DESCRIPTION"

Parameters:

• arg0 string This description should be content pulled from the comments above a method in a lua file. Format: "-- @param varName DESCRIPTION"

Returns:

userdata, FsLib This description should be content pulled from the comments above a method in a lua file. Format: "-- @return DESCRIPTION"

instance:delete(arg0)

This description should be content pulled from the comments above a method in a lua file. Format: "--- @method m_id DESCRIPTION"

Parameters:

• arg0 string This description should be content pulled from the comments above a method in a lua file. Format: "-- @param varName DESCRIPTION"

instance:exists(arg0)

This description should be content pulled from the comments above a method in a lua file. Format: "--- @method m_id DESCRIPTION"

Parameters:

• arg0 string This description should be content pulled from the comments above a method in a lua file. Format: "-- @param varName DESCRIPTION"

Returns:

boolean This description should be content pulled from the comments above a method in a lua file. Format: "-- @return DESCRIPTION"

instance:find(arg0)

This description should be content pulled from the comments above a method in a lua file. Format: "--- @method m_id DESCRIPTION"

Parameters:

• arg0 string This description should be content pulled from the comments above a method in a lua file. Format: "-- @param varName DESCRIPTION"

Returns:

userdata, List This description should be content pulled from the comments above a method in a lua file. Format: "-- @return DESCRIPTION"

instance:getCapacity()

This description should be content pulled from the comments above a method in a lua file. Format: "--- @method m_id DESCRIPTION"

Returns:

int, long This description should be content pulled from the comments above a method in a lua file. Format: "-- @return DESCRIPTION"

instance:getDir(arg0)

This description should be content pulled from the comments above a method in a lua file. Format: "--- @method m_id DESCRIPTION"

Parameters:

• arg0 string This description should be content pulled from the comments above a method in a lua file. Format: "-- @param varName DESCRIPTION"

Returns:

string This description should be content pulled from the comments above a method in a lua file. Format: "-- @return DESCRIPTION"

instance:getFreeSpace()

This description should be content pulled from the comments above a method in a lua file. Format: "--- @method m_id DESCRIPTION"

Returns:

int, long This description should be content pulled from the comments above a method in a lua file. Format: "-- @return DESCRIPTION"

instance:getName(arg0)

This description should be content pulled from the comments above a method in a lua file. Format: "--- @method m_id DESCRIPTION"

Parameters:

• arg0 string This description should be content pulled from the comments above a method in a lua file. Format: "-- @param varName DESCRIPTION"

Returns:

string This description should be content pulled from the comments above a method in a lua file. Format: "-- @return DESCRIPTION"

instance:getSize(arg0)

This description should be content pulled from the comments above a method in a lua file. Format: "--- @method m_id DESCRIPTION"

Parameters:

• arg0 string This description should be content pulled from the comments above a method in a lua file. Format: "-- @param varName DESCRIPTION"

Returns:

int, long This description should be content pulled from the comments above a method in a lua file. Format: "-- @return DESCRIPTION"

instance:isDir(arg0)

This description should be content pulled from the comments above a method in a lua file. Format: "--- @method m_id DESCRIPTION"

Parameters:

• arg0 string This description should be content pulled from the comments above a method in a lua file. Format: "-- @param varName DESCRIPTION"

Returns:

boolean This description should be content pulled from the comments above a method in a lua file. Format: "-- @return DESCRIPTION"

instance:isReadOnly(arg0)

This description should be content pulled from the comments above a method in a lua file. Format: "--- @method m_id DESCRIPTION"

Parameters:

• arg0 string This description should be content pulled from the comments above a method in a lua file. Format: "-- @param varName DESCRIPTION"

Returns:

boolean This description should be content pulled from the comments above a method in a lua file. Format: "-- @return DESCRIPTION"

instance:list(arg0)

This description should be content pulled from the comments above a method in a lua file. Format: "--- @method m_id DESCRIPTION"

Parameters:

• arg0 string This description should be content pulled from the comments above a method in a lua file. Format: "-- @param varName DESCRIPTION"

Returns:

userdata, LuaTable This description should be content pulled from the comments above a method in a lua file. Format: "-- @return DESCRIPTION"

instance:makeDir(arg0)

This description should be content pulled from the comments above a method in a lua file. Format: "--- @method m_id DESCRIPTION"

Parameters:

• arg0 string This description should be content pulled from the comments above a method in a lua file. Format: "-- @param varName DESCRIPTION"

instance:move(arg0, arg1)

This description should be content pulled from the comments above a method in a lua file. Format: "--- @method m_id DESCRIPTION"

Parameters:

• arg0 string This description should be content pulled from the comments above a method in a lua file. Format: "-- @param varName DESCRIPTION"
• arg1 string This description should be content pulled from the comments above a method in a lua file. Format: "-- @param varName DESCRIPTION"

instance:open(arg0, arg1)

This description should be content pulled from the comments above a method in a lua file. Format: "--- @method m_id DESCRIPTION"

Parameters:

• arg0 string This description should be content pulled from the comments above a method in a lua file. Format: "-- @param varName DESCRIPTION"
• arg1 string This description should be content pulled from the comments above a method in a lua file. Format: "-- @param varName DESCRIPTION"

Returns:

userdata, LuaHandle This description should be content pulled from the comments above a method in a lua file. Format: "-- @return DESCRIPTION"