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.
Warning
The functionality described in this article is not available in the Community SDK edition.
You should upgrade to- Sim
SDK edition to use it.
You should upgrade to
This class is used to manage the IG configuration via API.
Notice
IG plugin must be loaded.
The CloudTypeDef structure represents the cloud type definitions. It is declared as follows:
Source code (C++)
struct CloudTypeDef
{
int type = 0;
Unigine::String name;
Unigine::String material;
};
The PrecipitationTypeDef structure represents the precipitation type definitions. It is declared as follows:
Source code (C++)
struct PrecipitationTypeDef
{
int type = 0;
Unigine::String name;
Unigine::String far_node_path;
Unigine::String near_node_path;
};
The SynckerChannelDef structure represents the Syncker channel definitions. It is declared as follows:
Source code (C++)
struct SynckerChannelDef
{
Unigine::String slave_name;
int view_id = 0;
bool use_projection = false;
};
The DatabaseDef structure represents the database definitions. It is declared as follows:
Source code (C++)
struct DatabaseDef
{
int database_id = 0;
Unigine::String world_name;
Unigine::Math::Vec3 geodetic_origin;
};
The ViewTypeDef structure represents the view type definitions. It is declared as follows:
Source code (C++)
struct ViewTypeDef
{
int view_type_id = 0;
Unigine::String post_material;
};
The EntityTypeDef structure represents the entity type definitions with the components, articulated parts, and volumes. It is declared as follows:
Source code (C++)
struct EntityTypeDef
{
int64_t id = 0;
Unigine::String name;
Unigine::String path;
int64_t inherit_id = 0;
struct ComponentDef
{
struct ComponentParameterDef
{
ITEM_TYPE type = ITEM_TYPE::UNKNOWN;
Unigine::String name;
Unigine::String parameter_name;
};
bool inherited = false;
int id = 0;
Unigine::String name;
Unigine::String node_path;
Unigine::String property_name;
Unigine::Vector<ComponentParameterDef> parameters;
};
Unigine::Map<int, ComponentDef> components;
struct ArticulatedPartDef
{
bool inherited = false;
int id = 0;
Unigine::String name;
Unigine::Vector<Unigine::String> node_path;
Unigine::Vector<Unigine::Math::ivec3> is_inverted;
};
Unigine::Map<int, ArticulatedPartDef> articulated_parts;
struct VolumeDef
{
bool inherited = false;
int id = 0;
int shape_id = 0;
Unigine::String node_path;
Unigine::String name;
};
Unigine::Map<int, VolumeDef> volume_definitions;
};
Last update:
2021-12-13
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)