Aurora Scripts

Aurora's Lua scripting API can be used to extend the functionality of Aurora through custom community-contributed filters, sorts, subtitles, and utility scripts. The API exposes global, script, and library functions for integrating into Aurora's user interface, and accessing underlying system internals.

Table of Contents

• Global Functions
• Script Functions
• Library Methods
  • Aurora
  • Content
  • FileSystem
  • Http
  • IniFile
  • Kernel
  • Profile
  • Settings
  • Sql
  • Thread
  • ZipFile
  • GizmoUI
• XUI
  • XuiObject
    • XuiElement
    • XuiText
    • XuiImage
    • XuiControl
      • XuiButton
      • XuiRadioButton
      • XuiRadioGroup
      • XuiLabel
      • XuiEdit
      • XuiList
      • XuiProgressBar
      • XuiSlider
      • XuiCheckbox
      • XuiScene
        • XuiTabScene

Global Functions

voidprint( stringval );
voidtprint( tableval );
tableenum( arrayval );
voidwait( unsignedval );
unsignedtounsigned( intval );

Script Functions

voidScript.SetRefreshListOnExit( boolrefreshList );
voidScript.FileExists( stringrelativePath );
voidScript.CreateDirectory( stringrelativePath );
voidScript.SetProgress( unsignedval );
voidScript.SetStatus( stringtext );
unsignedScript.GetProgress( void );
stringScript.GetStatus( void );
boolScript.IsCanceled( void );
stringScript.GetBasePath( void );
voidScript.ShowNotification( stringmessage, DWORDtype );
tableScript.ShowKeyboard( stringtitle, stringprompt, stringdefault, [DWORDflags] );
tableScript.ShowPopupList( stringtitle, stringemptyList, tablelistContent );
tableScript.ShowPasscode( stringtitle, stringprompt, DWORDpermissionFlag );
tableScript.ShowMessageBox( stringtitle, stringprompt, stringbutton1text, [string...]);
tableScript.ShowFilebrowser( stringbasePath, stringselectedItem, [DWORDflags] );

Library Methods

Aurora

tableAurora.GetDashVersion( void );
tableAurora.GetSkinVersion( void );
tableAurora.GetFSPluginVersion( void );
stringAurora.GetIPAddress( void );
stringAurora.GetMACAddress( void );
tableAurora.GetTime( void );
tableAurora.GetDate( void );
tableAurora.GetTemperatures( void );
tableAurora.GetMemoryInfo( void );
tableAurora.GetCurrentSkin( void );
tableAurora.GetCurrentLanguage( void );
voidAurora.OpenDVDTray( void );
voidAurora.CloseDVDTray( void );
unsignedAurora.GetDVDTrayState( void );
boolAurora.HasInternetConnection( void );
voidAurora.Restart( void );
voidAurora.Reboot( void );
voidAurora.Shutdown( void );
stringAurora.Sha1Hash( stringinput );
stringAurora.Md5Hash( stringinput );
stringAurora.Crc32Hash( stringinput );
stringAurora.Sha1HashFile( stringfilePath );
stringAurora.Md5HashFile( stringfilePath );
stringAurora.Crc32HashFile( stringfilePath );

Content

tableContent.GetInfo( DWORDcontentId );
boolContent.SetTitle( DWORDcontentId, stringtitle );
boolContent.SetDescription( DWORDcontentId, stringdescription );
boolContent.SetDeveloper( DWORDcontentId, stringdeveloper );
boolContent.SetPublisher( DWORDcontentId, stringpublisher );
boolContent.SetReleaseDate( DWORDcontentId, stringreleaseDate );
boolContent.SetAsset( stringimagePath, enumassetType, [DWORDscreenshotIndex]);
tableContent.FindContent( DWORDtitleId, [stringsearchText]);

FileSystem

