Home

Runtime

Provides access to runtime system

Operations

Copy

Copies data between two byte arrays

function : public : Copy(dest:Byte[], dest_offset:Int, src:Byte[], src_offset:Int, len:Int) ~ Bool
Parameters
NameTypeDescription
destByte[]destination array
dest_offsetIntdestination array copy offset
srcByte[]source array
src_offsetIntsource array copy offset
lenIntnumber of bytes to copy

Return
TypeDescription
Booltrue if successful, false otherwise

Copies data between two character arrays

function : public : Copy(dest:Char[], dest_offset:Int, src:Char[], src_offset:Int, len:Int) ~ Bool
Parameters
NameTypeDescription
destChar[]destination array
dest_offsetIntdestination array copy offset
srcChar[]source array
src_offsetIntsource array copy offset
lenIntnumber of characters to copy

Return
TypeDescription
Booltrue if successful, false otherwise

Copies data between two integer arrays

function : public : Copy(dest:Int[], dest_offset:Int, src:Int[], src_offset:Int, len:Int) ~ Bool
Parameters
NameTypeDescription
destInt[]destination array
dest_offsetIntdestination array copy offset
srcInt[]source array
src_offsetIntsource array copy offset
lenIntnumber of values to copy

Return
TypeDescription
Booltrue if successful, false otherwise

Copies data between two Base arrays

function : public : Copy(dest:Base[], dest_offset:Int, src:Base[], src_offset:Int, len:Int) ~ Bool
Parameters
NameTypeDescription
destBase[]destination array
dest_offsetIntdestination array copy offset
srcBase[]source array
src_offsetIntsource array copy offset
lenIntnumber of values to copy

Return
TypeDescription
Booltrue if successful, false otherwise

Copies data between two Compare arrays

function : public : Copy(dest:Compare[], dest_offset:Int, src:Compare[], src_offset:Int, len:Int) ~ Bool
Parameters
NameTypeDescription
destCompare[]destination array
dest_offsetIntdestination array copy offset
srcCompare[]source array
src_offsetIntsource array copy offset
lenIntnumber of values to copy

Return
TypeDescription
Booltrue if successful, false otherwise

Copies data between two float arrays

function : public : Copy(dest:Float[], dest_offset:Int, src:Float[], src_offset:Int, len:Int) ~ Bool
Parameters
NameTypeDescription
destFloat[]destination array
dest_offsetIntdestination array copy offset
srcFloat[]source array
src_offsetIntsource array copy offset
lenIntnumber of values to copy

Return
TypeDescription
Booltrue if successful, false otherwise

Exit

Causes the executing program to halt

function : public : Exit(code:Int) ~ Nil
Parameters
NameTypeDescription
codeIntexit code

GetInstallDir

Returns the installation directory

function : public : GetInstallDir() ~ String
Return
TypeDescription
Stringinstallation directory

GetPlatform

Returns an OS platform string

function : public : GetPlatform() ~ String
Return
TypeDescription
StringOS platform string

GetProperty

Fetches a runtime property. System properties include: 'user_dir', tmp_dir and 'install_dir'.

function : public : GetProperty(key:String) ~ String
Parameters
NameTypeDescription
keyStringproperty key

Return
TypeDescription
Stringruntime property

GetTempDir

Returns the system's temporary directory

function : public : GetTempDir() ~ String
Return
TypeDescription
Stringsystem's temporary directory

GetTime

Returns the current time

function : public : GetTime(gmt:Bool) ~ Date
Parameters
NameTypeDescription
gmtBooltrue of time is in GMT, false for system time zone

Return
TypeDescription
Datecurrent time

GetUserDir

Returns the current user's working directory

function : public : GetUserDir() ~ String
Return
TypeDescription
Stringcurrent user's working directory

GetVersion

Returns the package version string

function : public : GetVersion() ~ String
Return
TypeDescription
Stringpackage version string

SetProperty

Sets a runtime property

function : public : SetProperty(key:String, value:String) ~ Nil
Parameters
NameTypeDescription
keyStringproperty key
valueStringproperty value