Enables or disables portal at a specified position.

Parameters

vPos	Position to place the portal
bActivate	Set to true in order to enable the portal, or to false to disable
szEntityName

Applies physics in a specified area Physics applied to the area will apply to vegetations and allow it to move/blend.

Parameters

vPos	- Center position to apply physics
fRadius	- Radius which specify the size of the area to apply physics
fAmountOfForce	- The amount of force, should be at least of 1.0f

Clips geometry against the boundaries of VisAreas.

Parameters

pInside

Vis Area to clip inside of. If 0, clip outside all Vis Areas.

Returns

True if it was clipped.

Creates a chunkfile content instance.

Returns

NULL if the memory for the instance could not be allocated.

Creates a ClipVolume.

Returns

A pointer to a newly created ClipVolume object.

Creates new decals on the walls, static objects, terrain and entities.

Parameters

Decal

- Structure describing the decal effect to be applied

Creates a new light source.

Returns

Pointer to newly created light or -1 if it fails.

Creates a new VisArea.

Returns

A pointer to a newly created VisArea object.

Deletes a ClipVolume.

Parameters

pClipVolume

- A pointer to the ClipVolume to delete.

Removes decals in a specified range.

Parameters

vAreaBox	Specify the area in which the decals will be removed.
pEntity	If not NULL will only delete decals attached to this entity.

Deletes a light.

Parameters

pLightSource

Pointer to the light.

Deletes a VisArea.

Parameters

pVisArea

- A pointer to the VisArea to delete.

Displays statistic on the 3d Engine.

Parameters

fTextPosX	X position for the text.
fTextPosY	Y position for the text.
fTextStepY	Amount of pixels to distance each line.
bEnhanced	false=normal, true=more interesting information.

Used by renderer.

Renders far trees/objects as sprites. It's a call back for renderer. It renders far trees/objects as sprites.

Note

Used by renderer, will be removed from here.

Enables or disables ocean rendering.

Parameters

bOcean

- Will enable or disable the rendering of ocean.

Finds a geom cache created from the given filename.

Parameters

szFileName

CAX Filename - should not be 0 or "".

Returns

A pointer to an object derived from IGeomCache.

Finds a static object created from the given filename.

Parameters

szFileName

- CGF Filename - should not be 0 or "".

Returns

A pointer to an object derived from IStatObj.

Gets the ocean water level for a specified position. Use with accurate query with caution - it is slow.

Note

This function only takes into account ocean water.

Parameters

pCurrPos

- Position to check water level.

Returns

A float value which indicate the water level.

Gets the closest walkable bottom z straight beneath the given reference position.

Note

This function will take into account both the global terrain elevation and local voxel (or other solid walkable object).

Parameters

referencePos	- Position from where to start searching downwards.
maxRelevantDepth	- Max depth caller is interested in relative to referencePos (for ray casting performance reasons).
objtypes	- expects physics entity flags. Use this to specify what object types make a valid bottom for you.

Returns

A float value which indicate the global world z of the bottom level beneath the referencePos.

If the referencePos is below terrain but not inside any voxel area BOTTOM_LEVEL_UNKNOWN is returned.

Gets caustics parameters.

Returns

A Vec4 value which constains:

x = unused, y = distance attenuation, z = caustics multiplier, w = caustics darkening multiplier

Retrieves the current GI multiplier.

Returns

scalar value

Gets the unit size of the terrain. The value should currently be 2.

Returns

A int value representing the terrain unit size in meters.

Returns

Interface to the mergedmeshes subsystem.

Returns

Interface to terrain engine.

Returns

Interface to visarea manager.

Adds the level's path to a specified filename.

Parameters

szFileName

The filename for which we need to add the path.

Returns

Full path for the filename; including the level path and the filename appended after.

Returns

Amount of light affecting a point in space inside a specific range (0 means no light affecting, 1 is completely affected by light). Use accurate parameter for a more expensive but with higher accuracy computation.

Returns

In logarithmic scale -4.0 .. 4.0

Gives access to list holding all lighting volumes.

Returns

An array holding all the SLightVolume pointers.

