This page has been translated automatically.
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Setting Up Development Environment
Usage Examples
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine Tools
Double Precision Coordinates
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
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.

OS Functions

The scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScipt (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.

float clock ( ) #

Returns time in seconds (with microsecond precision) passed from the engine start-up. This function returns the time with the highest precision as possible from the operating system.

Return value

Time from the application start-up.

StringStack<> date ( string format ) #

Returns a current date in the given format.


  • string format - Date format. The following placeholders can be used to show a date:
    • a: abbreviated weekday name (e.g., Sun)
    • b: abbreviated month name (e.g., Jan)
    • d: date and time (e.g., Thu Feb 8, 00:51)
    • s: second (00..60)
    • m: minute (00..59)
    • h: hour (0..23)
    • D: day of month (e.g, 1)
    • M: month (1..12)
    • Y: year
    • W: day of week (0..6); 0 is Sunday
    • %: a literal percent character

Return value

Current date in the given format.

string date ( string format, long time ) #

Returns a current date and time in the given format. This function can receive a second argument with an Unix timestamp to be converted into a readable format.


  • string format - Date format.
  • long time - Unix time stamp to be converted. This is an optional argument.

Return value

Current date and time in the given format.


Source code (UnigineScript)
log.message("%s\n",date("%d\nMonth is %M\nYear is %Y\nDay is %D %b, %a\n"));
log.message("%s\n",date("%2h:%02m:%02s %04Y",));
Wed Mar 20, 16:11
Month is 3
Year is 2013
Day is 20 Mar, Wed

16:11:14 2013

string getenv ( string name ) #

Gets a value of an environment variable.


  • string name - Variable name.

Return value

Variable value.

Variable system ( string command, int wait = 1 ) #

Executes a shell command or commands.
On Windows, this function returns 0 if the wait argument is 0.


  • string command - Command or commands to execute.
  • int wait - Value indicating if the program should wait for completion of command execution:
    • 1 to wait for completion. This value is used by default.
    • 0 not to wait.
    The value is required only on Windows.

Return value

Exit code of the last executed command if it was executed successfully; otherwise, -1.


Source code (UnigineScript)
// the following instruction will open a command prompt on Windows

int time ( ) #

Returns the time since the Epoch (00:00:00 UTC, January 1, 1970), measured in seconds.

Return value

Number of seconds since 00:00:00, January 1, 1970.
Last update: 2020-07-31
Build: ()