documentation
.HELP!
LuaFAR 3 Documentation
Methods
LuaFAR 3
previous page
next page
Methods
previous page
start
next page
Menu
Homepage
Table of contents
Manual of LuaFAR 3
Flags
Unicode support
Generic LuaFAR plugin
Customizing the generic plugin
luafar_init.lua
Recreation of the Lua virtual machine
Extra exported functions
GetLuaState
luaopen_luaplug
Other functions
GetPluginStartupInfo
What's new in this version
Version 2.8.0
Version 2.7.0
Version 2.6.0
Version 2.5.0
Version 2.4.0
Version 2.3.0
Version 2.2.0
Version 2.1.0
Version 2.0.1
Version 2.0.0
What's new in Unicode version
Version 1.0.1
Version 1.0.0
Version 0.9.0
Version 0.8.0
Version 0.7.2
Version 0.7
Version 0.6
Version 0.5.1
Version 0.5
Incompatibilities with the Previous Version
Version 2.6.0
Version 2.5.0
Version 2.4.0
Version 2.3.0
Version 2.2.0
Version 2.1.0
Version 2.0.0
Version 1.0.0
Version 0.9.0
Version 0.8.0
Version 0.7.2
Version 0.7
Version 0.6
Version 0.5.1
Version 0.5
Version 0.4
LuaFAR plugin-exported functions
Common functions
export.Configure
export.ExitFAR
export.GetGlobalInfo
export.GetPluginInfo
export.Open
export.ProcessConsoleInput
export.ProcessSynchroEvent
export.SetStartupInfo
Panel functions
export.Analyse
export.CloseAnalyse
export.ClosePanel
export.Compare
export.DeleteFiles
export.FreeFindData
export.GetFiles
export.GetFindData
export.GetOpenPanelInfo
export.MakeDirectory
export.ProcessHostFile
export.ProcessPanelEvent
export.ProcessPanelInput
export.PutFiles
export.SetDirectory
export.SetFindList
Editor functions
export.ProcessEditorEvent
export.ProcessEditorInput
Viewer functions
export.ProcessViewerEvent
Dialog functions
export.ProcessDialogEvent
Content functions
export.GetContentFields
export.GetContentData
Other functions
export.OnError
LuaFAR Far libraries
Common functions
far.AdvControl
far.GetDirList
far.GetMsg
far.GetPluginDirList
far.Menu
far.RestoreScreen
far.SaveScreen
far.ShowHelp
far.Text
Dialog functions
far.ColorDialog
far.CreateUserControl
far.Dialog
far.DialogFree
far.DialogInit
far.DialogRun
far.GetDlgItem
far.InputBox
far.Message
far.SendDlgMessage
far.SetDlgItem
far.SubscribeDialogDrawEvents
Dialog Events
DN_BTNCLICK
DN_CLOSE
DN_CONTROLINPUT
DN_CTLCOLORDIALOG
DN_CTLCOLORDLGITEM
DN_CTLCOLORDLGLIST
DN_DRAGGED
DN_DRAWDIALOG
DN_DRAWDIALOGDONE
DN_DRAWDLGITEM
DN_DRAWDLGITEMDONE
DN_DROPDOWNOPENED
DN_EDITCHANGE
DN_ENTERIDLE
DN_GETVALUE
DN_GOTFOCUS
DN_HELP
DN_HOTKEY
DN_INITDIALOG
DN_INPUT
DN_KILLFOCUS
DN_LISTCHANGE
DN_LISTHOTKEY
DN_RESIZECONSOLE
Editor functions
editor.AddColor
editor.AddSessionBookmark
editor.ClearSessionBookmarks
editor.DelColor
editor.DeleteBlock
editor.DeleteChar
editor.DeleteSessionBookmark
editor.DeleteString
editor.Editor
editor.ExpandTabs
editor.GetBookmarks
editor.GetColor
editor.GetFileName
editor.GetInfo
editor.GetSelection
editor.GetSessionBookmarks
editor.GetString
editor.GetStringW
editor.GetTitle
editor.InsertString
editor.InsertText
editor.InsertTextW
editor.NextSessionBookmark
editor.PrevSessionBookmark
editor.ProcessInput
editor.Quit
editor.ReadInput
editor.RealToTab
editor.Redraw
editor.SaveFile
editor.Select
editor.SetKeyBar
editor.SetParam
editor.SetPosition
editor.SetString
editor.SetStringW
editor.SetTitle
editor.SubscribeChangeEvent
editor.TabToReal
editor.UndoRedo
Panel functions
panel.CheckPanelsExist
panel.ClearSelection
panel.ClosePanel
panel.GetCmdLine
panel.GetCmdLinePos
panel.GetCmdLineSelection
panel.GetColumnTypes
panel.GetColumnWidths
panel.GetCurrentPanelItem
panel.GetPanelDirectory
panel.GetPanelFormat
panel.GetPanelHostFile
panel.GetPanelInfo
panel.GetPanelItem
panel.GetPanelPrefix
panel.GetSelectedPanelItem
panel.GetUserScreen
panel.InsertCmdLine
panel.IsActivePanel
panel.RedrawPanel
panel.SetActivePanel
panel.SetCmdLine
panel.SetCmdLinePos
panel.SetCmdLineSelection
panel.SetDirectoriesFirst
panel.SetPanelDirectory
panel.SetSelection
panel.SetSortMode
panel.SetSortOrder
panel.SetUserScreen
panel.SetViewMode
panel.UpdatePanel
Viewer functions
viewer.GetFileName
viewer.GetInfo
viewer.Quit
viewer.Redraw
viewer.Select
viewer.SetKeyBar
viewer.SetMode
viewer.SetPosition
viewer.Viewer
File Filter Control
far.CreateFileFilter
f:FreeFileFilter
f:OpenFiltersMenu
f:StartingToFilter
f:IsFileInFilter
Macro Control
far.MacroAdd
far.MacroCheck
far.MacroDelete
far.MacroExecute
far.MacroGetArea
far.MacroGetLastError
far.MacroGetState
far.MacroLoadAll
far.MacroPost
far.MacroSaveAll
Plugins Control
far.FindPlugin
far.ForcedLoadPlugin
far.GetPluginInformation
far.GetPlugins
far.IsPluginLoaded
far.LoadPlugin
far.UnloadPlugin
Settings Control
far.CreateSettings
far.FreeSettings
obj:CreateSubkey
obj:Delete
obj:Enum
obj:Free
obj:Get
obj:OpenSubkey
obj:Set
Far Standard Functions
far.ConvertPath
far.CopyToClipboard
far.FarClock
far.FormatFileSize
far.GetCurrentDirectory
far.GetFileOwner
far.GetNumberOfLinks
far.GetPathRoot
far.GetReparsePointInfo
far.InputRecordToName
far.LIsAlpha
far.LIsAlphanum
far.LIsLower
far.LIsUpper
far.LLowerBuf
far.LStricmp
far.LStrnicmp
far.LUpperBuf
far.MkLink
far.MkTemp
far.NameToInputRecord
far.PasteFromClipboard
far.ProcessName
far.RecursiveSearch
far.TruncPathStr
far.TruncStr
far.XLat
Regular expression functions
regex.exec, regex.execW
regex.find, regex.findW
regex.gmatch, regex.gmatchW
regex.gsub, regex.gsubW
regex.match, regex.matchW
regex.new
method bracketscount
method exec, execW
method find, findW
method gsub, gsubW
method match, matchW
Other functions
far.CPluginStartupInfo
far.MakeMenuItems
far.PluginStartupInfo
far.RunDefaultScript
far.Show
far.Timer
Properties
Closed
Enabled
Interval
Methods
Close
Events
OnTimer
Tables
far.Colors
far.Flags
far.Guids
"Structures"
tAnalyseInfo
tCoord
tFarColor
tFarDialogItem
tFarDialogItemColors
tFarKey
tFarPanelDirectory
tInfoLine
tInputRecord
tKeyBarLabel
tMouseEventRecord
tPanelMode
tPluginMenuItem
tPluginPanelItem
tSystemTime
ViewerInfo.CurMode
Additional libraries
bit64
bit64.type
bit64.new
win
Files and directories
win.CopyFile
win.CreateDir
win.DeleteFile
win.GetCurrentDir
win.GetDriveType
win.GetFileAttr
win.GetFileInfo
win.GetLogicalDriveStrings
win.MoveFile
win.RemoveDir
win.RenameFile
win.SearchPath
win.SetCurrentDir
win.SetFileAttr
Registry access
win.DeleteRegKey
win.DeleteRegValue
win.EnumRegKey
win.EnumRegValue
win.GetRegKey
win.SetRegKey
Text related functions
win.CompareString
win.EnumSystemCodePages
win.GetACP
win.GetConsoleCP
win.GetConsoleOutputCP
win.GetOEMCP
win.lenW
win.MultiByteToWideChar
win.OemToUtf8
win.SetConsoleCP
win.SetConsoleOutputCP
win.subW
win.Utf16ToUtf8
win.Utf8ToOem
win.Utf8ToUtf16
win.wcscmp
win.WideCharToMultiByte
Time related functions
win.FileTimeToLocalFileTime
win.FileTimeToSystemTime
win.GetSystemTimeAsFileTime
win.SystemTimeToFileTime
Various functions
win.ExtractKey
win.ExtractKeyEx
win.GetConsoleScreenBufferInfo
win.GetCPInfo
win.GetEnv
win.GetKeyState
win.GetVirtualKeys
win.GlobalMemoryStatus
win.IsProcess64bit
win.OutputDebugString
win.SetEnv
win.ShellExecute
win.SHGetFolderPath
win.Sleep
win.system
win.Uuid
Selene Unicode
unicode.utf8.utf8valid
Extensions
file:rawhandle
LuaFAR C-interface
Mediator functions
LF_Analyse
LF_CloseAnalyse
LF_ClosePanel
LF_Compare
LF_Configure
LF_DeleteFiles
LF_DlgProc
LF_ExitFAR
LF_FreeCustomData
LF_FreeFindData
LF_GetCustomData
LF_GetFiles
LF_GetFindData
LF_GetGlobalInfo
LF_GetOpenPanelInfo
LF_GetPluginInfo
LF_MakeDirectory
LF_Open
LF_ProcessConsoleInput
LF_ProcessDialogEvent
LF_ProcessEditorEvent
LF_ProcessEditorInput
LF_ProcessPanelEvent
LF_ProcessHostFile
LF_ProcessPanelInput
LF_ProcessSynchroEvent
LF_ProcessViewerEvent
LF_PutFiles
LF_SetDirectory
LF_SetFindList
Service functions
LF_DoFile
LF_Gsub
LF_LoadFile
LF_Message
LF_InitLuaState1
LF_InitLuaState2
LF_RunLuafarInit
LF_RunDefaultScript
LF_GetLuafarAPI
Third party software used
Lua 5.1
Selene Unicode
Get in touch
Submit feedback about this site to:
[email protected]