UnigineScript
The Language
Core Library
Engine Library
Node-Related Classes
GUI-Related Classes
Plugins Library
High-Level Systems
Samples
Usage Examples
C++ API
API Reference
Integration Samples
Usage Examples
C++ Plugins
Migration
Migrating to UNIGINE 2.0
C++ API Migration
Migrating from UNIGINE 2.0 to UNIGINE 2.1

Migrating from RC to 2.0

Changes in Classes

Removed Classes

Decals-Related Classes

The following decals-related classes have been removed:

  • DecalDeferred
  • DecalDeferredMesh
  • DecalDeferredProj
  • DecalDeferredOrtho
  • DecalObject
  • DecalObjectOrtho
  • DecalObjectOmni
  • DecalObjectProj
  • DecalRender
  • DecalTerrain
  • DecalTerrainProj
  • DecalTerrainOrtho

Lights-Related Classes

The following lights-related classes have been deleted:

  • LightProb
  • LightSpot

GUI-Related Classes

The following GUI-related class has been deleted:

  • WidgetSpriteMaterial

Objects-Related Classes

The following objects-related class has been removed:

  • ObjectBillboard

Added Classes

Decals-Related Classes

The following decals-related classes have been added:

Lights-Related Classes

The following lights-related class has been added:

Changes in Functions and Variables

Node-Related Classes

Node Class

UNIGINEUNIGINE 2.0
NODE_LIGHT_PROB-
NODE_LIGHT_SPOT-
NODE_DECAL_OBJECT_OMNI-
NODE_DECAL_OBJECT_PROJ
NODE_DECAL_TERRAIN_PROJ
NODE_DECAL_DEFERRED_PROJ
NODE_DECAL_PROJ
NODE_DECAL_OBJECT_ORTHO
NODE_DECAL_TERRAIN_ORTHO
NODE_DECAL_DEFERRED_ORTHO
NODE_DECAL_ORTHO
NODE_DECAL_DEFERRED_MESHNODE_DECAL_MESH
NODE_OBJECT_BILLBOARD-
int getNumChilds() int getNumChildren()
See details below.

Remarks:

  1. The int getNumChilds() function is depricated. It is provided to keep your code working until the next release. Please, replace it with int getNumChildren().
New Functions and Variables

Decals-Related Classes

Decal Class
UNIGINEUNIGINE 2.0
int getDecalMask()Removed
int getLightMask()Removed
int isDecalDeferred()Removed
int isDecalObject()Removed
int isDecalTerrain()Removed
void setDecalMask(int mask)Removed
void setLightMask(int mask)Removed
New Functions and Variables

Lights-Related Classes

Light Class
UNIGINEUNIGINE 2
void setDeferred(int deferred)Removed
int isDeferred()Removed
void setDiffuseScale(float scale)Removed
float getDiffuseScale()Removed
void setNormalScale(float scale)Removed
float getNormalScale()Removed
void setSpecularScale(float scale)Removed
float getSpecularScale()Removed
void setSpecularPower(float power)Removed
float getSpecularPower()Removed
void setTranslucent(int mode)Removed
int getTranslucent()Removed
void setTranslucentSize(int size)Removed
int getTranslucentSize()Removed
void setShadowAmbient(float factor)Removed
float getShadowAmbient()Removed
void setTranslucentBias(float offset)Removed
float getTranslucentBias()Removed
void setDeferredDistance(float distance)Removed
float getDeferredDistance()Removed

Objects-Related Classes

