System

Module that handles system related utilities. More...

Enumerations
enum	IOFlags { FREAD , FWRITE , FRDWR , FCREATE }
	I/O attributes to use with System.openFile. More...
enum	IOSeek { SET , CUR , END }
	I/O seek modes to use with System.seekFile. More...
enum	PowerTimer { AUTO_SUSPEND_TIMER , SCREEN_OFF_TIMER , SCREEN_DIMMING_TIMER }
	Power management timer features. More...
enum	ImgFmt { FORMAT_BMP , FORMAT_JPG , FORMAT_PNG }
	Image format modes to use with System.takeScreenshot. More...
enum	BtnMode {   BUTTON_NONE , BUTTON_OK , BUTTON_CANCEL , BUTTON_OK_CANCEL ,   BUTTON_YES_NO }
	Buttons schemes for System.setMessage. More...
enum	DlgState { RUNNING , FINISHED , CANCELED }
	Dialog states for system messages and system keyboard. More...
enum	MntPerm { READ_ONLY , READ_WRITE }
	Mount permissions for partition mounting. More...

Functions
int	System::openFile (string filename, IOFlags flags)
	Open a file.
void	System::writeFile (int handle, string text, int len)
	Write into an opened file.
string	System::readFile (int handle, int len)
	Read from an opened file.
void	System::seekFile (int handle, int pos, IOSeek seek)
	Move cursor of an opened file.
int	System::sizeFile (int handle)
	Calculate size of an opened file in bytes.
table	System::statFile (string filename)
	Extract info of a file/directory.
table	System::statOpenedFile (int handle)
	Extract info of an opened file.
void	System::closeFile (int handle)
	Close an opened file.
bool	System::doesFileExist (string filename)
	Check if a file exists.
bool	System::doesDirExist (string dirname)
	Check if a folder exists.
void	System::rename (string filename, string filename2)
	Rename or move a file.
void	System::copyFile (string filename, string filename2)
	Copy a file.
void	System::deleteFile (string filename)
	Delete a file.
void	System::deleteDirectory (string dirname)
	Delete a directory.
void	System::createDirectory (string dirname)
	Create a new directory.
table	System::listDirectory (string dirname)
	List a directory contents.
void	System::exit (void)
	Close the interpreter.
string	System::getFirmware (void)
	Get unspoofed system firmware version.
string	System::getSpoofedFirmware (void)
	Get spoofed system firmware version.
string	System::getFactoryFirmware (void)
	Get factory system firmware version.
void	System::wait (int msecs)
	Sleep the application for a certain time.
bool	System::isBatteryCharging (void)
	Check if the battery is under charge.
int	System::getBatteryPercentage (void)
	Get current battery life percentage.
int	System::getBatteryLife (void)
	Get current battery life.
int	System::getBatteryCapacity (void)
	Get current battery capacity.
int	System::getBatteryFullCapacity (void)
	Get full battery capacity.
int	System::getBatteryTemp (void)
	Get battery temperature.
int	System::getBatteryVolt (void)
	Get battery voltage.
int	System::getBatteryHealth (void)
	Get battery state of health percentage.
int	System::getBatteryCycles (void)
	Get battery cycles count.
void	System::disableTimer (PowerTimer timer)
	Disable a power management timer feature.
void	System::enableTimer (PowerTimer timer)
	Enable a power management timer feature.
void	System::resetTimer (PowerTimer timer)
	Reset a power management timer feature.
void	System::setCpuSpeed (int clock)
	Set CPU clock speed.
void	System::setGpuSpeed (int clock)
	Set GPU clock speed.
void	System::setBusSpeed (int clock)
	Set BUS clock speed.
int	System::getCpuSpeed (void)
	Get CPU clock speed.
int	System::getGpuSpeed (void)
	Get GPU clock speed.
int	System::getBusSpeed (void)
	Get BUS clock speed.
int	System::getGpuXbarSpeed (void)
	Get GPU Crossbar clock speed.
void	System::launchEboot (string filename)
	Launches a binary file.
void	System::launchApp (string titleid)
	Launches an installed application.
void	System::getFreeSpace (string dev)
	Get free space for a given device.
void	System::getTotalSpace (string dev)
	Get total space for a given device.
int[]	System::getTime (void)
	Get console time.
int[]	System::getDate (void)
	Get console date.
