Name 

Description 

 

ActivateLight 

DOC-IGNORE-BEGIN Syntax: System.ActivateLight(name, activate)
NOT SUPPORTED ANYMORE. 

 

ActivatePortal 

Syntax: System.ActivatePortal( vPos, bActivate, nID )
Activates/deactivates a portal.
 

 

AddCCommand 

Syntax: System.AddCCommand( sCCommandName, sCommand, sHelp)
Adds a C command to the system.
 

 

ApplicationTest 

Syntax: System.ApplicationTest( pszParam )
Test the application with the specified parameters. 

 

ApplyForceToEnvironment 

Syntax: System.ApplyForceToEnvironment( pos, force, radius)
Applies a force to the environment.
 

 

Break 

Syntax: System.Break()
Breaks the application with a fatal error message. 

 

BrowseURL 

Syntax: System.BrowseURL(szURL)
Browses a URL address. 

 

CheckHeapValid 

Syntax: System.CheckHeapValid(name)
Checks the heap validity.
 

 

ClearConsole 

Syntax: System.ClearConsole()
Clears the console.
! Clear the console 

 

ClearKeyState 

Syntax: System.ClearKeyState()
Clear the key state 

 

CreateDownload 

Syntax: System.CreateDownload()
! Creates a download object @return download object just created 

 

DebugStats 

Syntax: System.DebugStats( cp ) 

 

DeformTerrain 

Syntax: System.DeformTerrain()
Deforms the terrain. 

 

DeformTerrainUsingMat 

Syntax: System.DeformTerrainUsingMat()
Deforms the terrain using material. 

 

Draw2DLine 

Syntax: System.Draw2DLine(p1x, p1y, p2x, p2y, r, g, b, alpha )
Draws a 2D line.
 

 

DrawLabel 

Syntax: System.DrawLabel( vPos, fSize, text [, r [, g [, b [, alpha]]]] )
Draws a label with the specified parameter.
 

 

DrawLine 

Syntax: System.DrawLine( p1, p2, r, g, b, alpha )
Draws a line.
 

 

DrawText 

Syntax: System.DrawText( x, y, text, font, size, p2y, r, g, b, alpha )
Draws a text. 

 

DrawTriStrip 

Syntax: System.DrawTriStrip(handle, nMode, vtxs, r, g, b, alpha )
Draws a triangle strip. 

 

DumpMemoryCoverage 

Syntax: System.DumpMemoryCoverage( bUseKB )
Dumps memory coverage. 

 

DumpMemStats 

Syntax: System.DumpMemStats( bUseKB )
Dumps memory statistics. 

 

DumpMMStats 

Syntax: System.DumpMMStats()
Dumps the MM statistics.
 

 

DumpWinHeaps 

Syntax: System.DumpWinHeaps()
Dumps windows heaps. 

 

EnableHeatVision 

DOC-IGNORE-BEGIN Syntax: System.EnableHeatVision()
Is not supported anymore. 

 

EnableMainView 

DOC-IGNORE-BEGIN Syntax: System.EnableMainView()
Feature unimplemented. 

 

EnableOceanRendering 