Object Class
UNIGINEUNIGINE 2
void setReceiveShadow(int mode, int surface)Removed
int getReceiveShadow(int surface)Removed
void setReceiveWorldShadow(int mode, int surface)Removed
int getReceiveWorldShadow(int surface)Removed
void setDecal(int mode, int surface)Removed
int getDecal(int surface)Removed
void setDecalMask(int mask, int surface)Removed
int getDecalMask(int surface)Removed
int getNumObjectDecals(int surface)Removed
void removeObjectDecals(int surface)Removed
ObjectMeshClutter Class
UNIGINEUNIGINE 2
void setSpawnRate(int spawn)Removed
int getSpawnRate()Removed
ObjectMeshSkinnedClass
UNIGINEUNIGINE 2
int getNumBoneChilds(int bone)int getNumBoneChildren(int bone)
See remarks below.
void setBoneChildsTransform(int bone, mat4 transform)void setBoneChildrenTransform(int bone, mat4 transform)
See remarks below.
void setWorldBoneChildsTransform(int bone, mat4 transform)void setWorldBoneChildrenTransform(int bone, mat4 transform)
See remarks below.

Remarks:

  1. The function is deprecated. It is provided to keep your code working until the next release. Please, replace it with the new one.
  2. The function is deprecated. It is provided to keep your code working until the next release. Please, replace it with the new one.
  3. The function is deprecated. It is provided to keep your code working until the next release. Please, replace it with the new one.
ObjectGrass Class
UNIGINEUNIGINE 2
void setSpawnRate(int spawn)Removed
int getSpawnRate()Removed

Engine Functions

engine.render Functions