string	System::getUsername (void)
	Get account username.
int	System::getLanguage (void)
	Get console language.
int	System::getModel (void)
	Get console model.
string	System::getPsId (void)
	Get console unique PsId.
string	System::getTitle (void)
	Get running application title.
string	System::getTitleID (void)
	Get running application title ID.
table	System::extractSfo (string filename)
	Extract info from an SFO file.
void	System::extractPbp (string filename, string dirname)
	Extract a PBP file (synchronous).
void	System::extractZip (string filename, string dirname)
	Extract a ZIP file (synchronous).
void	System::extractFromZip (string filename, string file, string destname)
	Extract a specific file from a ZIP file (synchronous).
void	System::extractZipAsync (string filename, string dirname)
	Extract a ZIP file (asynchronous).
void	System::extractFromZipAsync (string filename, string file, string destname)
	Extract a specific file from a ZIP file (asynchronous).
void	System::compressZip (string path, string filename, int ratio)
	Compress a file or a folder in a ZIP file (synchronous).
void	System::addToZip (string path, string filename, string parent, int ratio)
	Add a file or a folder in a ZIP file (synchronous).
int	System::getAsyncState (void)
	Get current state of an asynchronous task.
string	System::getAsyncResult (void)
	Get result from a finished asynchronous task.
void	System::takeScreenshot (string filename, ImgFmt format, int ratio)
	Take a screenshot.
void	System::executeUri (string uri)
	Execute an URI call.
int	System::reboot (void)
	Reboot the console.
int	System::shutdown (void)
	Shutdown the console.
int	System::standby (void)
	Put the console in standby.
bool	System::isSafeMode (void)
	Get if application is running in safe mode.
void	System::setMessage (string text, bool progressbar, BtnMode buttons)
	Start a system message instance.
DlgState	System::getMessageState (void)
	Get current system message instance state.
void	System::setMessageProgress (int progress)
	Set current progress for the system message instance.
void	System::setMessageProgMsg (string text)
	Set a submessage for the system message instance.
void	System::closeMessage (void)
	Close the current system message instance.
void	System::unmountPartition (int idx)
	Unmount an already mounted partition.
void	System::mountPartition (int idx, MntPerm perms)
	Mount an unmounted partition.
void	System::installApp (string dir)
	Install an extracted app.
void	System::uninstallApp (string titleid)
	Uninstall an installed app.
bool	System::doesAppExist (string titleid)
	Check if an app is installed.
string	System::getBootParams (void)
	Retrieve params used at app boot.
int	System::loadUserPlugin (string path)
	Load and start an user plugin.
int	System::loadKernelPlugin (string path)
	Load and start a kernel plugin.
void	System::unloadUserPlugin (int plug_id)
	Stop and unload an user plugin.
void	System::unmountMountpoint (string mnt)
	Unmount a virtual mountpoint.
void	System::consolePrint (string text)
	Print a message on system console.

Detailed Description

Module that handles system related utilities.

Enumeration Type Documentation

IOFlags

enum IOFlags

I/O attributes to use with System.openFile.

Enumerator
FREAD	Read attribute.
FWRITE	Write attribute.
FRDWR	Read/Write attribute.
FCREATE	Create/Write attribute.

IOSeek

enum IOSeek

I/O seek modes to use with System.seekFile.

Enumerator
SET	Starts from the begin of the file.
CUR	Starts from current position.
END	Starts from the end of the file.

PowerTimer

enum PowerTimer

Power management timer features.

Enumerator
AUTO_SUSPEND_TIMER	Automatic console suspension.
SCREEN_OFF_TIMER	Automatic screen disabling.
SCREEN_DIMMING_TIMER	Automatic screen dimming.

ImgFmt

enum ImgFmt

Image format modes to use with System.takeScreenshot.

Enumerator
FORMAT_BMP	32bpp BMP format.
FORMAT_JPG	JPG format.
FORMAT_PNG	8bpp paletted PNG format.

BtnMode

enum BtnMode

Buttons schemes for System.setMessage.

Enumerator
BUTTON_NONE	No buttons.
BUTTON_OK	OK button only.
BUTTON_CANCEL	CANCEL button only.
BUTTON_OK_CANCEL	OK and CANCEL buttons.
BUTTON_YES_NO	YES and NO buttons.

DlgState

enum DlgState

Dialog states for system messages and system keyboard.

