This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Landscape Tool
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Containers
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
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials
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.

UlonValue Class

Warning
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 UnigineScript (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.

This class is used to represent a value of a ULON node.

UlonValue Class

Members


static UlonValue ( ) #

Constructor. Creates a ULON node value.

static UlonValue ( string arg1 ) #

Constructor. Creates a ULON node value from the specified source buffer.

Arguments

  • string arg1 - ULON node value source buffer.

int isArray ( ) #

Returns a value indicating if the ULON node value is of an array type.

Return value

1 if the ULON node value is of an array type; otherwise, 0.

string getStr ( ) #

Returns the ULON node value as a non-formatted string.

Return value

ULON node value as a non-formatted string.

double getDouble ( ) #

Returns the ULON node value as a double.

Return value

Double ULON node value.

float getFloat ( ) #

Returns the ULON node value as a float.

Return value

Float ULON node value.

int getInt ( ) #

Returns the ULON node value as an integer.

Return value

Integer ULON node value.

long getLong ( ) #

Returns the ULON node value as a 64-bit long.

Return value

64-bit long ULON node value.

char getChar ( ) #

Returns the ULON node value as a char.

Return value

Char ULON node value.

bool getBool ( ) #

Returns the ULON node value as a boolean.

Return value

Boolean ULON node value.

Vector<String> getArray ( ) #

Returns the ULON node value as an array of strings.

Return value

Array of strings representing elements of the array.

dvec4 getDVec4 ( ) #

Returns the ULON node value as a dvec4 vector.

Return value

ULON node value as a dvec4 vector.

vec4 getVec4 ( ) #

Returns the ULON node value as a vec4 vector.

Return value

ULON node value as a vec4 vector.

ivec4 getIVec4 ( ) #

Returns the ULON node value as an ivec4 vector.

Return value

ULON node value as an ivec4 vector.

void setUsage ( int usage ) #

Sets a value indicating if the ULON node value is used (obtained via one of the get*() methods).

Arguments

  • int usage - 1 to mark the ULON node value as used; otherwise, 0.

int isUsage ( ) #

Returns a value indicating if the ULON node value is used (obtained via one of the get*() methods).

Return value

1 if the ULON node value is used; otherwise, 0.

int read ( string src ) #

Reads the ULON node value from the specified source buffer.

Arguments

  • string src - ULON node value source buffer.
Last update: 2021-12-13
Build: ()