UNIGINEUNIGINE 2
int engine.render.getTranslucent()Removed
int engine.render.getDeferred()Removed
int engine.render.getLightProb()Removed
int engine.render.getOcclusion()Removed
int engine.render.getGlow()Removed
void engine.render.setLightProbMask(int maskRemoved
int engine.render.getLightProbMask()Removed
void engine.render.setLightProbDistance(float distance)Removed
float engine.render.getLightProbDistance()Removed
void engine.render.setLightProbAttenuation(float attenuation)Removed
float engine.render.getLightProbAttenuation()Removed
void engine.render.setLightProbFresnelBias(float bias)Removed
float engine.render.getLightProbFresnelBias()Removed
void engine.render.setLightProbFresnelPower(float power)Removed
float engine.render.getLightProbFresnelPower()Removed
void engine.render.setLightProbDiffuseScale(float scale)Removed
float engine.render.getLightProbDiffuseScale() Removed
void engine.render.setLightProbSpecularScale(float scale)Removed
float engine.render.getLightProbSpecularScale()Removed
void engine.render.setOcclusionAmbientScreenRadius(float radius)Removed
float engine.render.getOcclusionAmbientScreenRadius()Removed
void engine.render.setOcclusionAmbientSampleRadius(float radius)Removed
float engine.render.getOcclusionAmbientSampleRadius()Removed
void engine.render.setOcclusionAmbientPerspective(float perspective)Removed
float engine.render.getOcclusionAmbientPerspective()Removed
void engine.render.setOcclusionAmbientAttenuation(float attenuation)Removed
float engine.render.getOcclusionAmbientAttenuation()Removed
void engine.render.setOcclusionAmbientThreshold(float threshold)Removed
float engine.render.getOcclusionAmbientThreshold()Removed
void engine.render.setOcclusionAmbientEmitter(float emitter)Removed
float engine.render.getOcclusionAmbientEmitter()Removed
void engine.render.setOcclusionAmbientReceiver(float value)Removed
float engine.render.getOcclusionAmbientReceiver()Removed
void engine.render.setOcclusionAmbientPower(float power)Removed
float engine.render.getOcclusionAmbientPower()Removed
void engine.render.setOcclusionAmbientScale(float scale)Removed
float engine.render.getOcclusionAmbientScale()Removed
void engine.render.setOcclusionLightScreenRadius(float radius)Removed
float engine.render.getOcclusionLightScreenRadius()Removed
void engine.render.setOcclusionLightSampleRadius(float radius)Removed
float engine.render.getOcclusionLightSampleRadius()Removed
void engine.render.setOcclusionLightPerspective(float perspective)Removed
float engine.render.getOcclusionLightPerspective()Removed
void engine.render.setOcclusionLightAttenuation(float attenuation)Removed
float engine.render.getOcclusionLightAttenuation()Removed
void engine.render.setOcclusionLightThreshold(float threshold)Removed
float engine.render.getOcclusionLightThreshold()Removed
void engine.render.setOcclusionLightEmitter(float emitter)Removed
float engine.render.getOcclusionLightEmitter()Removed
void engine.render.setOcclusionLightReceiver(float value)Removed
float engine.render.getOcclusionLightReceiver()Removed
void engine.render.setOcclusionLightScale(float scale)Removed
float engine.render.getOcclusionLightScale()Removed
void engine.render.setOcclusionLightPower(float power)Removed
float engine.render.getOcclusionLightPower()Removed
void engine.render.setMotionBlurLinearScale(float scale)Removed
float engine.render.getMotionBlurLinearScale()Removed
void engine.render.setMotionBlurAngularScale(float scale)Removed
float engine.render.getMotionBlurAngularScale()Removed
void engine.render.setGlowThreshold(float threshold)Removed
float engine.render.getGlowThreshold()Removed
void engine.render.setGlowSmallExposure(float exposure)Removed
float engine.render.getGlowSmallExposure()Removed
void engine.render.setGlowMediumExposure(float exposure)Removed
float engine.render.getGlowMediumExposure()Removed
void engine.render.setGlowLargeExposure(float exposure)Removed
float engine.render.getGlowLargeExposure()Removed
int engine.render.getHDR()Removed
int engine.render.getShaders()int engine.render.getShadersQuality()
int engine.render.getTextures()int engine.render.getTexturesQuality()
void engine.render.setHDRThreshold(float threshold)void engine.render.setCameraEffectsThreshold(float threshold)
float engine.render.getHDRThreshold()float engine.render.getCameraEffectsThreshold()
int engine.render.setHDRLensTextureName(string name)int engine.render.setDirtTextureName(string name)
string engine.render.getHDRLensTextureName()string engine.render.getDirtTextureName()
void engine.render.setHDRExposure(float exposure)void engine.render.setExposure(float exposure)
float engine.render.getHDRExposure()float engine.render.getExposure()
void engine.render.setHDRAdaptation(float period)void engine.render.setExposureAdaptation(float period)
float engine.render.getHDRAdaptation()float engine.render.getExposureAdaptation()
void engine.render.setHDRMinLuminance(float luminance)void engine.render.setExposureMinLuminance(float luminance)
float engine.render.getHDRMinLuminance()float engine.render.getExposureMinLuminance()
void engine.render.setHDRMaxLuminance(float luminance)void engine.render.setExposureMaxLuminance(float luminance)
float engine.render.getHDRMaxLuminance()float engine.render.getExposureMaxLuminance()
void engine.render.setHDRBrightExposure(float exposure)void engine.render.setExposureBright(float exposure)
float engine.render.getHDRBrightExposure()float engine.render.getExposureBright()
void engine.render.setHDRFilmicShoulderScale(float scale) void engine.render.setFilmicShoulderScale(float scale)
float engine.render.getHDRFilmicShoulderScale()float engine.render.getFilmicShoulderScale()
void engine.render.setHDRFilmicLinearScale(float scale)void engine.render.setFilmicLinearScale(float scale)
float engine.render.getHDRFilmicLinearScale()float engine.render.getFilmicLinearScale()
void engine.render.setHDRFilmicLinearAngle(float angle)void engine.render.setFilmicLinearAngle(float angle)
float engine.render.getHDRFilmicLinearAngle()float engine.render.getFilmicLinearAngle()
void engine.render.setHDRFilmicToeScale(float scale)void engine.render.setFilmicToeScale(float scale)
float engine.render.getHDRFilmicToeScale()float engine.render.getFilmicToeScale()
void engine.render.setHDRFilmicToeNumerator(float scale)void engine.render.setFilmicToeNumerator(float scale)
float engine.render.getHDRFilmicToeNumerator()float engine.render.getFilmicToeNumerator()
void engine.render.setHDRFilmicToeDenominator(float scale)void engine.render.setFilmicToeDenominator(float scale)
float engine.render.getHDRFilmicToeDenominator()float engine.render.getFilmicToeDenominator()
void engine.render.setHDRFilmicWhiteLevel(float scale)void engine.render.setFilmicWhiteLevel(float scale)
float engine.render.getHDRFilmicWhiteLevel()float engine.render.getFilmicWhiteLevel()
void engine.render.setHDRCrossEnabled(int mode)void engine.render.setCrossEnabled(int mode)
int engine.render.isHDRCrossEnabled()int engine.render.isCrossEnabled()
void engine.render.setHDRCrossColor(vec4 color)void engine.render.setCrossColor(vec4 color)
vec4 engine.render.getHDRCrossColor()vec4 engine.render.getCrossColor()
void engine.render.setHDRCrossScale(float scale)void engine.render.setCrossScale(float scale)
float engine.render.getHDRCrossScale()float engine.render.getCrossScale()
void engine.render.setHDRCrossLength(float length)void engine.render.setCrossLength(float length)
float engine.render.getHDRCrossLength()float engine.render.getCrossLength()
void engine.render.setHDRCrossShafts(int amount)void engine.render.setCrossShafts(int amount)
int engine.render.getHDRCrossShafts()int engine.render.getCrossShafts()
void engine.render.setHDRCrossAngle(float angle)void engine.render.setCrossAngle(float angle)
float engine.render.getHDRCrossAngle()float engine.render.getCrossAngle()
void engine.render.setHDRCrossThreshold(float threshold)void engine.render.setCrossThreshold(float threshold)
float engine.render.getHDRCrossThreshold()float engine.render.getCrossThreshold()
void engine.render.setHDRBokehEnabled(int enable)void engine.render.setBokehEnabled(int enable)
int engine.render.isHDRBokehEnabled()int engine.render.isBokehEnabled()
void engine.render.setHDRBokehColor(vec4 color)void engine.render.setBokehColor(vec4 color)
vec4 engine.render.getHDRBokehColor()vec4 engine.render.getBokehColor()
void engine.render.setHDRBokehScale(float scale)void engine.render.setBokehScale(float scale)
float engine.render.getHDRBokehScale()float engine.render.getBokehScale()
void engine.render.setHDRBokehFarSize(float size)void engine.render.setBokehFarSize(float size)
float engine.render.getHDRBokehFarSize()float engine.render.getBokehFarSize()
void engine.render.setHDRBokehFarPower(float power)void engine.render.setBokehFarPower(float power)
float engine.render.getHDRBokehFarPower()float engine.render.getBokehFarPower()
void engine.render.setHDRBokehNearSize(float size)void engine.render.setBokehNearSize(float size)
float engine.render.getHDRBokehNearSize()float engine.render.getBokehNearSize()
void engine.render.setHDRBokehNearPower(float power)void engine.render.setBokehNearPower(float power)
float engine.render.getHDRBokehNearPower()float engine.render.getBokehNearPower()
void engine.render.setHDRBokehThreshold(float threshold)void engine.render.setBokehThreshold(float threshold)
float engine.render.getHDRBokehThreshold()float engine.render.getBokehThreshold()
int engine.render.setHDRBokehTextureName(string name)int engine.render.setBokehTextureName(string name)
string engine.render.getHDRBokehTextureName()string engine.render.getBokehTextureName()
void engine.render.setHDRShaftEnabled(int enable)void engine.render.setSunShaftsEnabled(int enable)
int engine.render.isHDRShaftEnabled()int engine.render.isSunShaftsEnabled()
void engine.render.setHDRShaftColor(vec4 color)void engine.render.setSunShaftsColor(vec4 color)
vec4 engine.render.getHDRShaftColor()vec4 engine.render.getSunShaftsColor()
void engine.render.setHDRShaftScale(float scale)void engine.render.setSunShaftsScale(float scale)
float engine.render.getHDRShaftScale()float engine.render.getSunShaftsScale()
void engine.render.setHDRShaftLength(float length)void engine.render.setSunShaftsLength(float length)
float engine.render.getHDRShaftLength()float engine.render.getSunShaftsLength()
void engine.render.setHDRShaftAttenuation(float value)void engine.render.setSunShaftsAttenuation(float value)
float engine.render.getHDRShaftAttenuation()float engine.render.getSunShaftsAttenuation()
void engine.render.setHDRShaftThreshold(float threshold)void engine.render.setSunShaftsThreshold(float threshold)
float engine.render.getHDRShaftThreshold()float engine.render.getSunShaftsThreshold()
void engine.render.setHDRLensEnabled(int mode)void engine.render.setLensEnabled(int mode)
int engine.render.isHDRLensEnabled()int engine.render.isLensEnabled()
void engine.render.setHDRLensColor(vec4 color)void engine.render.setLensColor(vec4 color)
vec4 engine.render.getHDRLensColor()vec4 engine.render.getLensColor()
void engine.render.setHDRLensScale(float scale)void engine.render.setLensScale(float scale)
float engine.render.getHDRLensScale()float engine.render.getLensScale()
void engine.render.setHDRLensLength(float length)void engine.render.setLensLength(float length)
float engine.render.getHDRLensLength()float engine.render.getLensLength()
void engine.render.setHDRLensRadius(float radius)void engine.render.setLensRadius(float radius)
float engine.render.getHDRLensRadius()float engine.render.getLensRadius()
void engine.render.setHDRLensThreshold(float threshold)void engine.render.setLensThreshold(float threshold)
float engine.render.getHDRLensThreshold()float engine.render.getLensThreshold()
void engine.render.setHDRLensDispersion(vec3 dispersion)void engine.render.setLensDispersion(vec3 dispersion)
vec3 engine.render.getHDRLensDispersion()vec3 engine.render.getLensDispersion()
int engine.render.getVolumetric()int engine.render.getShadowShafts()
void engine.render.setVolumetricExposure(float exposure)void engine.render.setShadowShaftsExposure(float exposure)
float engine.render.getVolumetricExposure()float engine.render.getShadowShaftsExposure()
void engine.render.setVolumetricLength(float length)void engine.render.setShadowShaftsLength(float length)
float engine.render.getVolumetricLength()float engine.render.getShadowShaftsLength()
void engine.render.setVolumetricAttenuation(float value)void engine.render.setShadowShaftsAttenuation(float value)
float engine.render.getVolumetricAttenuation() float engine.render.getShadowShaftsAttenuation()
RENDER_BOX
RENDER_DODECAHEDRON
RENDER_ICOSAHEDRON
RENDER_SPHERE
Removed
RENDER_OCCLUSION_DISABLED
RENDER_OCCLUSION_AMBIENT
RENDER_OCCLUSION_LIGHT
RENDER_OCCLUSION_AMBIENT_LIGHT
Removed
RENDER_HDR_DISABLEDRENDER_EXPOSURE_DISABLED
RENDER_HDR_LOGARITHMICRENDER_EXPOSURE_LOGARITHMIC
RENDER_HDR_QUADRATIC"RENDER_EXPOSURE_QUADRATIC
New Functions and Variables

engine.gui Functions

UNIGINEUNIGINE 2
int engine.gui.getNumChilds() int engine.gui.getNumChildren()
See details below

Remarks:

  1. The int engine.gui.getNumChilds() function is depricated. It is provided to keep your code working until the next release. Please, replace it with int engine.gui.getNumChildren().

engine.visualizer Functions

UNIGINEUNIGINE 2
void engine.visualizer.renderLightProbHandler(LightProb light, float radius, vec4 color)Removed
New Functions

engine.editor Functions

UNIGINEUNIGINE 2
int engine.editor.renderLightMapDirect(Object object, int surfaces = [], int blur, int width, int height, Image image) Removed
int engine.editor.renderLightMapIndirect(Object object, int surfaces = [], int samples, float radius, int width, int height, Image image) Removed
New Functions

GUI-Related Classes

Gui Class

UNIGINEUNIGINE 2
int getNumChilds()int getNumChildren()
See remarks below.

Remarks:

  1. The int getNumChilds() function is depricated. It is provided to keep your code working until the next release. Please, replace it with int getNumChildren().

Widget Class

UNIGINEUNIGINE 2
int getNumChilds()int getNumChildren()
See remarks below.

Remarks:

  1. The int getNumChilds() function is depricated. It is provided to keep your code working until the next release. Please, replace it with int getNumChildren().

WidgetTreeBox Class

UNIGINEUNIGINE 2
int getNumItemChilds(int item)int getNumItemChildren(int item)
See remarks below.

Remarks:

  1. The int getNumItemChilds(int item) function is depricated. It is provided to keep your code working until the next release. Please, replace it with int getNumItemChildren(int item).

Physics-Related Classes

Body Class

UNIGINEUNIGINE 2
int getNumChilds() int getNumChildren()
See details below.

Remarks:

  1. The int getNumChilds() function is depricated. It is provided to keep your code working until the next release. Please, replace it with int getNumChildren().

Material Class

UNIGINEUNIGINE 2
int getCastTranslucent() Removed.
int getDownsize() Removed.
int getGlowMask() Removed.
int getGroup() Removed.
int getNumChilds() int getNumChildren()
See remarks below.
int getOcclusionMask() Removed.
int getParallaxMask() Removed.
int getParameterColorSRGB(int num) Removed.
int getPostDeferred() Removed.
int getReceiveShadow() Removed.
int getReceiveTranslucent() Removed.
int getReceiveWorldShadow() Removed.
int isReflectionCube() Removed.
int isOpacity() Removed.
int isTransparent() int getTransparent()
See remarks below.
int getTransparent() int getTransparent()
See remarks below.
void setTransparent(int transparent) void setTransparent(int transparent)
See remarks below.
void setCastTranslucent(int mode) Removed.
void setDownsize(int downsize) Removed.
void setGlowMask(int mode) Removed.
void setPostDeferred(int enable) Removed.
void setGroup(int group) Removed.
void setOcclusionMask(int mode) Removed.
void setParallaxMask(int mode) Removed.
int setPostDeferred(int mode) Removed.
void setReceiveShadow(int mode) Removed.
void setReceiveTranslucent(int mode) Removed.
void setReceiveWorldShadow(int mode) Removed.
MATERIAL_TEXTURE_DEFERRED_COLOR Removed
MATERIAL_TEXTURE_LIGHT_COLORRemoved
MATERIAL_TEXTURE_REFLECTION_CUBE
MATERIAL_TEXTURE_REFLECTION_2D
Removed
MATERIAL_TEXTURE_DOWNSIZERemoved
MATERIAL_DOWNSIZE_NONE
MATERIAL_DOWNSIZE_ALWAYS_SCALE
MATERIAL_DOWNSIZE_ALWAYS_FILTER
MATERIAL_DOWNSIZE_GREATER_SCALE
MATERIAL_DOWNSIZE_GREATER_FILTER
MATERIAL_DOWNSIZE_FORWARD_SCALE
MATERIAL_DOWNSIZE_FORWARD_FILTER
Removed

Remarks:

  1. The isTransparent() function renamed to int getTransparent() class.
  2. Now the int getTransparent() function returns 0, 1 or 2:
  3. Now the void setTransparent(int transparent) function arguments could be the following:
  4. The int getNumChilds() function is depricated. It is provided to keep your code working until the next release. Please, replace it with int getNumChildren().

New Functions and Variables

Property Class

UNIGINEUNIGINE 2
int getNumChilds() int getNumChildren()
See remarks below.

Remarks:

  1. The int getNumChilds() function is depricated. It is provided to keep your code working until the next release. Please, replace it with int getNumChildren().
Last update: 2017-07-03