Enumerator
RUNNING	Dialog running.
FINISHED	Dialog finished successfully.
CANCELED	Dialog canceled by user.

MntPerm

enum MntPerm

Mount permissions for partition mounting.

Enumerator
READ_ONLY	Read only permissions.
READ_WRITE	Read/Write permissions.

Function Documentation

openFile()

int System::openFile	(	string	filename,
		IOFlags	flags
	)

Open a file.

Usage example:

handle = System.openFile("ux0:/data/file.txt", FREAD)

Parameters

filename	- Filename to be opened.
flags	- An attribute flag.

Returns

A valid file handle.

writeFile()

void System::writeFile	(	int	handle,
		string	text,
		int	len
	)

Write into an opened file.

Usage example:

System.writeFile(handle, "Test", 4)

Parameters

handle	- A file handle opened with System.openFile.
text	- The text to write on file.
len	- Length of the text.

readFile()

string System::readFile	(	int	handle,
		int	len
	)

Read from an opened file.

Usage example:

text = System.readFile(handle, 4)

Parameters

handle	- A file handle opened with System.openFile.
len	- Length of the string to read in bytes.

Returns

The read string.

seekFile()

void System::seekFile	(	int	handle,
		int	pos,
		IOSeek	seek
	)

Move cursor of an opened file.

Usage example:

System.seekFile(handle, 0, END)

Parameters

handle	- A file handle opened with System.openFile.
pos	- Position to set.
seek	- Start point for the position.

sizeFile()

int System::sizeFile

(

int

handle

)

Calculate size of an opened file in bytes.

Usage example:

size = System.sizeFile(handle)

Parameters

handle

- A file handle opened with System.openFile.

Returns

Filesize in bytes.

statFile()

table System::statFile

(

string

filename

)

Extract info of a file/directory.

Usage example:

info = System.statFile("ux0:/data/file.txt")
creation_year = info.creation_time.year
last_access_year = info.access_time.year
last_modification_year = info.mod_time.year
is_directory = info.directory
filesize = info.size

Parameters

filename

- Filename to be checked.

Returns

A table with a proper set of info (Look at the sample above).

statOpenedFile()

table System::statOpenedFile

(

int

handle

)

Extract info of an opened file.

Usage example:

info = System.statOpenedFile(handle)
creation_year = info.creation_time.year
last_access_year = info.access_time.year
last_modification_year = info.mod_time.year
is_directory = info.directory
filesize = info.size

Parameters

handle

- A file handle opened with System.openFile.

Returns

A table with a proper set of info (Look at the sample above).

closeFile()

void System::closeFile

(

int

handle

)

Close an opened file.

Usage example:

System.closeFile(handle)

Parameters

handle

- A file handle opened with System.openFile.

doesFileExist()

bool System::doesFileExist

(

string

filename

)

Check if a file exists.

Usage example:

if System.doesFileExist("ux0:/data/file.txt") then
        handle = System.openFile("ux0:/data/file.txt", FREAD)
end

Parameters

filename

- Filename to be checked.

Returns

true if exists, false otherwise.

doesDirExist()

bool System::doesDirExist

(

string

dirname

)

Check if a folder exists.

Usage example:

if System.doesDirExist("ux0:/data") then
        list = System.listDirectory("ux0:/data")
end

Parameters

dirname

- Folder name to be checked.

Returns

true if exists, false otherwise.

rename()

void System::rename	(	string	filename,
		string	filename2
	)

Rename or move a file.

Usage example:

System.rename("ux0:/data/old.txt", "ux0:/data/new.txt")

Parameters

filename	- Filename to be renamed.
filename2	- New filename.

copyFile()

void System::copyFile	(	string	filename,
		string	filename2
	)

Copy a file.

Usage example:

System.copyFile("ux0:/data/old.txt", "ux0:/data/new.txt")

Parameters

filename	- Filename to be copied.
filename2	- New filename.

deleteFile()

void System::deleteFile

(

string

filename

)

Delete a file.

Usage example:

System.deleteFile("ux0:/data/file.txt")

Parameters

filename

- Filename to be removed.

deleteDirectory()

void System::deleteDirectory

(

string

dirname

)

Delete a directory.

Usage example:

System.deleteDirectory("ux0:/data/dir")

Parameters

dirname

- Path to be removed.

createDirectory()