boolFileSystem.CopyDirectory( stringsrcDir, stringdstDir, booloverwrite, [functionprogressRoutine] );
boolFileSystem.MoveDirectory( stringsrcDir, stringdstDir, booloverwrite, [functionprogressRoutine] );
boolFileSystem.DeleteDirectory( stringdirectory );
boolFileSystem.CreateDirectory( stringdirectory );
boolFileSystem.CopyFile( stringsrcFile, stringdstFile, booloverwrite, [functionprogressRoutine] );
boolFileSystem.MoveFile( stringsrcFile, stringdstFile, booloverwrite, [functionprogressRoutine] );
boolFileSystem.DeleteFile( stringsrcFile );
stringFilesystem.ReadFile( stringsrcFile );
boolFileSystem.WriteFile( stringsrcFile, stringbuffer );
boolFileSystem.FileExists( stringpath );
unsignedFileSystem.GetFileSize( stringpath );
unsignedFileSystem.GetAttributes( stringpath );
tableFileSystem.GetDrives( [booleancontentDrivesOnly] )
tableFileSystem.GetFilesAndDirectories( stringpath );
tableFileSystem.GetFiles( stringpath );
tableFileSystem.GetDirectories( stringpath );
boolFileSystem.Rename( stringoriginal, stringnew );

Http

tableHttp.Get( stringurl, [stringrelativeFilePath] );
tableHttp.Post( stringurl, tablepostvars, [stringrelativeFilePath] );
stringHttp.UrlEncode( stringinput );
stringHttp.UrlDecode( stringinput );

IniFile

userdataIniFile.LoadFile( stringrelativeFilePath );
userdataIniFile.LoadString( stringfileData );

Userdata Methods:

stringuserdata:ReadValue( stringsection, stringkey, stringdefault );
booluserdata:WriteValue( stringsection, stringkey, stringvalue );
tableuserdata:GetAllSections( void );
tableuserdata:GetSection( stringsection );
tableuserdata:GetAllKeys( stringsection );

Kernel

tableKernel.GetVersion( void );
unsignedKernel.GetConsoleTiltState( void );
stringKernel.GetCPUKey( void );
stringKernel.GetDVDKey( void );
stringKernel.GetMotherboardType( void );
stringKernel.GetConsoleType( void );
stringKernel.GetConsoleId( void );
stringKernel.GetSerialNumber( void );
unsignedKernel.GetCPUTempThreshold( void );
unsignedKernel.GetGPUTempThreshold( void );
unsignedKernel.GetEDRAMTempThreshold( void );
boolKernel.SetFanSpeed( unsignedfanSpeed );
boolKernel.SetCPUTempThreshold( unsignedthreshold );
boolKernel.SetGPUTempThreshold( unsignedthreshold );
boolKernel.SetEDRAMTempThreshold( unsignedthreshold );
voidKernel.RebootSMCRoutine( void );
boolKernel.SetDate(unsignedYear, unsignedMonth, unsignedDay);
boolKernel.SetTime(unsignedHour, [unsignedMinute, unsignedSecond, unsignedMillisecond]);

Profile

stringProfile.GetXUID( unsignedplayerIndex );
stringProfile.GetGamerTag( unsignedplayerIndex );
unsignedProfile.GetGamerScore( unsignedplayerIndex );
tableProfile.GetTitleAchievement( unsignedplayerIndex, unsignedtitleId );

Settings

tableSettings.GetSystem( [string, ...] );
tableSettings.GetUser( [string, ...] );
tableSettings.SetSystem( stringname, stringvalue, [ string, string...] );
tableSettings.SetUser( stringname, stringvalue, [ string, string...] );
tableSettings.GetSystemOptions( stringname );
tableSettings.GetUserOptions( stringname );
tableSettings.GetOptions( stringname, unsignedsettingType );

Sql

boolSql.Execute( stringquery );
boolSql.ExecuteFetchRows( stringquery );

Thread

voidThread.Sleep( unsigned );

ZipFile

