System.CreateDownload()
Loads a font.
System.LoadFont(pszName)
Parameter | Description |
---|---|
pszName | Font name. |
Executes a command.
System.ExecuteCommand(szCmd)
Parameter | Description |
---|---|
szCmd | Command string. |
Logs a message to the console.
System.LogToConsole(sText)
Parameter | Description |
---|---|
sText | Text to be logged. |
Clears the console.
System.ClearConsole()
Logs a message.
System.Log(sText)
Parameter | Description |
---|---|
sText | Text to be logged. |
Logs important data that must be printed regardless verbosity.
System.LogAlways(sText)
Parameter | Description |
---|---|
sText | Text to be logged. |
Shows a message text with the warning severity.
System.Warning(sText)
Parameter | Description |
---|---|
sText | Text to be logged. |
Shows a message text with the error severity.
System.Error(sText)
Parameter | Description |
---|---|
sText | Text to be logged. |
Checks if the system is the editor.
System.IsEditor()
Checks if the system is in pure editor mode, i.e. not editor game mode.
System.IsEditing()
Gets the current time.
System.GetCurrTime()
Gets the current asynchronous time.
System.GetCurrAsyncTime()
Gets the frame time.
System.GetFrameTime()
Gets the local operating system time.
System.GetLocalOSTime()
Gets the username on this machine.
System.GetUserName()
Shows/hides the console.
System.ShowConsole(nParam)
Parameter | Description |
---|---|
nParam | 1 to show the console, 0 to hide. |
Checks the heap validity.
System.CheckHeapValid(name)
Parameter | Description |
---|---|
name | Name string. |
Gets the config specification.
System.GetConfigSpec()
Checks if the game is multiplayer.
System.IsMultiplayer()
Gets an entity from its ID.
System.GetEntity(entityId)
Parameter | Description |
---|---|
entityId | Entity identifier. |
Gets an entity class from its ID.
System.GetEntityClass(entityId)
Parameter | Description |
---|---|
entityId | Entity identifier. |
Prepares the given bookmarked entity from the pool, bringing it into existence.
System.PrepareEntityFromPool(entityId)
Parameter | Description |
---|---|
entityId | Entity identifier. |
bPrepareNow | (optional) Specifies whether the pooled entity shall be prepared immediately rather than queuing a request in case there is a preparation already in progress. |
System.ReturnEntityToPool(entityId)
Returns: the bookmarked entity to the pool, destroying it.Parameter | Description |
---|---|
entityId | Entity identifier. |
Resets the entity's bookmarked, which frees memory.
System.ResetPoolEntity(entityId)
Parameter | Description |
---|---|
entityId | Entity identifier. |
Gets all the entities contained in the specific area of the level.
System.GetEntities(center, radius)
Parameter | Description |
---|---|
center | Center position vector for the area where to get entities. |
radius | Radius of the area. |
Gets all the entities of the specified class.
System.GetEntitiesByClass(EntityClass)
Parameter | Description |
---|---|
EntityClass | Entity class name. |
Gets all the entities contained into the specified sphere.
System.GetEntitiesInSphere( centre, radius )
Parameter | Description |
---|---|
centre | Centre position vector for the sphere where to look at entities. |
radius | Radius of the sphere. |
Gets all the entities contained into the specified sphere for the specific class name.
System.GetEntitiesInSphereByClass( centre, radius, EntityClass )
Parameter | Description |
---|---|
centre | Centre position vector for the sphere where to look at entities. |
radius | Radius of the sphere. |
EntityClass | Entity class name. |
Gets all the entities contained into the specified area.
System.GetPhysicalEntitiesInBox( centre, radius )
Parameter | Description |
---|---|
centre | Centre position vector for the area where to look at entities. |
radius | Radius of the sphere. |
Gets all the entities contained into the specified area for the specific class name.
System.GetPhysicalEntitiesInBoxByClass( centre, radius, className )
Parameter | Description |
---|---|
centre | Centre position vector for the area where to look at entities. |
radius | Radius of the sphere. |
className | Entity class name. |
Gets the nearest entity with the specified class.
System.GetNearestEntityByClass( centre, radius, className )
Parameter | Description |
---|---|
centre | Centre position vector for the area where to look at entities. |
radius | Radius of the sphere. |
className | Entity class name. |
Retrieve entity table for the first entity with specified name. If multiple entities with same name exist, first one found is returned.
System.GetEntityByName( sEntityName )
Parameter | Description |
---|---|
sEntityName | Name of the entity to search. |
Retrieve entity Id for the first entity with specified name. If multiple entities with same name exist, first one found is returned.
System.GetEntityIdByName( sEntityName )
Parameter | Description |
---|---|
sEntityName | Name of the entity to search. |
Draws a label with the specified parameter.
System.DrawLabel( vPos, fSize, text [, r [, g [, b [, alpha]]]] )
Parameter | Description |
---|---|
vPos | Position vector. |
fSize | Size for the label. |
text | Text of the label. |
r | Red component for the label colour. Default is 1. |
g | Green component for the label colour. Default is 1. |
b | Blue component for the label colour. Default is 1. |
alpha | Alpha component for the label colour. Default is 1. |
Deforms the terrain.
System.DeformTerrain()
Deforms the terrain using material.
System.DeformTerrainUsingMat()
Applies a force to the environment.
System.ApplyForceToEnvironment( pos, force, radius)
Parameter | Description |
---|---|
pos | Position of the force. |
force | Strength of the force. |
radius | Area where the force has effects. |
System.ScreenToTexture()
Draws a triangle strip.
System.DrawTriStrip(handle, nMode, vtxs, r, g, b, alpha )
Parameter | Description |
---|---|
handle | . |
nMode | . |
vtx | . |
r | Red component for the label color. Default is 1. |
g | Green component for the label color. Default is 1. |
b | Blue component for the label color. Default is 1. |
alpha | Alpha component for the label color. Default is 1. |
Draws a line.
System.DrawLine( p1, p2, r, g, b, alpha )
Parameter | Description |
---|---|
p1 | Start position of the line. |
p2 | End position of the line. |
r | Red component for the label color. Default is 1. |
g | Green component for the label color. Default is 1. |
b | Blue component for the label color. Default is 1. |
alpha | Alpha component for the label color. Default is 1. |
Draws a 2D line.
System.Draw2DLine(p1x, p1y, p2x, p2y, r, g, b, alpha )
Parameter | Description |
---|---|
p1x | X value of the start point of the line. |
p1y | Y value of the start point of the line. |
p2x | X value of the end point of the line. |
p2y | Y value of the end point of the line. |
r | Red component for the label color. Default is 1. |
g | Green component for the label color. Default is 1. |
b | Blue component for the label color. Default is 1. |
alpha | Alpha component for the label color. Default is 1. |
Draws text.
System.DrawText( x, y, text, font, size, p2y, r, g, b, alpha )
Parameter | Description |
---|---|
x | X position for the text. |
y | Y position for the text. |
text | Text to be displayed. |
font | Font name. |
size | Text size. |
r | Red component for the label color. Default is 1. |
g | Green component for the label color. Default is 1. |
b | Blue component for the label color. Default is 1. |
alpha | Alpha component for the label color. Default is 1. |
Sets the gamma/delta value.
System.SetGammaDelta( fDelta )
Parameter | Description |
---|---|
fDelta | Delta value. |
Sets a post processing effect parameter value.
System.SetPostProcessFxParam( pszEffectParam, value )
Parameter | Description |
---|---|
pszEffectParam | Parameter for the post processing effect. |
value | Value for the parameter. |
Gets a post processing effect parameter value.
System.GetPostProcessFxParam( pszEffectParam, value )
Parameter | Description |
---|---|
pszEffectParam | Parameter for the post processing effect. |
value | Value for the parameter. |
Sets a post processing effect parameter value.
System.SetScreenFx( pszEffectParam, value )
Parameter | Description |
---|---|
pszEffectParam | Parameter for the post processing effect. |
value | Value for the parameter. |
Gets a post processing effect parameter value.
System.GetScreenFx( pszEffectParam, value )
Parameter | Description |
---|---|
pszEffectParam | Parameter for the post processing effect. |
value | Value for the parameter. |
Sets the value of a CVariable.
System.SetCVar( sCVarName, value )
Parameter | Description |
---|---|
sCVarName | Name of the variable. |
value | Value of the variable. |
Gets the value of a CVariable.
System.GetCVar( sCVarName)
Parameter | Description |
---|---|
sCVarName | Name of the variable. |
Adds a C command to the system.
System.AddCCommand( sCCommandName, sCommand, sHelp)
Parameter | Description |
---|---|
sCCommandName | C command name. |
sCommand | Command string. |
sHelp | Help for the command usage. |
Sets scissor info.
System.SetScissor( x, y, w, h )
Parameter | Description |
---|---|
x | X position. |
Gets the amount of the memory for the system.
System.GetSystemMem()
Checks if the PS20 is supported.
System.IsPS20Supported()
Checks if the HDR is supported.
System.IsHDRSupported()
Sets system budget.
System.SetBudget(sysMemLimitInMB, videoMemLimitInMB, frameTimeLimitInMS, soundChannelsPlayingLimit, soundMemLimitInMB, numDrawCallsLimit )
Parameter | Description |
---|---|
sysMemLimitInMB | Limit of the system memory in MB. |
videoMemLimitInMB | Limit of the video memory in MB. |
frameTimeLimitInMS | Limit in the frame time in MS. |
soundChannelsPlayingLimit | Limit of the sound channels playing. |
soundMemLimitInMB | Limit of the sound memory in MB. |
numDrawCallsLimit | Limit of the draw calls. |
Sets the volumetric fog modifiers.
System.SetVolumetricFogModifiers( gobalDensityModifier, atmosphereHeightModifier )
Parameter | Description |
---|---|
gobalDensityModifier | Modifier for the global density. |
atmosphereHeightModifier | Modifier for the atmosphere height. |
Sets the wind direction.
System.SetWind( vWind )
Parameter | Description |
---|---|
vWind | Wind direction. |
Gets the wind direction.
System.SetWind()
Gets the surface type identifier by its name.
System.GetSurfaceTypeIdByName( surfaceName )
Parameter | Description |
---|---|
surfaceName | Surface name. |
Gets the surface type name by its identifier.
System.GetSurfaceTypeNameById( surfaceId )
Parameter | Description |
---|---|
surfaceId | Surface identifier. |
Removes the specified entity.
System.RemoveEntity( entityId )
Parameter | Description |
---|---|
entityId | Entity identifier. |
Spawns an entity.
System.SpawnEntity( params )
Parameter | Description |
---|---|
params | Entity parameters. |
NOT SUPPORTED ANYMORE.
System.ActivateLight(name, activate)
SetWaterLevel is not supported by 3dengine for now.
System.SetWaterVolumeOffset()
Checks if the position is a valid map position.
System.IsValidMapPos( v )
Parameter | Description |
---|---|
v | Position vector. |
Feature unimplemented.
System.EnableMainView()
Enables/disables ocean rendering.
System.EnableOceanRendering()
Parameter | Description |
---|---|
bOcean | True to activate the ocean rendering, false to deactivate it. |
Scans a directory.
System.ScanDirectory( pszFolderName, nScanMode )
Parameter | Description |
---|---|
pszFolderName | Folder name. |
nScanMode | Scan mode for the folder. Can be: SCANDIR_ALL SCANDIR_FILES SCANDIR_SUBDIRS |
System.DebugStats( cp )
Sets the view distance.
System.ViewDistanceSet( fViewDist )
Parameter | Description |
---|---|
fViewDist | View distance. |
Gets the view distance.
System.ViewDistanceSet()
Gets the outdoor ambient color.
System.GetOutdoorAmbientColor()
Sets the outdoor ambient color.
System.GetOutdoorAmbientColor( v3Color )
Parameter | Description |
---|---|
v3Color | Outdoor ambient color value. |
Gets the terrain elevation of the specified position.
System.GetTerrainElevation( v3Pos )
Parameter | Description |
---|---|
v3Pos | Position of the terraint to be checked. |
Activates/deactivates a portal.
System.ActivatePortal( vPos, bActivate, nID )
Parameter | Description |
---|---|
vPos | Position vector. |
bActivate | True to activate the portal, false to deactivate. |
nID | Entity identifier. |
Dumps the MM statistics.
System.DumpMMStats()
Enumerates the AA formats.
System.EnumAAFormats( m_Width, m_Height, m_BPP )
Enumerates display formats.
System.EnumDisplayFormats()
Checks if a point is indoors.
System.IsPointIndoors( vPos )
Parameter | Description |
---|---|
vPos | Position vector. |
Sets the console image.
System.SetConsoleImage( pszName, bRemoveCurrent )
Parameter | Description |
---|---|
pszName | Texture image. |
bRemoveCurrent | True to remove the current image, false otherwise. |
Projects to the screen (not guaranteed to work if used outside Renderer).
System.ProjectToScreen( vec )
Parameter | Description |
---|---|
vec | Position vector. |
Is not supported anymore.
System.EnableHeatVision()
Shows the debugger.
System.ShowDebugger()
Dumps memory statistics.
System.DumpMemStats( bUseKB )
Parameter | Description |
---|---|
bUseKB | True to use KB, false otherwise. |
Dumps memory coverage.
System.DumpMemoryCoverage( bUseKB )
Test the application with the specified parameters.
System.ApplicationTest( pszParam )
Parameter | Description |
---|---|
pszParam | Parameters. |
Quits the application in the specified number of seconds.
System.QuitInNSeconds( fInNSeconds )
Parameter | Description |
---|---|
fInNSeconds | Number of seconds before quitting. |
Dumps windows heaps.
System.DumpWinHeaps()
Breaks the application with a fatal error message.
System.Break()
Sets the view camera fov.
System.SetViewCameraFov( fov )
Gets the view camera fov.
System.GetViewCameraFov()
Checks if the specified point is visible.
System.IsPointVisible( point )
Parameter | Description |
---|---|
point | Point vector. |
Gets the view camera position.
System.GetViewCameraPos()
Gets the view camera direction.
System.GetViewCameraDir()
Gets the view camera up-direction.
System.GetViewCameraUpDir()
Gets the view camera angles.
System.GetViewCameraAngles()
Shots rays into the world.
System.RayWorldIntersection(vPos, vDir, nMaxHits, iEntTypes)
Parameter | Description |
---|---|
vPos | Position vector. |
vDir | Direction vector. |
nMaxHits | Maximum number of hits. |
iEntTypes | . |
System.RayTraceCheck(src, dst, skipId1, skipId2)
Browses a URL address.
System.BrowseURL(szURL)
Parameter | Description |
---|---|
szURL | URL string. |
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.).
System.IsDevModeEnable()
Saves the configuration.
System.SaveConfiguration()
Quits the program.
System.Quit()
Gets the HDR dynamic multiplier.
System.GetHDRDynamicMultiplier()
Sets the HDR dynamic multiplier.
System.SetHDRDynamicMultiplier( fMul )
Parameter | Description |
---|---|
fMul | Dynamic multiplier value. |
Gets the frame identifier.
System.GetFrameID()
Clear the key state.
System.ClearKeyState()
Set color of the sun, only relevant outdoors.
System.SetSunColor( vColor )
Parameter | Description |
---|---|
vColor | Sun Color as an {x,y,z} vector (x=r,y=g,z=b). |
Retrieve color of the sun outdoors.
Vec3 System.GetSunColor()
Returns: Sun Color as an {x,y,z} vector (x=r,y=g,z=b).
Set color of the sky (outdoors ambient color).
System.SetSkyColor( vColor )
Parameter | Description |
---|---|
vColor | Sky Color as an {x,y,z} vector (x=r,y=g,z=b). |
Retrieve color of the sky (outdoor ambient color).
Vec3 System.GetSkyColor()
Returns: Sky Color as an {x,y,z} vector (x=r,y=g,z=b).
Set Sky highlighing parameters. Highligh Params Meaning <hruler /> size Sky highlight scale. color Sky highlight color. direction Direction of the sky highlight in world space. pod Position of the sky highlight in world space.
System.SetSkyHighlight( params )
Parameter | Description |
---|---|
params | Table with Sky highlighing parameters. |
Retrieves Sky highlighing parameters. see SetSkyHighlight for parameters description.
System.SetSkyHighlight( params )
Loads Excel exported xml file with text and dialog localization data.
System.LoadLocalizationXml( filename )