void System::createDirectory

(

string

dirname

)

Create a new directory.

Usage example:

System.createDirectory("ux0:/data/dir")

Parameters

dirname

- Path to be created.

listDirectory()

table System::listDirectory

(

string

dirname

)

List a directory contents.

Usage example:

files = System.listDirectory("ux0:/data/dir")
name = files[0].name
size = files[0].size
is_directory = files[0].directory

Parameters

dirname

- Path to be listed.

Returns

A table with the listed files info (See the example above).

exit()

void System::exit

(

void

)

Close the interpreter.

Usage example:

System.exit()

getFirmware()

string System::getFirmware

(

void

)

Get unspoofed system firmware version.

Usage example:

fw = System.getFirmware()

Returns

The unspoofed system firmware version.

Note

This function is available only in unsafe mode.

getSpoofedFirmware()

string System::getSpoofedFirmware

(

void

)

Get spoofed system firmware version.

Usage example:

fw = System.getSpoofedFirmware()

Returns

The spoofed system firmware version.

getFactoryFirmware()

string System::getFactoryFirmware

(

void

)

Get factory system firmware version.

Usage example:

fw = System.getFactoryFirmware()

Returns

The factory system firmware version.

Note

This function is available only in unsafe mode.

wait()

void System::wait

(

int

msecs

)

Sleep the application for a certain time.

Usage example:

System.wait(1000000)

Parameters

msecs

- Time to wait in microseconds.

isBatteryCharging()

bool System::isBatteryCharging

(

void

)

Check if the battery is under charge.

Usage example:

if System.isBatteryCharging() then
        Graphics.debugPrint(0, 0, "Battery is charging", Color.new(255, 255, 255))
end

Returns

true if charging, false otherwise.

getBatteryPercentage()

int System::getBatteryPercentage

(

void

)

Get current battery life percentage.

Usage example:

life = System.getBatteryPercentage()

Returns

The battery life percentage.

getBatteryLife()

int System::getBatteryLife

(

void

)

Get current battery life.

Usage example:

life = System.getBatteryLife()

Returns

The battery life in minutes.

getBatteryCapacity()

int System::getBatteryCapacity

(

void

)

Get current battery capacity.

Usage example:

cap = System.getBatteryCapacity()

Returns

The battery capacity in mAh.

getBatteryFullCapacity()

int System::getBatteryFullCapacity

(

void

)

Get full battery capacity.

Usage example:

cap_max = System.getBatteryFullCapacity()

Returns

The battery full capacity in mAh.

getBatteryTemp()

int System::getBatteryTemp

(

void

)

Get battery temperature.

Usage example:

temp = System.getBatteryTemp()

Returns

The battery temperature in Celsius.

getBatteryVolt()

int System::getBatteryVolt

(

void

)

Get battery voltage.

Usage example:

voltage = System.getBatteryVolt()

Returns

The battery voltage in mV.

getBatteryHealth()

int System::getBatteryHealth

(

void

)

Get battery state of health percentage.

Usage example:

soh = System.getBatteryHealth()

Returns

The battery state of health percentage.

getBatteryCycles()

int System::getBatteryCycles

(

void

)

Get battery cycles count.

Usage example:

cycles = System.getBatteryCycles()

Returns

The battery cycles count.

disableTimer()

void System::disableTimer

(

PowerTimer

timer

)

Disable a power management timer feature.

Usage example:

System.disableTimer(SCREEN_DIMMING_TIMER)

Parameters

timer

- The timer feature to disable.

enableTimer()

void System::enableTimer

(

PowerTimer

timer

)

Enable a power management timer feature.

Usage example:

System.enableTimer(SCREEN_DIMMING_TIMER)

Parameters

timer

- The timer feature to enable.

resetTimer()

void System::resetTimer

(

PowerTimer

timer

)

Reset a power management timer feature.

Usage example:

System.resetTimer(SCREEN_DIMMING_TIMER)

Parameters

timer

- The timer feature to reset.

setCpuSpeed()

void System::setCpuSpeed

(

int

clock

)

Set CPU clock speed.

Usage example:

System.setCpuSpeed(444)

Parameters

clock

- The clock to set in Mhz.

Note

Clock must be between 0 and 444.

setGpuSpeed()

void System::setGpuSpeed

(

int

clock

)

Set GPU clock speed.

Usage example:

