Skip to main content

AE

Client Server

Methods​

table GetLogs(number fromId)​

number NewLogId()​

boolean IsClientApp()​

boolean IsServerApp()​

boolean IsStudioApp()​

boolean OnServer()​

boolean OnClient()​

number GetDebugTime()​

string GetLuaGCMode()​

Garbage-collector mode of the Lua state this call runs in (the server's on the server, the client's on a client): 'generational' (the engine default) or 'incremental'. Reports the mode set through the engine (the --lua-gc-mode command-line option or SetLuaGCMode), so switch modes with SetLuaGCMode rather than collectgarbage() to keep the two in step.

nil SetLuaGCMode(string mode)​

Switches the garbage collector of the calling Lua state to 'generational' or 'incremental', each with Lua 5.4's default tuning. The choice is kept by the engine for the rest of the process, so it survives Server:LuaReset() and script reloads. Generational is the default because script garbage is short-lived and the incremental collector paid for it with steps inside whichever script allocated: on the Jazz world server all script Updates summed to 16.2 ms/frame incremental vs 3.4 ms/frame generational. Errors on any other mode name.

number GetDisplayScale()​

table GetSafeArea()​

table GetDisplayUsableArea()​

CommandLine GetCommandLine()​

Returns the CommandLine (engine command-line arguments).

string GetScript(string fileName)​

table GetVersion()​

table GetFolders()​

System GetSystem()​

System GetHostSystem()​

Device GetDevice()​

boolean IsDebuggerPresent()​

number GetLogTime(string name)​

Reads an engine profiler timer's last-frame value in seconds (multiply by 1e6 for µs to match the "Profiling On Server" window's Duration column). Pass a timer name discovered via GetLogTimers, e.g. AE:GetLogTime("SUF/Server - Update"). Single reads fluctuate frame-to-frame — sample over several frames and average/take percentiles.

table GetLogTimers(string namePrefix)​

Lists all engine profiler timer names under a prefix — use it to discover what's measurable, then call GetLogTime on each. AE:GetLogTimers("") returns everything; AE:GetLogTimers("NEW/") filters by prefix. Common prefixes: SUF/ (server update-frame labels shown in the Profiling window, with SUF/Frame as the total frame timer) and NEW/ (independent C++ subsystem probes that may overlap SUF/).

number GetLogValue(string name, number? defaultVal)​

nil SetLogValue(string name, number value)​

table GetLogValuesWithPrefix(string namePrefix)​

string GetStrLogValue(string name)​

Returns the string log value with the given name (multi-line summaries such as Renderer/ScanPhaseSummary), or an empty string if it doesn't exist.

Asset[] assets, string[] folders GetAssetsFiltered(string assetFolder, string subfolder, string assetType)​

Asset[] GetAssets()​

Asset[] GetDefaultBrushImages()​

string[] GetAssetSources()​

Asset GetBuiltinMaterial(string name)​

Asset GetThumbnailForAsset(Asset|AssetLink|string asset)​

integer GetAssetsChangeCounter()​

integer TypeInt(string typeName)​

string[] GetEnumValues(string enumName)​

table GetAELuaBindings()​

table mem, table cnt, table type GetMemoryUsage()​

table GetAssetsMemUsage(string type)​

table GetGpuTextures()​

nil ReloadGeometry()​

nil AEVV_InvalidateData()​

boolean ToggleFullScreen()​

table GetVideoModes()​

number GetVSyncMode()​

boolean SetVSyncMode(VSyncMode mode)​

table GetVideoMode()​

boolean SetVideoMode(table opts)​

Properties​

number clientID​