Programming
Fundamentals
Setting Up Development Environment
UnigineScript
High-Level Systems
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
Rendering-Related Classes

API Migration

Major Changes

  • Added new Dataset class.
  • Added new FieldWeather class.
  • Added new ObjectCloudLayer class.
  • Added new ObjectTerrainGlobal class.
  • Added new PackageUng class.
  • The const char * and string argument types of ControlsJoystick::getStateName(), ControlsSixAxis::getStateName(), ControlsXPad360::getStateName(), ControlsApp::getStateName() has been changed to String.

App Class

New Functions

Body Class

Blob Class

Checksum Class

UNIGINE 2.3.1 UNIGINE 2.4
CRC32() Changed the set of arguments.
MD5() Changed the set of arguments.
MD5() Changed the set of arguments.
SHA1() Changed the set of arguments.
SHA1() Changed the set of arguments.

New Functions

Console Class

DecalMesh Class

UNIGINE 2.3.1 UNIGINE 2.4
setMeshName() Changed the set of arguments.
loadMesh() Changed the type of the return value.

Editor Class

New Functions

The following engine.editor functions has been added to UnigineScript API:

EditorLogic Class

UNIGINE 2.3.1 UNIGINE 2.4
nodeAdded() Changed the type of the argument.
nodeReleased() Changed the type of the argument.
nodeRemoved() Changed the type of the argument.
nodeUpdated() Changed the type of the argument.

New Functions

engine.oculus Functions

engine.system Functions

New Functions

engine.vive Functions

FieldHeight Class

New Functions

FieldShoreline Class

New Functions

GeodeticPivot Class

UNIGINE 2.3.1 UNIGINE 2.4
setRegionHeight() Removed.
getRegionHeight() Removed.
setRegionTexture() Removed.
getRegionTexture() Removed.
setRegionTextureImage() Removed.
getRegionTextureImage() Removed.
setRegionTextureName() Removed.
getRegionTextureName() Removed.
setRegionTextureResolution() Removed.
getRegionTextureResolution() Removed.
setRegionWidth() Removed.
getStatus() Removed.
cancelUpdateTopology() Removed.
endUpdateTopology() Removed.
loadRegionTexture() Removed.
progressUpdateTopology() Removed.
saveRegionTexture() Removed.
startUpdateTopology() Removed.

New Functions

Image Class

Material Class

UNIGINE 2.3.1 UNIGINE 2.4
findParameter() Renamed fetchParameter().
findState() Renamed fetchState().
findTexture() Renamed fetchTexture().
TEXTURE_LIGHT_NOISE Removed.
TEXTURE_LIGHT_VCUBE Removed.
TEXTURE_ALPHA_FADE Removed.
TEXTURE_DEFERRED_DECAL_MASK Removed.
TEXTURE_DEFERRED_DEPTH Removed.
TEXTURE_DEFERRED_DIFFUSE Removed.
TEXTURE_DEFERRED_LIGHT_MAP Removed.
TEXTURE_DEFERRED_NORMAL Removed.
TEXTURE_DEFERRED_OCCLUSION Removed.
TEXTURE_DEFERRED_SPECULAR Removed.
TEXTURE_DEFERRED_VELOCITY Removed.
TEXTURE_ENVIRONMENT Removed.

New Functions

Node Class

UNIGINE 2.3.1 UNIGINE 2.4
setNodeDirection() Renamed setDirection()
getNodeDirection() Renamed getDirection()
setNodePosition() Renamed setPosition()
getNodePosition() Renamed getPosition()
setNodeRotation() Renamed setRotation()
getNodeRotation() Renamed getRotation()
setNodeScale() Renamed setScale()
getNodeScale() Renamed getScale()
setNodeWorldDirection() Renamed setWorldDirection()
getNodeWorldDirection() Renamed getWorldDirection()
setNodeWorldPosition() Renamed setWorldPosition()
getNodeWorldPosition() Renamed getWorldPosition()
setNodeWorldRotation() Renamed setWorldRotation()
getNodeWorldRotation() Renamed getWorldRotation()
setNodeWorldScale() Renamed setWorldScale()
getNodeWorldScale() Renamed getWorldScale()

New Functions

NavigationMesh Class

UNIGINE 2.3.1 UNIGINE 2.4
setMeshName() Changed the set of arguments and the type of the return value.

ObjectMeshCluster Class

UNIGINE 2.3.1 UNIGINE 2.4
setMeshName() Changed the set of arguments.

ObjectMeshClutter Class

UNIGINE 2.3.1 UNIGINE 2.4
setMeshName() Changed the set of arguments.

ObjectMeshStatic Class

UNIGINE 2.3.1 UNIGINE 2.4
setMeshName() Changed the set of arguments.

ObjectMeshSkinned Class

UNIGINE 2.3.1 UNIGINE 2.4
setAnimName() Changed the set of arguments.
setMeshName() Changed the set of arguments.

ObjectTerrain Class

ObjectText Class

ObjectWaterMesh Class

UNIGINE 2.3.1 UNIGINE 2.4
setMeshName() Changed the set of arguments and the type of the return value.

Physics Class

Ptr Class

New Functions

Render Class

UNIGINE 2.3.1 UNIGINE 2.4
PASS_OBJECT_POST Removed.
isDepthZeroToOne() Removed.
setSSRDepthThreshold() Removed.
isSSRDepthThreshold() Removed.
setSSRFarDistanceScale() Removed.
getSSRFarDistanceScale() Removed.
setSSRFarEnabled() Removed.
isSSRFarEnabled() Removed.
setSSRFarQuality() Removed.
getSSRFarQuality() Removed.
setSSRNearDistanceScale() Removed.
getSSRNearDistanceScale() Removed.
setSSRNearEnabled() Removed.
isSSRNearEnabled() Removed.
setSSRNearQuality() Removed.
getSSRNearQuality() Removed.
setSSRNormalThreshold() Removed.
isSSRNormalThreshold() Removed.

New Functions

RenderState Class

UNIGINE 2.3.1 UNIGINE 2.4
ALPHA_COVERAGE Removed.
ALPHA_NONE Removed.

Sound Class

Utils Class

New Functions

Variable Class

World Class

New Functions

The following engine.world functions have been added to UnigineScript API:

WorldOccluderMesh Class

UNIGINE 2.3.1 UNIGINE 2.4
setMeshName() Changed the set of arguments and the type of the return value.

Math Common Functions

UNIGINE 2.3.1 UNIGINE 2.4
round() Changed the type of return value.
Notice
In case if you used Unigine::Math::round(expr) function with an integer return value, it is recommended to replace it with Unigine::Math::ftoi(Unigine::Math::round(expr))

UUSL Changes

Last update: 2017-07-03