System.setGpuSpeed(222)

Parameters

clock

- The clock to set in Mhz.

Note

Clock must be between 0 and 222.

setBusSpeed()

void System::setBusSpeed

(

int

clock

)

Set BUS clock speed.

Usage example:

System.setBusSpeed(222)

Parameters

clock

- The clock to set in Mhz.

Note

Clock must be between 0 and 222.

getCpuSpeed()

int System::getCpuSpeed

(

void

)

Get CPU clock speed.

Usage example:

clock = System.getCpuSpeed()

Returns

The CPU clock speed in Mhz.

getGpuSpeed()

int System::getGpuSpeed

(

void

)

Get GPU clock speed.

Usage example:

clock = System.getGpuSpeed()

Returns

The GPU clock speed in Mhz.

getBusSpeed()

int System::getBusSpeed

(

void

)

Get BUS clock speed.

Usage example:

clock = System.getBusSpeed()

Returns

The BUS clock speed in Mhz.

getGpuXbarSpeed()

int System::getGpuXbarSpeed

(

void

)

Get GPU Crossbar clock speed.

Usage example:

clock = System.getGpuXbarSpeed()

Returns

The GPU Crossbar clock speed in Mhz.

launchEboot()

void System::launchEboot

(

string

filename

)

Launches a binary file.

Usage example:

System.launchEboot("app0:/updater.bin")

Parameters

filename

- The file to start.

Note

The binary file to launch must be in app0 partition.

launchApp()

void System::launchApp

(

string

titleid

)

Launches an installed application.

Usage example:

System.launchApp("MLCL00001")

Parameters

titleid

- The title ID of the application to start.

getFreeSpace()

void System::getFreeSpace

(

string

dev

)

Get free space for a given device.

Usage example:

Graphics.debugPrint(5, 5, System.getFreeSpace("ux0:") .. "/" .. System.getTotalSpace("ux0:"), Color.new(255, 255, 255))

Parameters

dev	- The device name.

getTotalSpace()

void System::getTotalSpace

(

string

dev

)

Get total space for a given device.

Usage example:

Graphics.debugPrint(5, 5, System.getFreeSpace("ux0:") .. "/" .. System.getTotalSpace("ux0:"), Color.new(255, 255, 255))

Parameters

dev	- The device name.

getTime()

int[] System::getTime

(

void

)

Get console time.

Usage example:

h,m,s = System.getTime()

Returns

Three values owning hours, minutes and seconds.

getDate()

int[] System::getDate

(

void

)

Get console date.

Usage example:

day_num, d, m, y = System.getDate()
if day_num == 1 then
        day_name = "Monday"
end

Returns

Four values owning day value, day, month, year.

getUsername()

string System::getUsername

(

void

)

Get account username.

Usage example:

username = System.getUsername()

Returns

The username set on the running console account.

getLanguage()

int System::getLanguage

(

void

)

Get console language.

Usage example:

lang = System.getLanguage()

Returns

The language ID currently set on the console.

Note

For the available language IDs look at this.

getModel()

int System::getModel

(

void

)

Get console model.

Usage example:

model = System.getModel()

Returns

0x10000 if PSVITA, 0x20000 if PSTV.

getPsId()

string System::getPsId

(

void

)

Get console unique PsId.

Usage example:

psid = System.getPsId()

Returns

The console unique PsId.

getTitle()

string System::getTitle

(

void

)

Get running application title.

Usage example:

title = System.getTitle()

Returns

The running application title.

getTitleID()

string System::getTitleID

(

void

)

Get running application title ID.

Usage example:

title_id = System.getTitleID()

Returns

The running application title ID.

extractSfo()

table System::extractSfo

(

string

filename

)

Extract info from an SFO file.

Usage example:

info = System.extractSfo("app0:/sce_sys/param.sfo")
app_version = info.version
app_title = info.title
app_short_title = info.short_title
app_category = info.category
app_titleid = info.titleid

Parameters

filename

- The filename to extract info from.

Returns

A table with a proper set of info (Look at the sample above).

Note

This function can be used also to extract info from PARAM.SFO bundled inside PBP files.

extractPbp()

void System::extractPbp	(	string	filename,
		string	dirname
	)

Extract a PBP file (synchronous).

Usage example:

System.extractPbp("app0:/files.zip", "ux0:/data/app_files")