userdataZipFile.OpenFile( stringrelativeFilePath );

Userdata Methods:

booluserdata:Extract( stringrelativeDestDir );

GizmoUI

userdataGizmoUI.CreateInstance( void );

Userdata Methods:

booluserdata:RegisterCallback( unsignedmessageType, functionfnCallback );
booluserdata:RegisterAnimationCallback( stringnamedFrame, functionfnCallback );
userdatauserdata:RegisterControl( unsignedobjectType, stringobjectName );
voiduserdata:Dismiss( objectkey );
objectuserdata:InvokeUI( stringbasePath, stringtitle, stringsceneFile, [stringskinFile], [tableinitData] );
booluserdata:SetCommandText( unsignedcommandId, stringtext );
booluserdata:SetCommandEnabled( unsignedcommandId, boolstate );
booluserdata:SetTimer( unsignedtimerId, unsignedtimerInterval );
booluserdata:KillTimer( unsignedtimerId );
booluserdata:PlayTimeline( stringstartFrame, stringinitialFrame, stringendFrame, boolrecurse, boolloop );
tableuserdata:ShowMessageBox( unsignedidentifier, stringtitle, stringprompt, stringbutton1text, [string...]);
tableuserdata:ShowPasscode( unsignedidentifier, stringtitle, stringprompt, DWORDpermissionFlag );
tableuserdata:ShowKeyboard( unsignedidentifier, stringtitle, stringprompt, stringdefault, DWORDflags );
voiduserdata:ShowNotification( stringmessage, DWORDtype );

XUI

XuiObject

call
typeOf

XuiElement : XuiObject

GetBounds
GetId
PlayTimeline
SetPosition
SetOpacity
SetShow
GetPosition
GetOpacity
IsShown

XuiText : XuiElement : XuiObject

GetText
MeasureText
SetText

XuiImage : XuiElement : XuiObject

GetImagePath
SetImagePath

XuiControl : XuiElement : XuiObject

GetImagePath
IsBackButton
IsEnabled
IsNavButton
PlayVisualRange
SetEnable
SetImagePath
SetText

XuiButton : XuiControl : XuiElement : XuiObject

(none)

XuiRadioButton : XuiControl : XuiElement : XuiObject

(none)

XuiRadioGroup : XuiControl : XuiElement : XuiObject

GetCurSel
SetCurSel

XuiLabel : XuiControl : XuiElement : XuiObject

(none)

XuiEdit : XuiControl : XuiElement : XuiObject

DeleteText
GetCaretPosition
GetLineCount
GetLineIndex
GetMaxVisibleLineCount
GetReadOnly
GetTextLimit
GetTopLine
GetVisibleLineCount
GetVSmoothScrollEnabled
InsertText
SetCaretPosition
SetTextLimit
SetTopLine

XuiList : XuiControl : XuiElement : XuiObject

DeleteItems
GetCurSel
GetItemCheck
GetItemCount
GetMaxVisibleLineCount
GetMaxLinesItemCount
GetText
GetTopItem
GetVisibleItemCount
InsertItems
IsItemChecked
IsItemEnabled
IsItemVisible
SetCurSel
SetCurSelVisible
SetImagePath
SetItemCheck
SetItemEnable
SetText
SetTopItem

XuiProgressBar : XuiControl : XuiElement : XuiObject

GetRange
GetValue
SetRange
SetValue

XuiSlider : XuiControl : XuiElement : XuiObject

GetAccel
GetRange
GetStep
GetValue
SetAccel
SetRange
SetStep
SetValue

XuiCheckbox : XuiControl : XuiElement : XuiObject

IsChecked
SetCheck

XuiScene : XuiControl : XuiElement : XuiObject

(none)

XuiTabScene : XuiScene : XuiControl : XuiElement : XuiObject

CanUserTab
EnableTabbing
GetCount
GetCurrentTab
Goto
GotoNext
GotoPrev