Syntax: System.EnableOceanRendering()
Enables/disables ocean rendering.
int CScriptBindSystem::IndoorSoundAllowed(IFunctionHandler * pH) { SCRIPT_CHECK_PARAMETERS(2); CScriptVector pVecOrigin(m_pSS,false); CScriptVector pVecDestination(m_pSS,false);
IGraph *pGraph = gEnv->pAISystem->GetNodeGraph();
Vec3 start = pVecOrigin.Get(); Vec3 end = pVecDestination.Get();
if ((start.x<0)||(start.x>2000.f)||(start.y<0)||(start.y>2000.f)) { m_pLog->LogError("[CRASHWARNING] Unnaturally high value placed for sound detection"); return pH->EndFunction(true); // there is no sound occlusion in outdoor }
if ((end.x<0)||(end.x>2000.f)||(end.y<0)||(end.y>2000.f)) { m_pLog->LogError("[CRASHWARNING] Unnaturally high value placed for sound detection"); return pH->EndFunction(true); // there is no sound occlusion in outdoor }
GraphNode *pStart = pGraph->GetEnclosing(pVecOrigin.Get());
if (pStart->nBuildingID<0) return pH->EndFunction(true); // there is no sound occlusion in outdoor
GraphNode *pEnd = pGraph->GetEnclosing(pVecDestination.Get());
if (pStart->nBuildingID!=pEnd->nBuildingID) return pH->EndFunction(false); // if in 2 different... more 

 

EnumAAFormats 

Syntax: System.EnumAAFormats( m_Width, m_Height, m_BPP )
Enumerates the AA formats. 

 

EnumDisplayFormats 

Syntax: System.EnumDisplayFormats()
Enumerates display formats. 

 

Error 

Syntax: System.Error(sText)
Shows a message text with the error severity.
 

 

ExecuteCommand 

Syntax: System.ExecuteCommand(szCmd)
Executes a command.
 

 

GetConfigSpec 

Syntax: System.GetConfigSpec()
Gets the config specification.
 

 

GetCPUQuality 

CW: added for script based system analysis Syntax: System.GetCPUQuality()
Gets the CPU quality. 

 

GetCurrAsyncTime 

Syntax: System.GetCurrAsyncTime()
Gets the current asynchronous time. 

 

GetCurrTime 

Syntax: System.GetCurrTime()
Gets the current time.
 

 

GetCVar 

Syntax: System.GetCVar( sCVarName)
Gets the value of a CVariable. 

 

GetEntities 

Syntax: System.GetEntities(center, radius)
Gets all the entities contained in the specific area of the level.
!return a all entities currently present in the level @return a table filled with all entities currently present in the level 

 

GetEntitiesByClass 

Syntax: System.GetEntitiesByClass(EntityClass)
Gets all the entities of the specified class.
!return a all entities for a specified entity class @return a table filled with all entities of a specified entity class 

 

GetEntitiesInSphere 

Syntax: System.GetEntitiesInSphere( centre, radius )
Gets all the entities contained into the specified sphere.
!return a all entities for a specified entity class @return a table filled with all entities of a specified entity class in a radius 

 

GetEntitiesInSphereByClass 

Syntax: System.GetEntitiesInSphereByClass( centre, radius, EntityClass )
Gets all the entities contained into the specified sphere for the specific class name. 

 

GetEntity 

Syntax: System.GetEntity(entityId)
Gets an entity from its ID.
!Get an entity by id @param nID the entity id 

 

GetEntityByGUID 

Syntax: System.GetEntityByGUID( SmartScriptTable dataTable )
Retrieve entity table for the first entity withe the given EntityGUID 

 

GetEntityByName 

Syntax: System.GetEntityByName( sEntityName )
Retrieve entity table for the first entity with specified name. If multiple entities with same name exist, first one found is returned. 

 

GetEntityClass 

Syntax: System.GetEntityClass(entityId)
Gets an entity class from its ID. 

 

GetEntityIdByName 

Syntax: System.GetEntityIdByName( sEntityName )
Retrieve entity Id for the first entity with specified name. If multiple entities with same name exist, first one found is returned. 

 

GetFrameID 

Syntax: System.GetFrameID()
Gets the frame identifier.
 

 

GetFrameTime 

Syntax: System.GetFrameTime()
Gets the frame time.
 

 

GetGPUQuality 

Syntax: System.GetGPUQuality()
Gets the GPU quality. 

 

GetHDRDynamicMultiplier 

Syntax: System.GetHDRDynamicMultiplier()
Gets hte HDR dynamic multiplier. 

 

GetLocalOSTime 

Syntax: System.GetLocalOSTime()
Gets the local operating system time.
 

 

GetMemoryUsage 

This is GetMemoryUsage, a member of class CScriptBindSystem. 

 

GetNearestEntityByClass 

Syntax: System.GetNearestEntityByClass( centre, radius, className )
Gets the nearest entity with the specified class. 

 

GetOutdoorAmbientColor 

Syntax: System.GetOutdoorAmbientColor()
Gets the outdoor ambient color.
 

 

GetPhysicalEntitiesInBox 

Syntax: System.GetPhysicalEntitiesInBox( centre, radius )
Gets all the entities contained into the specified area.
!return all entities contained in a certain radius @param oVec center of the sphere @param fRadius length of the radius @return a table filled with all entities contained in the specified radius 

 

GetPhysicalEntitiesInBoxByClass 

Syntax: System.GetPhysicalEntitiesInBoxByClass( centre, radius, className )
Gets all the entities contained into the specified area for the specific class name. 

 

GetPostProcessFxParam 

Syntax: System.GetPostProcessFxParam( pszEffectParam, value )
Gets a post processing effect parameter value.
 

 

GetScreenFx 

const char*, const char
 

 

GetSkyColor 

Syntax: Vec3 System.GetSkyColor()
Retrieve color of the sky (outdoor ambient color). 

 

GetSkyHighlight 

Syntax: System.SetSkyHighlight( params )
Retrieves Sky highlighing parameters. see SetSkyHighlight for parameters description. 

 

GetSunColor 

Syntax: Vec3 System.GetSunColor()
Retrieve color of the sun outdoors. 

 

GetSurfaceTypeIdByName 

Syntax: System.GetSurfaceTypeIdByName( surfaceName )
Gets the surface type identifier by its name.
 

 

GetSurfaceTypeNameById 

Syntax: System.GetSurfaceTypeNameById( surfaceId )
Gets the surface type name by its identifier. 

 

GetSystemMem 

Syntax: System.GetSystemMem()
Gets the amount of the memory for the system. 

 

GetTerrainElevation 

Syntax: System.GetTerrainElevation( v3Pos )
Gets the terrain elevation of the specified position.
 

 

GetUserName 

Syntax: System.GetUserName()
Gets the username on this machine.
 

 

GetVideoMem 

Syntax: System.GetVideoMem()
Gets the amount of the video memory for the system. 

 

GetViewCameraAngles 

Syntax: System.GetViewCameraAngles()
Gets the view camera angles. 

 

GetViewCameraDir 

Syntax: System.GetViewCameraDir()
Gets the view camera direction. 

 

GetViewCameraFov 

Syntax: System.GetViewCameraFov()
Gets the view camera fov. 

 

GetViewCameraPos 

Syntax: System.GetViewCameraPos()
Gets the view camera position. 

 

GetWind 

Syntax: System.SetWind()
Gets the wind direction.
 

 

IsDevModeEnable 

Syntax: System.IsDevModeEnable()
Checks if game is running in dev mode (cheat mode) to check if we are allowed to enable certain scripts function facilities (god mode, fly mode etc.).
 

 

IsEditing 

Syntax: System.IsEditing()
Checks if the system is in pure editor mode, i.e. not editor game mode. 

 

IsEditor 

Syntax: System.IsEditor()
Checks if the system is the editor. 

 

IsHDRSupported 

Syntax: System.IsHDRSupported()
Checks if the HDR is supported. 

 

IsMultiplayer 

Syntax: System.IsMultiplayer()
Checks if the game is multiplayer.
 

 

IsPointIndoors 

Syntax: System.IsPointIndoors( vPos )
Checks if a point is indoors. 

 

IsPointVisible 

Syntax: System.IsPointVisible( point )
Checks if the specified point is visible. 

 

IsPS20Supported 

Syntax: System.IsPS20Supported()
Checks if the PS20 is supported. 

 

IsValidMapPos 

Syntax: System.IsValidMapPos( v )
Checks if the position is a valid map position.
int CScriptBindSystem::ActivateMainLight(IFunctionHandler *pH) { SCRIPT_CHECK_PARAMETERS(2); bool bActive; CScriptVector oVec(m_pSS); if(pH->GetParam(1,*oVec)) { pH->GetParam(2, bActive); m_p3DEngine->GetBuildingManager()->ActivateMainLight(oVec.Get(), bActive); } return pH->EndFunction(); }
int CScriptBindSystem::SetSkyBox(IFunctionHandler *pH) { SCRIPT_CHECK_PARAMETERS(3); const char *pszShaderName; float fBlendTime; bool bUseWorldBrAndColor; pH->GetParam(1, pszShaderName); pH->GetParam(2, fBlendTime); pH->GetParam(3, bUseWorldBrAndColor); m_p3DEngine->SetSkyBox(pszShaderName);// not supported now: fBlendTime, bUseWorldBrAndColor); return pH->EndFunction(); 

 

LoadFont 

Syntax: System.LoadFont(pszName)
Loads a font.
! Loads a font and makes it available for future-selection @param name of font-xml-file (no suffix) 

 

LoadLocalizationXml 

Syntax: System.LoadLocalizationXml( filename )
Loads Excel exported xml file with text and dialog localization data.
 

 

Log 

Syntax: System.Log(sText)
Logs a message.
! Write a message into the log file and the console @param String to write @see stuff 

 

LogAlways 

Syntax: System.LogAlways(sText)
Logs important data that must be printed regardless verbosity.
! log even with log verbosity 0 - without @param String to write 

 

LogToConsole 

Syntax: System.LogToConsole(sText)
Logs a message to the console.
! Write a string to the console @param String to write @see CScriptBindSystem::Log 

 

PrepareEntityFromPool 

Syntax: System.PrepareEntityFromPool(entityId)
Prepares the given bookmarked entity from the pool, bringing it into existence.
!Entity pool management @param nID the entity id 

 

ProjectToScreen 

Syntax: System.ProjectToScreen( vec )
Projects to the screen (not guaranteed to work if used outside Renderer).
9/16/2010 evgeny] ProjectToScreen is not guaranteed to work if used outside Renderer 

 

Quit 

Syntax: System.Quit()
Quits the program. 

 

QuitInNSeconds 

Syntax: System.QuitInNSeconds( fInNSeconds )
Quits the application in the specified number of seconds. 

 

RayTraceCheck 

Syntax: System.RayTraceCheck(src, dst, skipId1, skipId2)
 

 

RayWorldIntersection 

Syntax: System.RayWorldIntersection(vPos, vDir, nMaxHits, iEntTypes)
Shots rays into the world. 

 

RemoveEntity 

Syntax: System.RemoveEntity( entityId )
Removes the specified entity.
 

 

ResetPoolEntity 

Syntax: System.ResetPoolEntity(entityId)
Resets the entity's bookmarked, which frees memory. 

 

ReturnEntityToPool 

Syntax: System.ReturnEntityToPool(entityId)
Returns the bookmarked entity to the pool, destroying it. 

 

SaveConfiguration 

Syntax: System.SaveConfiguration()
Saves the configuration. 

 

ScanDirectory 

Syntax: System.ScanDirectory( pszFolderName, nScanMode )
Scans a directory.
 

 

ScreenToTexture 

Syntax: System.ScreenToTexture()
 

 

SetBudget 

Syntax: System.SetBudget(sysMemLimitInMB, videoMemLimitInMB, frameTimeLimitInMS, soundChannelsPlayingLimit, soundMemLimitInMB, numDrawCallsLimit )
Sets system budget. 

 

SetConsoleImage 

Syntax: System.SetConsoleImage( pszName, bRemoveCurrent )
Sets the console image.
 

 

SetCVar 

Syntax: System.SetCVar( sCVarName, value )
Sets the value of a CVariable.
 

 

SetGammaDelta 

Syntax: System.SetGammaDelta( fDelta )
Sets the gamma/delta value. 

 

SetHDRDynamicMultiplier 

Syntax: System.SetHDRDynamicMultiplier( fMul )
Sets the HDR dynamic multiplier. 

 

SetOutdoorAmbientColor 

Syntax: System.GetOutdoorAmbientColor( v3Color ) v3Color - Outdoor ambient color value.
Sets the outdoor ambient color.
 

 

SetPostProcessFxParam 

Syntax: System.SetPostProcessFxParam( pszEffectParam, value )
Sets a post processing effect parameter value.
 

 

SetScissor 

Syntax: System.SetScissor( x, y, w, h )
Sets scissor info.
set scissoring screen area 

 

SetScreenFx 

Syntax: System.SetScreenFx( pszEffectParam, value )
Sets a post processing effect parameter value.
 

 

SetSkyColor 

Syntax: System.SetSkyColor( vColor )
Set color of the sky (outdoors ambient color). 

 

SetSkyHighlight 

Syntax: System.SetSkyHighlight( params )
Set Sky highlighing parameters. 

 

SetSunColor 

Syntax: System.SetSunColor( vColor )
Set color of the sun, only relevant outdoors. 

 

SetViewCameraFov 

Syntax: System.SetViewCameraFov( fov )
Sets the view camera fov. 

 

SetVolumetricFogModifiers 

Syntax: System.SetVolumetricFogModifiers( gobalDensityModifier, atmosphereHeightModifier )
Sets the volumetric fog modifiers. 

 

SetWaterVolumeOffset 

Syntax: System.SetWaterVolumeOffset()
SetWaterLevel is not supported by 3dengine for now. 

 

SetWind 

Syntax: System.SetWind( vWind )
Sets the wind direction.
 

 

ShowConsole 

Syntax: System.ShowConsole(nParam)
Shows/hides the console.
 

 

ShowDebugger 

Syntax: System.ShowDebugger()
Shows the debugger.
 

 

SpawnEntity 

Syntax: System.SpawnEntity( params )
Spawns an entity.
 

 

ViewDistanceGet 

Syntax: System.ViewDistanceSet()
Gets the view distance.
 

 

ViewDistanceSet 

Syntax: System.ViewDistanceSet( fViewDist )
Sets the view distance.
 

 

Warning 

Syntax: System.Warning(sText)
Shows a message text with the warning severity.