Parameters

filename	- The filename to extract.
dirname	- The path where to extract files.

Note

If dirname doesn't exist, it will be automatically created.

extractZip()

void System::extractZip	(	string	filename,
		string	dirname
	)

Extract a ZIP file (synchronous).

Usage example:

System.extractZip("app0:/files.zip", "ux0:/data/app_files")

Parameters

filename	- The filename to extract.
dirname	- The path where to extract files.

Note

If dirname doesn't exist, it will be automatically created.

extractFromZip()

void System::extractFromZip	(	string	filename,
		string	file,
		string	destname
	)

Extract a specific file from a ZIP file (synchronous).

Usage example:

System.extractFromZip("app0:/files.zip", "image.jpg", "ux0:/data/app_files/my_image.jpg")

Parameters

filename	- The filename of the ZIP archive.
file	- The file to extract.
destname	- The filename where to extract file.

extractZipAsync()

void System::extractZipAsync	(	string	filename,
		string	dirname
	)

Extract a ZIP file (asynchronous).

Usage example:

System.extractZipAsync("app0:/files.zip", "ux0:/data/app_files")

Parameters

filename	- The filename to extract.
dirname	- The path where to extract files.

Note

If dirname doesn't exist, it will be automatically created.

extractFromZipAsync()

void System::extractFromZipAsync	(	string	filename,
		string	file,
		string	destname
	)

Extract a specific file from a ZIP file (asynchronous).

Usage example:

System.extractFromZipAsync("app0:/files.zip", "image.jpg", "ux0:/data/app_files/my_image.jpg")

Parameters

filename	- The filename of the ZIP archive.
file	- The file to extract.
destname	- The filename where to extract file.

compressZip()

void System::compressZip	(	string	path,
		string	filename,
		int	ratio
	)

Compress a file or a folder in a ZIP file (synchronous).

Usage example:

System.compressZip("app0:/sce_sys", "ux0:/data/file.zip", 9)

Parameters

path	- The filename or path to compress.
filename	- The filename of the resulting zip file.
ratio	- The compression ratio to use (optional).

Note

ratio must be between 0 and 9.

addToZip()

void System::addToZip	(	string	path,
		string	filename,
		string	parent,
		int	ratio
	)

Add a file or a folder in a ZIP file (synchronous).

Usage example:

System.addToZip("app0:/sce_sys/icon0.png", "ux0:/data/file.zip", "sce_sys", 9)

Parameters

path	- The filename or path to compress.
filename	- The filename of the resulting zip file.
parent	- The parent folder inside the zip file where to place the path.
ratio	- The compression ratio to use (optional).

Note

ratio must be between 0 and 9.

getAsyncState()

int System::getAsyncState

(

void

)

Get current state of an asynchronous task.

Usage example:

while System.getAsyncState() == 0 do
    running = true
end
running = false

Returns

0 if running, 1 if successfully finished, -1 otherwise.

getAsyncResult()

string System::getAsyncResult

(

void

)

Get result from a finished asynchronous task.

Usage example:

if System.getAsyncState() == 1 then
    res = System.getAsyncResult()
end

Returns

A string with the result for Network.requestStringAsync() result, nil otherwise.

takeScreenshot()

void System::takeScreenshot	(	string	filename,
		ImgFmt	format,
		int	ratio
	)

Take a screenshot.

Usage example:

System.takeScreenshot("ux0:/data/shot.jpg", FORMAT_JPG, 255)

Parameters

filename	- The filename of the screenshot output.
format	- The format to use for the output file (optional).
ratio	- Compression ratio for JPG compression (optional).

Note

ratio must be between 0 and 255.

executeUri()

void System::executeUri

(

string

uri

)

Execute an URI call.

Usage example:

System.executeUri("psgm:play?titleid=MLCL00001")

Parameters

uri	- URI to exec.

reboot()

int System::reboot

(

void

)

Reboot the console.

Usage example:

System.reboot()

shutdown()

int System::shutdown

(

void

)

Shutdown the console.

Usage example:

System.shutdown()

standby()

int System::standby

(

void

)

Put the console in standby.

Usage example:

System.standby()

isSafeMode()

bool System::isSafeMode

(

void

)

Get if application is running in safe mode.

Usage example:

if System.isSafeMode() then
        mode = "safe"
end

Returns

true if in safe mode, false otherwise.