Gets the amount of loaded objects.

Returns

An integer representing the amount of loaded objects.

Fills pObjectsArray with pointers to loaded static objects. if pObjectsArray is NULL only fills nCount parameter with amount of loaded objects.

Gets the view distance.

Returns

A float value representing the maximum view distance.

Call function 2 times (first to get the size then to fill in the data)

Parameters

pObjects

0 if only the count is required

Returns

Count returned.

Gets ocean animation caustics parameters.

Returns

A Vec4 value which constains: x = unused, y = height, z = depth, w = intensity

Gets ocean animation parameters.

Returns

2 Vec4s which constain: 0: x = ocean wind direction, y = wind speed, z = free, w = waves amount 1: x = waves size, y = free, z = free, w = free

Gets the physics material enumerator.

Returns

A pointer to an IPhysMaterialEnumerator derived object.

Note

This is the camera which should be used for all Engine side culling (since e_camerafreeze allows easy debugging then)

Only valid during RenderWorld(else the camera of the last frame is used)

Returns

the Camera used for Rendering on 3DEngine Side, normaly equal to the view camera, except if frozen with e_camerafreeze

Retrieves the current sky brightening multiplier.

Returns

Scalar value

Gets the environment ambient color.

Note

Should have been specified in the editor.

Returns

An rgb value contained in a Vec3 object.

Returns

SkyBox material.

Retrieves the current SSAO multiplier.

Returns

scalar value

Retrieves the current SSAO contrast multiplier.

Returns

scalar value

Gives access to the list holding all static light sources.

Returns

An array holding all the SRenderLight pointers.

Gets stats on the streaming bandwidth requests from subsystems.

Parameters

subsystem	Rhe streaming subsystem for which we want bandwidth data.
outData	Structure containing the bandwidth data for the subsystem requested.

Gets the sun color.

Note

Should have been specified in the editor.

Returns

An rgb value contained in a Vec3 object.

Gets the interpolated terrain elevation for a specified location. All x,y values are valid.

Parameters

x	X coordinate of the location.
y	Y coordinate of the location.

Returns

A float which indicate the elevation level.

Gets the terrain hole flag for a specified location. Only values between 0 and WORLD_SIZE.

Parameters

x	- X coordinate of the location.
y	- Y coordinate of the location.

Returns

A bool which indicate is there hole or not.

Gets the size of the terrain sectors. The value should be 64 by default.

Returns

An int representing the size of a sector in meters.

Gets the size of the terrain. The value should be 2048 by default.

Returns

An int representing the terrain size in meters.

Gets the terrain surface normal for a specified location.

Parameters

vPos.x	- X coordinate of the location.
vPos.y	- Y coordinate of the location.
vPos.z	- ignored.

Returns

A terrain surface normal.

Retrieves terrain texture multiplier.

Returns

Scalar value

Gets the terrain elevation for a specified location. Only values between 0 and WORLD_SIZE.

Parameters

x	X coordinate of the location.
y	Y coordinate of the location.

Returns

A float which indicate the elevation level.

Returns

TOD interface.

Gets the VisArea which is present at a specified point.

Returns

VisArea containing point, if any, 0 otherwise.

Gets the ocean water level. Fastest option, always prefer is only ocean height required.

Note

This function will take into account just the global water level.

Returns

A float value which indicate the water level. In case no water was

found at the specified location, the value WATER_LEVEL_UNKNOWN will

be returned.

Gets the closest walkable bottom z straight beneath the given reference position. Use with accurate query with caution - it is slow.

Note

This function will take into account both the global water level and any water volume present.

Function is provided twice for performance with diff. arguments.

Parameters

pvPos	- Desired position to inspect the water level
pent	- Pointer to return the physical entity to test against (optional)

Returns

A float value which indicate the water level. In case no water was

found at the specified location, the value WATER_LEVEL_UNKNOWN will

be returned.

Tests for intersection against Vis Areas.

Parameters

[in]

box

Volume to test for intersection. [out] pNodeCache Optional, set to a cached pointer for quicker calls to ClipToVisAreas.

