Lua API/System

Материал из CryWiki Russia

---

Версия 20:23, 23 декабря 2010

Содержание 1 Overview 2 Configuration 3 File 4 Surface 5 Renderer 5.1 Screen 5.2 HDR 5.3 2D Drawing 5.4 Screen Effects 6 Time 7 Debugging 8 Console 9 Log 10 Statistics 11 View 12 Entity 13 Environment 13.1 Terrain 13.2 Sky 13.3 Fog 13.4 Wind 13.5 Water 14 Input

Overview

These Lua functions are in the System table. For example, the Log function would be invoked like this:

System.Log("logging this message");

Configuration

• IsEditor
• IsMultiplayer
• IsDevModeEnable
• GetCPUQuality
• GetGPUQuality
• IsPS20Supported
• LoadLocalizationXml
• SaveConfiguration
• Quit
• QuitInNSeconds
• SetBudget
• ViewDistanceGet
• ViewDistanceSet
• ApplyForceToEnvironment
• GetOutdoorAmbientColor
• ActivatePortal
• IsPointIndoors
• CheckHeapValid
• GetConfigSpec
• SetScissor
• LoadFont

File

• ScanDirectory

Surface

• GetSurfaceTypeIdByName
• GetSurfaceTypeNameById

Renderer

Screen

• ProjectToScreen
• EnumDisplayFormats
• EnumAAFormats
• SetGammaDelta
• SetSystemShaderRenderFlags
• GetFrameID

HDR

• GetHDRDynamicMultiplier
• SetHDRDynamicMultiplier
• IsHDRSupported

2D Drawing

• DrawLabelImage
• DrawLabel
• ScreenToTexture
• DrawLine
• Draw2DLine
• DrawText
• DrawImage
• DrawImageColor
• DrawImageColorCoords
• DrawImageCoords
• DrawRectShader
• DrawTriStrip

Screen Effects

• SetPostProcessFXParam
• GetPostProcessFXParam
• SetScreenFx
• GetScreenFx

Time

• GetCurrTime
• GetCurrAsyncTime
• GetFrameTime
• GetOSTime
• GetLocalOSTime

Debugging

• ShowDebugger
• Break

Console

• SetCVar
• GetCVar
• AddCCommand
• ExecuteCommand
• ShowConsole
• SetConsoleImage

Log

These logging functions are subject to the log verbosity level.

• LogToConsole
• LogAlways
• Log
• Warning
• Error
• ClearConsole

Statistics

• DumpMemoryCoverage
• DumpMemStats
• DumpMMStats
• DumpWinHeaps
• DebugStats
• GetSystemMem
• GetVideoMem

View

• SetViewCameraFov
• GetViewCameraFov
• GetViewCameraPos
• GetViewCameraDir
• GetViewCameraAngles
• IsPointVisible

Entity

• GetEntity
• GetEntityClass
• GetEntities
• GetEntitiesInSphere
• GetEntitiesInSphereByClass
• GetPhysicalEntitiesInBox
• GetPhysicalEntitiesInBoxByClass
• GetEntitiesByClass
• GetNearestEntityByClass
• GetEntityByName
• GetEntityIdByName
• RemoveEntity
• SpawnEntity

Environment

Terrain

• GetTerrainElevation
• IsValidMapPos

Sky

• SetSunColor
• GetSunColor
• SetSkyColor
• GetSkyColor
• SetSkyHighlight
• GetSkyHighlight

Fog

• SetVolumetricFogModifiers

Wind

• SetWind
• GetWind

Water

• EnableOceanRendering

Input

• ClearKeyState