setMessage()

void System::setMessage	(	string	text,
		bool	progressbar,
		BtnMode	buttons
	)

Start a system message instance.

Usage example:

System.setMessage("Do you want to start this app?", false, BUTTON_YES_NO)

Parameters

text	- The text of the system message.
progressbar	- Progressbar mode.
buttons	- Buttons scheme to use (optional).

Note

If progressbar is true, buttons will not affect the system message.

getMessageState()

DlgState System::getMessageState

(

void

)

Get current system message instance state.

Usage example:

state = System.getMessageState()

Returns

Current state of the system message instance.

setMessageProgress()

void System::setMessageProgress

(

int

progress

)

Set current progress for the system message instance.

Usage example:

System.setMessageProgress(10)

Parameters

progress

- Progress percentage.

Note

This function affects only progressbar system messages.

progress must be between 0 and 100.

setMessageProgMsg()

void System::setMessageProgMsg

(

string

text

)

Set a submessage for the system message instance.

Usage example:

System.setMessageProgMsg("10%%")

Parameters

text	- Submessage text to set.

Note

This function affects only progressbar system messages.

closeMessage()

void System::closeMessage

(

void

)

Close the current system message instance.

Usage example:

System.closeMessage()

unmountPartition()

void System::unmountPartition

(

int

idx

)

Unmount an already mounted partition.

Usage example:

System.unmountPartition(0x300)

Parameters

idx	- The index number of the partition.

Note

For the index value, look at VSH Mount ID here.

This function is available only in unsafe mode.

mountPartition()

void System::mountPartition	(	int	idx,
		MntPerm	perms
	)

Mount an unmounted partition.

Usage example:

System.mountPartition(0x300, READ_WRITE)

Parameters

idx	- The index number of the partition.
perms	- Permissions to set for the mounted partition.

Note

For the index value, look at VSH Mount ID here.

This function is available only in unsafe mode.

installApp()

void System::installApp

(

string

dir

)

Install an extracted app.

Usage example:

System.installApp("ux0:/vitaQuake")

Parameters

dir	- The path to the extracted app.

Note

This function is available only in unsafe mode.

uninstallApp()

void System::uninstallApp

(

string

titleid

)

Uninstall an installed app.

Usage example:

System.uninstallApp("GTAVCECTY")

Parameters

titleid

- The titleid of the app to uninstall.

Note

This function is available only in unsafe mode.

doesAppExist()

bool System::doesAppExist

(

string

titleid

)

Check if an app is installed.

Usage example:

if System.doesAppExist("GTAVCECTY") then
 System.uninstallApp("GTAVCECTY")
end

Parameters

titleid

- The titleid of the app to check.

Returns

true if installed, false otherwise.

Note

This function is available only in unsafe mode.

getBootParams()

string System::getBootParams

(

void

)

Retrieve params used at app boot.

Usage example:

args = System.getBootParams()

Returns

The params passed to the app when it got launched.

loadUserPlugin()

int System::loadUserPlugin

(

string

path

)

Load and start an user plugin.

Usage example:

plug_id = System.loadUserPlugin("ux0:data/plugin.suprx")

Parameters

path	- The path to the plugin to load.

Returns

An identifier to the loaded module.

Note

This function is available only in unsafe mode.

loadKernelPlugin()

int System::loadKernelPlugin

(

string

path

)

Load and start a kernel plugin.

Usage example:

plug_id = System.loadKernelPlugin("ux0:data/plugin.skprx")

Parameters

path	- The path to the plugin to load.

Returns

An identifier to the loaded module.

Note

This function is available only in unsafe mode.

unloadUserPlugin()

void System::unloadUserPlugin

(

int

plug_id

)

Stop and unload an user plugin.

Usage example:

System.unloadUserPlugin(plug_id)

Parameters

plug_id

- The module identifier for the plugin to unload.

Note

This function is available only in unsafe mode.

unmountMountpoint()

void System::unmountMountpoint

(

string

mnt

)

Unmount a virtual mountpoint.

Usage example:

System.unmountMountpoint("app0:")

Parameters

mnt	- The mountpoint to unmount.

Note

This function is available only in unsafe mode.

consolePrint()

void System::consolePrint

(

string

text

)

Print a message on system console.

Usage example:

System.consolePrint("Hello World!")

Parameters

text	- The text to print.