Returns

Whether box intersects any vis areas.

Returns

true if segmented world is performing an operation (load/save/move/etc). Warning: deprecated Segmented World implementation is not supported by CryEngine anymore

Returns

true if tessellation is allowed for given render object.

Returns

whether a world pos is under water.

Determines if two VisAreas are connected. Used to determine if a sound is potentially hearable between two VisAreas.

Parameters

pArea1	A pointer to a VisArea.
pArea2	A pointer to a VisArea.
nMaxRecursion	Maximum number of recursions to be done.
bSkipDisabledPortals	Indicate if disabled portals should be skipped.

Returns

A boolean value set to true if the two VisAreas are connected, else false will be returned.

Loads the contents of a chunkfile into the given CContentCGF.

Returns

true on success, false on error.

Loads the contents of a chunkfile into the given CContentCGF.

Returns

true on success, false on error.

Loads a designer object from a stream of decoded binary node (Base64Decode).

Parameters

szBinaryStream

- decoded stream + size.

Loads a geometry cache from a CAX file.

Parameters

szFileName

CAX Filename - should not be 0 or "".

Returns

A pointer to an object derived from IGeomCache.

Load a level. Will load a level from the folder specified with SetLevelPath. If a level is already loaded, the resources will be deleted before.

Parameters

szFolderName	- Name of the subfolder to load
szMissionName	- Name of the mission

Returns

A boolean which indicate the result of the function; true if succeeded, false if failed.

Loads a static object from a CGF file.

Parameters

szFileName	- CGF Filename - should not be 0 or ""
szGeomName	- Optional name of geometry inside CGF.
ppSubObject	- [Out]Optional Out parameter,Pointer to the
nLoadingFlags	- Zero or a bitwise combination of the flags from ELoadingFlags, defined in IMaterial.h, under the interface IMaterialManager.

Returns

A pointer to an object derived from IStatObj.

Notifies of an explosion, and maybe creates an hole in the terrain. This function should usually make sure that no static objects are near before making the hole.

Parameters

vPos	- Position of the explosion
fRadius	- Radius of the explosion
bDeformTerrain	- Allow to deform the terrain

Handles any work needed at start of new frame.

Note

Should be called for every frame.

Pre-caches some resources need for rendering. Must be called after the game completely finishes loading the level. 3D engine uses it to pre-cache some resources needed for rendering.

Registers an entity to be rendered.

Parameters

pEntity

The entity to render.

Draws the world.

Parameters

szDebugName

Name that can be visualized for debugging purpose, must not be 0.

Reload the heightmap. Reloading the heightmap will resets all decals and particles.

Note

In future will restore deleted vegetations

Returns

true on success, false otherwise.

Gets wind direction and forace at the sample points provided.

Note

The positions defining the samples will be overwritten with the accumulated wind influences.

Saves pStatObj to a stream.

Note

Full mesh for generated ones, path/geom otherwise.

Selects an entity for debugging.

Parameters

pEntity

- The entity to render.

Sets the path used to load levels.

Parameters

szFolderName

Should contains the folder to be used.

Sets the view distance scale.

Parameters

fScale

- may be between 0 and 1, 1.f = Unmodified view distance set by level designer, value of 0.5 will reduce it twice.

Note

This value will be reset automatically to 1 on next level loading.

Returns

whether ocean volume is visible or not.

Sets the physics material enumerator.

Parameters

pPhysMaterialEnumerator

The physics material enumarator to set.

Clears all rendering resources, all objects, characters and materials, voxels and terrain.

Note

Should always be called before LoadLevel, and also before loading textures from a script.

Notices the 3D Engine to stop rendering a specified entity.

Parameters

pEntity

- The entity to stop render

Updates the 3D Engine.

Note

Should be called for every frame.

Updates a ClipVolume.

Parameters

pClipVolume	Pointer to volume that needs updating.
pRenderMesh	Pointer to new render mesh.
worldTM	Updated world transform.
szName	Updated ClipVolume name.

Updates rendering mesh in the stat obj associated with pPhysGeom.

Note

Creates or clones the object if necessary.