Forum
Docs (1.0)
Unsupported SDK
UNIGINE Future
(Unsupported SDK)
UNIGINE 2.19 (Latest)
(Unsupported SDK)
UNIGINE 2.18.1
(Unsupported SDK)
UNIGINE 2.18
(Unsupported SDK)
UNIGINE 2.17
(Unsupported SDK)
UNIGINE 2.16.1
(Unsupported SDK)
UNIGINE 2.16
(Unsupported SDK)
UNIGINE 2.15.1
(Unsupported SDK)
UNIGINE 2.15
(Unsupported SDK)
UNIGINE 2.14.1
(Unsupported SDK)
UNIGINE 2.14
(Unsupported SDK)
UNIGINE 2.13
(Unsupported SDK)
UNIGINE 2.12
(Unsupported SDK)
UNIGINE 2.11
(Unsupported SDK)
UNIGINE 2.10
(Unsupported SDK)
UNIGINE 2.9
(Unsupported SDK)
UNIGINE 2.8
(Unsupported SDK)
UNIGINE 2.7.3
(Unsupported SDK)
UNIGINE 2.7.2
(Unsupported SDK)
UNIGINE 2.7.1
(Unsupported SDK)
UNIGINE 2.7
(Unsupported SDK)
UNIGINE 2.6.1
(Unsupported SDK)
UNIGINE 2.6
(Unsupported SDK)
UNIGINE 2.5
(Unsupported SDK)
UNIGINE 2.4.1
(Unsupported SDK)
UNIGINE 2.4
(Unsupported SDK)
UNIGINE 2.3.1
(Unsupported SDK)
UNIGINE 2.3
(Unsupported SDK)
UNIGINE 2.2.1
(Unsupported SDK)
UNIGINE 2.2
(Unsupported SDK)
UNIGINE 2.1.1
(Unsupported SDK)
UNIGINE 2.0
(Unsupported SDK)
UNIGINE 1.0
(Unsupported SDK)
Show older versions >>|Hide older versions <<
Learn
Unsupported SDK
UNIGINE 2.19
(Unsupported SDK)
UNIGINE 2.18.1
(Unsupported SDK)
UNIGINE 2.17
(Unsupported SDK)
Show older versions >>|Hide older versions <<
Select Your Language
The documentation is translated into these languages automatically, so its text may contain inaccuracies and errors.
English
Русский
中文
Français
Deutsch
日本語
한국어
Español
Português
Italiano
Türkçe
Svenska
Suomi
Dansk
Nederlands
Norsk
हिन्दी
Tiếng Việt
Bahasa Indonesia
Polski
Limba Română
Magyar
Cрпски
Slovenčina
Slovenščina
Hrvatski
Český
Bosanski
Македонски
Български
Sign in
This page has been translated automatically.
Click here to view the original English version instead.
in API
Not found
Getting Started
Hardware Requirements
Startup Command-Line Options
Main Menu
Console
Principles of Operation
Virtual World Structure
World Management
Rendering
Rendering Sequence
Lighting
Light Sources Parameters
Lightmap
Alpha Blending
Shading
Shadows
Shadow Mapping
PSSM
HDR Rendering
Bit Masking
Postprocessing
Tessellation
Stereo Rendering
NVIDIA 3D Vision Output with App3DVision Plugin
NVIDIA 3D Vision Surround Output with App3DSurround Plugin
Separate Images Output with AppSeparate Plugin
Quad Buffer with AppQuadBuffer Plugin
Oculus Rift Output with AppOculus Plugin
Multi-Monitor Rendering
Video Wall output with AppWall Plugin
3 Monitor Output with AppSurround Plugin
Panoramic Rendering with AppPanorama Plugin
Projections with AppProjection Plugin
DirectX 11 Software Rendering with AppLevel Plugin
Physics
Physical Bodies
Rigid Body
Rag Doll Body
Fracture Body
Cloth Body
Water Body
Dummy Body
Shapes
Collision Detection
Joints
Simulation of Physics
File System
Built-in Objects
Nodes
Node
Node Reference
Dummy Node
Layer
Pivot
Trigger
Objects
Dummy Object
Static Mesh
Skinned Mesh
Dynamic Mesh
Mesh Cluster
Mesh Clutter
Terrain
Terrain Dimensions and Formats
Terrain Options
Detail Materials
Terrain Grabber
Terrain Editor
Water
Water
Water Mesh
Sky
Grass
Billboards
Billboard Object
Billboards Object
Stars Generator for Billboards
GUI
GUI Object
GUI Mesh
Effects
Particle System
Volumetric Objects
Volume Box
Volume Sphere
Volume Omni
Volume Proj
Fields
Field Spacer
Field Animation
Physicals
Wind Physical
Force Physical
Noise Physical
Water Physical
Trigger Physical
Decals
Object Decals
Omni Object Decal
Proj Object Decal
Orthographic Object Decal
Terrain Decals
Orthographic Terrain Decal
Proj Terrain Decals
Deferred Decals
Proj Deferred Decal
Orthographic Deferred Decal
Mesh Deferred Decal
Light Sources
Probe Light
Omni Light
Spot Light
Projected Light
World Light
World Objects
World Layer
Sector
Portal
World Trigger
World Cluster
World Clutter
Switcher
Occluders
Occluder
Mesh Occluder
Terrain Occluder
Transforms
Transform
Bone Transform
World Expression
Sound Objects
Sound Source
Sound Reverb
Pathfinding Objects
Navigation Area
Navigation Sector
Navigation Mesh
Obstacle
Box Obstacle
Sphere Obstacle
Capsule Obstacle
Players
Player Dummy
Player Persecutor
Programming
Development for Different Platforms
Windows Application Development
Linux Application Development
Mac OS X Application Development
Mobile Platforms
Mobile Application Launcher
iOS Application Development
Android Application Development
Project Optimization for Mobile Devices
Semi-automatic Compilation with Build Script
Manual Compilation with SCons
New Project Generator
Protecting Your Data with a Password
Engine Architecture
Execution Sequence
Where to Put Your Code: Update(), Flush() or Render()
Typical Architecture of a Unigine-Based Application
Memory Management
Mesh File Formats
Material File Format
GUI
UI Files
Containers
Widgets
Localization
RC Files
Skin Layout
Usage Example
Double Precision Coordinates
Using ActionScript
Working with Console
Performance Analyzer
How to Generate Shaders Cache
UnigineScript
The Language
Structure of a Program
Data Types
Operators
Control Statements
Selection Statements
if-else
switch-case
Iteration Statements
for
while
do-while
forloop
foreach
foreachkey
Jump Statements
return
goto
break
continue
Other Statements
yield
wait
call()
thread()
Containers
Container Functions
Functions
Scope. Namespaces
Object Oriented Programming
Interface Class
Preprocessor Directives
Language Features
Core Library
Common Functionality
System Functions
OS Functions
Type Conversion Functions
String Functions
Expression Class
Image Class
Reflection Class
RegExp Class
Stream Class
Buffer Class
Xml Class
Async Class
Log Functions
Math Functionality
Math Common Functions
Math Exponential Functions
Math Matrix Functions
Math Random Functions
Math Trigonometrical Functions
Filesystem Functionality
File System Functions
Dir Class
File Class
Networking Functionality
Socket Class
Engine Library
Variables
Engine Functions
engine Functions
engine.app Functions
engine.config Functions
engine.console Functions
engine.controls Functions
engine.editor Functions
engine.filesystem Functions
engine.game Functions
engine.gui Functions
engine.materials Functions
engine.memory Functions
engine.physics Functions
engine.profiler Functions
engine.properties Functions
engine.render Functions
engine.sound Functions
engine.splash Functions
engine.system Functions
engine.visualizer Functions
engine.world Functions
Node-Related Classes
Node Class
NodeDummy Class
NodeExtern Class
NodeExternBase Class
NodeLayer Class
NodePivot Class
NodeReference Class
NodeTrigger Class
Objects-Related Classes
Object Class
ObjectBillboard Class
ObjectBillboards Class
ObjectDummy Class
ObjectExtern Class
ObjectExternBase Class
ObjectGrass Class
ObjectGui Class
ObjectGuiMesh Class
ObjectMesh Class
ObjectMeshCluster Class
ObjectMeshClutter Class
ObjectMeshDynamic Class
ObjectMeshSkinned Class
ObjectDynamic Class
ObjectParticles Class
ObjectSky Class
ObjectTerrain Class
ObjectVolumeBox Class
ObjectVolumeOmni Class
ObjectVolumeProj Class
ObjectVolumeSphere Class
ObjectWater Class
ObjectWaterMesh Class
Decals-Related Classes
Decal Class
DecalDeferredMesh Class
DecalObjectOrtho Class
DecalObjectOmni Class
DecalObjectProj Class
DecalObject Class
DecalRender Class
DecalTerrain Class
DecalTerrainProj Class
DecalTerrainOrtho Class
DecalDeferred Class
DecalDeferredProj Class
DecalDeferredOrtho Class
Field-Related Classes
Field Class
FieldSpacer Class
FieldAnimation Class
Lights-Related Classes
Light Class
LightOmni Class
LightProb Class
LightProj Class
LightSpot Class
LightWorld Class
Players-Related Classes
Player Class
PlayerActor Class
PlayerDummy Class
PlayerPersecutor Class
PlayerSpectator Class
Sound Nodes-Related Classes
SoundSource Class
SoundReverb Class
World Nodes-Related Classes
WorldCluster Class
WorldClutter Class
WorldExpression Class
WorldExternBase Class
WorldExtern Class
WorldLayer Class
WorldOccluder Class
WorldOccluderMesh Class
WorldOccluderTerrain Class
WorldPortal Class
WorldSector Class
WorldSwitcher Class
WorldTransform Class
WorldTransformBone Class
WorldTrigger Class
AmbientSource Class
Material Class
Property Class
Physics-Related Classes
Bodies-Related Classes
Body Class
BodyDummy Class
BodyFracture Class
BodyRagDoll Class
BodyRail Class
BodyRigid Class
BodyWater Class
BodyParticles Class
BodyCloth Class
BodyRope Class
Shapes-Related Classes
Shape Class
ShapeBox Class
ShapeCapsule Class
ShapeConvex Class
ShapeCylinder Class
ShapeSphere Class
Joints-Related Classes
Joint Class
JointBall Class
JointCylindrical Class
JointFixed Class
JointHinge Class
JointParticles Class
JointPrismatic Class
JointRail Class
JointSuspension Class
JointWheel Class
Physical Nodes-Related Classes
Physical Class
PhysicalForce Class
PhysicalTrigger Class
PhysicalWater Class
PhysicalWind Class
PhysicalNoise Class
GUI-Related Classes
Gui Class
UserInterface Class
Widget Class
WidgetButton Class
WidgetCanvas Class
WidgetCheckBox Class
WidgetComboBox Class
WidgetDialog Class
WidgetDialogColor Class
WidgetDialogFile Class
WidgetDialogImage Class
WidgetDialogMessage Class
WidgetEditLine Class
WidgetEditText Class
WidgetExternBase Class
WidgetExtern Class
WidgetFlash Class
WidgetGridBox Class
WidgetGroupBox Class
WidgetHBox Class
WidgetHPaned Class
WidgetIcon Class
WidgetLabel Class
WidgetListBox Class
WidgetManipulator Class
WidgetManipulatorRotator Class
WidgetManipulatorScaler Class
WidgetManipulatorTranslator Class
WidgetMenuBar Class
WidgetMenuBox Class
WidgetScroll Class
WidgetScrollBox Class
WidgetSlider Class
WidgetSpacer Class
WidgetSpinBox Class
WidgetSprite Class
WidgetSpriteMaterial Class
WidgetSpriteNode Class
WidgetSpriteShader Class
WidgetSpriteVideo Class
WidgetSpriteViewport Class
WidgetTabBox Class
WidgetTreeBox Class
WidgetVBox Class
WidgetVPaned Class
WidgetWindow Class
Controls-Related Classes
Controls Class
ControlsApp Class
ControlsDummy Class
ControlsJoystick Class
ControlsXPad360 Class
Pathfinding-Related Classes
Navigation Class
NavigationMesh Class
NavigationSector Class
Obstacle Class
ObstacleBox Class
ObstacleCapsule Class
ObstacleSphere Class
PathRoute Class
Plugins Library
AutodeskImport Class
ColladaImport Class
OpenFlightImport Class
Interface Plugin
InterfaceWindow Class
engine.interface Functions
engine.oculus Functions
engine.projection Functions
engine.surround Functions
engine.wall Functions
High-Level Systems
Basic Utilities
Unigine::Widgets
User Interfaces for Unigine::Widgets
Unigine::Schemer
Unigine::Skinner
Unigine::Tracker
Parameters Tracks
How-Tos for Tracker
Running Tracker in Game
Unigine::Syncker
Syncker-Specific Options
Running Syncker for a Custom Project
Running Syncker with AppProjection
Unigine::Syncker::Master Functions
Input System
Character System
KeyLine System
Dialogs Script
Game Framework
Overview
Structure
Editor Plugin
Run-time
Function Library
Framework System Script
Game Namespace
MasterGame Class
Framework World Script
EntityData Class
LevelData Class
GameData Class
Run-Time Classes
Game Class
Level Class
Entity Class
EntityPool Class
LogicModules Class
Field Class
Fields Class
Scheduler Class
FrequencyGroup Class
EventSystem Class
GameEvent Class
GameCallback Class
City Traffic
Roads
Cars
Drivers
Pedestrians
Traffic Manager
Samples
Objects
billboards_00
billboards_01
billboards_02
billboards_03
cluster_00
cluster_01
dynamic_00
dynamic_01
dynamic_02
dynamic_03
dynamic_04
dynamic_05
gui_00
gui_01
gui_02
gui_03
gui_04
gui_05
gui_06
gui_07
clutter_00
clutter_01
clutter_02
particles_00
particles_01
particles_02
particles_03
particles_04
particles_05
grass_00
grass_01
grass_02
grass_03
mesh_00
mesh_01
mesh_02
Plugins
app_oculus_00
app_surround_00
app_surround_01
app_wall_00
cigi_client_00
gpu_monitor_00
renderer_00
sixense_00
ssl_socket_00
ssl_socket_01
Syncker
materails_00
mesh_00
particles_00
projection_00
rpc_00
skinned_00
Cache Files
Script Debugging
C++ API
Creating C++ Application
Creating C++ Plugin
API Reference
Unigine Namespace Functions
Unigine::App Class
Unigine::ArrayMap Class
Unigine::ArrayMap::Iterator Class
Unigine::ArrayVector Class
Unigine::AtomicLock Class
Unigine::BoundBox Class
Unigine::BoundFrustum Class
Unigine::BoundSphere Class
Unigine::Buffer Class
Unigine::CallbackBase Class
Unigine::Compress Class
Unigine::Checksum Class
Unigine::Config Class
Unigine::Console Class
Unigine::ConsoleVariableFloat Class
Unigine::ConsoleVariableInt Class
Unigine::ConsoleVariableString Class
Unigine::Controls Class
Unigine::Editor Class
Unigine::Engine Class
Unigine::ExternClass< Class > Class Template
Unigine::Ffp Class
Unigine::File Class
Unigine::FileSystem Class
Unigine::FunctionBase Class
Unigine::Game Class
Unigine::Gui Class
Unigine::Image Class
Unigine::Interpreter Class
Unigine::Light Class
Unigine::LightOmni Class
Unigine::LightProb Class
Unigine::LightProj Class
Unigine::LightSpot Class
Unigine::LightWorld Class
Unigine::Log Class
Unigine::Map Class
Unigine::Material Class
Unigine::Materials Class
Unigine::Memory Class
Unigine::Mesh Class
Unigine::MeshSkinned Class
Unigine::Node Class
Unigine::NodeReference Class
Unigine::NodeDummy Class
Unigine::NodeExtern Class
Unigine::NodeExternBase Class
Unigine::NodeLayer Class
Unigine::NodePivot Class
Unigine::NodeTrigger Class
Unigine::Object Class
Unigine::ObjectExtern Class
Unigine::ObjectExternBase Class
Unigine::ObjectBillboard Class
Unigine::ObjectBillboards Class
Unigine::ObjectDummy Class
Unigine::ObjectMesh Class
Unigine::ObjectMeshCluster Class
Unigine::ObjectMeshDynamic Class
Unigine::ObjectMeshSkinned Class
Unigine::ObjectTerrain Class
Unigine::Package Class
Unigine::Physics Class
Unigine::Player Class
Unigine::PlayerDummy Class
Unigine::Plugin Class
Unigine::Property Class
Unigine::Properties Class
Unigine::Ptr< Type > Class Template
Unigine::Set Class
Unigine::Render Class
Unigine::Renderer Class
Unigine::Resource Class
Unigine::Shader Class
Unigine::Socket Class
Unigine::Sound Class
Unigine::State Class
Unigine::Stream Class
Unigine::StreamBase Class
Unigine::String Class
Unigine::Texture Class
Unigine::TextureRender Class
Unigine::Thread Class
Unigine::Timer Class
Unigine::Tree::ConstIterator Class
Unigine::Tree::Iterator Class
Unigine::Tree::Node Class
Unigine::Tree< Key, Data > Class Template
Unigine::TypeInfo Class
Unigine::UserInterface Class
Unigine::Variable Class
Unigine::Vector::ConstIterator Class
Unigine::Vector::Iterator Class
Unigine::Vector< > Class Template
Unigine::Visualizer Class
Unigine::Widget Class
Unigine::WidgetButton Class
Unigine::WidgetCanvas Class
Unigine::WidgetCheckBox Class
Unigine::WidgetComboBox Class
Unigine::WidgetDialog Class
Unigine::WidgetDialogColor Class
Unigine::WidgetDialogFile Class
Unigine::WidgetDialogImage Class
Unigine::WidgetDialogMessage Class
Unigine::WidgetEditLine Class
Unigine::WidgetEditText Class
Unigine::WidgetExtern Class
Unigine::WidgetExternBase Class
Unigine::WidgetGridBox Class
Unigine::WidgetGroupBox Class
Unigine::WidgetHBox Class
Unigine::WidgetHPaned Class
Unigine::WidgetIcon Class
Unigine::WidgetLabel Class
Unigine::WidgetListBox Class
Unigine::WidgetMenuBar Class
Unigine::WidgetMenuBox Class
Unigine::WidgetScroll Class
Unigine::WidgetScrollBox Class
Unigine::WidgetSlider Class
Unigine::WidgetSpacer Class
Unigine::WidgetSpinBox Class
Unigine::WidgetSprite Class
Unigine::WidgetTabBox Class
Unigine::WidgetTreeBox Class
Unigine::WidgetVBox Class
Unigine::WidgetVPaned Class
Unigine::WidgetWindow Class
Unigine::World Class
Unigine::WorldExtern Class
Unigine::WorldExternBase Class
Unigine::WorldLayer Class
Unigine::WorldPortal Class
Unigine::WorldSector Class
Unigine::WorldSwitcher Class
Unigine::WorldTrigger Class
Unigine::Xml Class
Unigine::dmat4 Struct
Unigine::dvec2 Struct
Unigine::dvec3 Struct
Unigine::dvec4 Struct
Unigine::ivec2 Struct
Unigine::ivec3 Struct
Unigine::ivec4 Struct
Unigine::mat4 Struct
Unigine::quat Struct
Unigine::vec2 Struct
Unigine::vec3 Struct
Unigine::vec4 Struct
Unigine::Ffp::Vertex Struct
Unigine::Image::Pixel Struct
Unigine::Mesh::Vertex Struct
Unigine::MeshSkinned::Frame Struct
Unigine::MeshSkinned::Vertex Struct
Unigine::MeshSkinned::Weight Struct
Unigine::ObjectDynamic::Attribute Struct
Unigine::Image::Pixelf Union
Unigine::Image::Pixeli Union
Integration Samples
Unigine Integration into MFC Application
Unigine Integration into SDL Application
Unigine Integration into Qt Application
Usage Examples
Library's Namespace
Variable Export
Constant Export
Function Export
Class Export
Data Structure Export
Callbacks
Serialization
App Class
UnigineScript Containers
C++ Plugins
RakNet Network Library Integration via RakNet Plugin
Network Principles of Operation
Network API
Basic Network Functionality
Network Events and Their Handlers
Connecting / Disconnecting with NetworkAddress
Getting Info on Connection with NetworkStatistics
LAN Server Discovery
Sending Data with SharedData
Replicating Data with SharedState
Network Sample
Remote Access to Resources via FileClient Plugin
CIGI Protocol Support via CigiClient Plugin
Secure SSL Connection via SSLSocket Plugin
GPU Monitoring with GPUMonitor Plugin
Razer Hydra Support via Sixense Plugin
Renderer Customization via Renderer Plugin
Content Creation
Content Pipeline
Level Design
Static Geometry
Texturing
Animation
Materials
Hierarchy and Inheritance
Unigine Material Library
billboard_base
billboards_base
billboards_cloud_base
decal_base
decal_deferred_base
decal_terrain_base
grass_base
grass_impostor_base
gui_base
mesh_base
mesh_indirect_base
mesh_reflection_2d_base
mesh_reflection_cube_base
mesh_reflection_fresnel_base
mesh_chain_base
mesh_layer_base
mesh_leaf_base
mesh_lut_base
mesh_lut_reflection_cube_base
mesh_noise_base
mesh_overlap_base
mesh_paint_base
mesh_paint_reflection_cube_base
mesh_stem_base
mesh_terrain_base
mesh_tessellation_base
mesh_tessellation_indirect_base
mesh_tessellation_reflection_2d_base
mesh_tessellation_reflection_cube_base
mesh_tessellation_reflection_fresnel_base
mesh_tessellation_paint_base
mesh_tessellation_paint_reflection_cube_base
mesh_triplanar_base
mesh_wire_base
particles_base
render_composite
sky_base
terrain_base
volume_cloud_base
volume_fog_base
volume_light_base
volume_omni_base
volume_proj_base
volume_shaft_base
water_base
Postprocess Materials
post_blur_radial
post_filter_antialiasing
post_filter_reflection
post_filter_rgb2rgbl
post_filter_rgb2yuv
post_filter_scattering
post_filter_sobel
post_filter_wet
post_hblur_2d
post_vblur_2d
post_hblur_mask
post_vblur_mask
post_hblur_cube and post_vblur_cube
Custom Materials
Tutorials
Adding Object into a New World
Adding Animated Object into the Loaded World
Adding Scripts to the Project
Setting Up Object LODs
Adding Lighting, Sky and Clouds
Adding Water
Adding Terrain
Creating a Reflective and Refractive Glass
Adding Grass
Adding Impostors to Clutters
Adding Vegetation: Creating a Tree
Adding Vegetation: Random Scattering of Objects
Using Tessellation
Adding Physics for Object
Tools
Plugins for 3D Editors
Plugins for 3ds Max
Plugins for Maya
Plugins for Softimage
Unigine Editor
Interface
Hot Keys and Navigation
Nodes Panel
Material Editor
Properties Editor
Render Settings
Physics Settings
Tools Panel
Snap to Grid
Lightmap Generation Tool
LUT Generation Tool
Plugins
Collada Import Plugin
Autodesk FBX Import Plugin
OpenFlight Import Plugin
Importing Large Populated Areas with City Import Plugin
Making Environment Look Realistic with Randomizer Plugin
Exporting Nodes with Node Export Plugin
Landscape Plugin
SpeedTree Import Plugin
Interface Plugin
Making Custom Editor Plugins
Performance Profiler
ResourceEditor
MeshViewer
NormalMapper
NormalCombiner
AmbientMapper
AlphaMapper
Launcher
Structure
Customization
Customizing Design
Customizing Logic
Available Functions
FileServer
FlashView
ImageDDS
ImageTTF
USC Interpreter
Archiver
Terrain
TerrainMesh
TerrainRelax
XmlTree
MeshImport
Upgrade Script
Table of Contents
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please
switch to the documentation for the latest SDK version
.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please
upgrade to the latest SDK version
.
No
language
code for this page. You can select other language.
C++
C#
UnigineScript
No
language
code for this page,
shown in
other
instead.
Double
Copy
UnigineScript
The Language
Control Statements
Jump Statements
Control Statements
Articles in This Section
return
goto
break
continue
Last update: 2017-07-03
Help improve this article
Was this article helpful?
Yes
No
0
out of
0
users found it helpful
Report a problem related to this article
(or select a word/phrase and press Ctrl+Enter)
You have already voted
What kind of problem related to this article would you like to report?
Type :
Missing information
Incorrect information
Unclear or confusing information
Spelling or grammar error
Code samples do not work
Code samples are needed
Other
Details *:
Login
Email:
Password:
Forgot your password?
Build: ()
We use cookies to ensure that we give you the best experience on our website. Click
here
for more information.
Got it