Lua Class - workshop

workshop is a class in the Teverse Lua API that contains 1 properties, 6 methods and 0 events.

This class cannot be constructed, it is managed by Teverse.

Properties
READONLY
string appLocation

Absolute path to the app on the filesystem

CODE SAMPLE
print(workshop.appLocation) --> ""
Methods
table getAppFiles( )

Returns a table of strings

CODE SAMPLE
workshop:getAppFiles() --> {}
boolean openRecent( string path )

Open a app directory returned by teverse.apps:recentDirectories

CODE SAMPLE
workshop:openRecent("") --> true
boolean promptOpen( )

Prompts the user to select their app directory.

CODE SAMPLE
workshop:promptOpen() --> true
string readFile( string file )

Returns the contents of the specified file in the app directory

CODE SAMPLE
workshop:readFile("") --> ""
string serialise( objectBase object )

Serialises the provided object into JSON

CODE SAMPLE
workshop:serialise(objectBase) --> ""
writeFile( string file , string contents )

Writes to the specified file in the app directory

CODE SAMPLE
workshop:writeFile("", "") --> 
Events

Some sections of our docs are maintained on github.