File Shared

A module to work with files in both client and server side

JO Functions

jo.file.isExist()

Checks if a file exists

Syntax

jo.file.isExist(...)

Parameters

modname : string

The file location

Return Value

Type : boolean

Returns true if the file exists, false otherwise

Example

local isExist = jo.file.isExist('module.fileName')
print(isExist)
-- OR --
local isExist = jo.file.isExist('@resource.folder.fileName')
print(isExist)

---

jo.file.load()

Loads and executes a Lua file

Syntax

jo.file.load(modname)

Parameters

modname : string

The file location

Return Value

Type : any

The result of the executed file, or false if there was an error

Example

local file = jo.file.load('module.fileName')
print('File loaded')
-- OR --
local isExist = jo.file.load('@resource.folder.fileName')
print('File loaded')

---

jo.file.loadJson()

Loads a JSON file and returns it decoded

Syntax

jo.file.loadJson(...)

Parameters

... : string

path of the file, without the .json extension

Return Value

Type : table|boolean

The decoded content of the file, or false if there was an error

---

jo.file.read()

Read a file and return it if it's exist or false. The function accept one or two arguments.
One argument: the filepath
Two argument: the resource AND the filepath

Syntax

jo.file.read(...)

Parameters

... : string

path of the file

Return Value

Type : file|boolean,resource|string,modpath|string

Example

local content,resource,modPath = jo.file.read('module.fileName')
print(content,resource,modPath)
-- OR --
local content,resource,modPath = jo.file.read('@resource.folder.fileName')
print(content,resource,modPath)

---

jo.file.readJson()

Read a JSON file and return its content if it's exist or false. The function accept one or two arguments.
One argument: the filepath
Two argument: the resource AND the filepath

Syntax

jo.file.readJson(...)

Parameters

... : string

path of the file, without the .json extension

Return Value

Type : file|boolean,resource|string,modpath|string