LandscapeMapFileSettings 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 UnigineScipt (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.
This class is used to load, modify, and apply landscape map settings stored in a .lmap file.
LandscapeMapFileSettings Class
Members
LandscapeMapFileSettings ( ) #
The LandscapeMapFileSettings constructor.void setHeightBlending ( int blending ) #
Sets a new blending mode to be used for heights data of the landscape map.Arguments
- int blending - Blending mode to be used for heights data. One of the following values:
- 0 - Alpha Blend
- 1 - Additive
int getHeightBlending ( ) #
Returns the current blending mode used for heights data of the landscape map.Return value
Blending mode used for heights data. One of the following values:- 0 - Alpha Blend
- 1 - Additive
void setAlbedoBlending ( int blending ) #
Sets a new blending mode to be used for albedo data of the landscape map.Arguments
- int blending - Blending mode to be used for albedo data. One of the following values:
- 0 - Alpha Blend
- 1 - Additive
- 2 - Overlay
- 3 - Multiplicative
int getAlbedoBlending ( ) #
Returns the current blending mode used for albedo data of the landscape map.Return value
Blending mode used for albedo data. One of the following values:- 0 - Alpha Blend
- 1 - Additive
- 2 - Overlay
- 3 - Multiplicative
void setMaskBlending ( int mask, int blend ) #
Sets a new blending mode to be used for the data of the specified detail mask.Arguments
- int mask - Detail mask number in the [0; 19] range.
- int blend - Blending mode used for the data of the specified detail mask. One of the following values:
- 0 - Alpha Blend
- 1 - Additive
- 2 - Overlay
- 3 - Multiplicative
int getMaskBlending ( int mask ) #
Returns the current blending mode used for the data of the specified detail mask.Arguments
- int mask - Detail mask number in the [0; 19] range.
Return value
Blending mode used for the data of the specified detail mask. One of the following values:- 0 - Alpha Blend
- 1 - Additive
- 2 - Overlay
- 3 - Multiplicative
void setEnabledHeight ( int height ) #
Sets a value indicating if heights data of the landscape layer map is to be used.Arguments
- int height - 1 to enable using heights data of the landscape layer map, 0 - to disable it.
int isEnabledHeight ( ) #
Returns a value indicating if heights data of the landscape layer map is to be used.Return value
1 if heights data of the landscape layer map is to be used; otherwise, 0.void setEnabledAlbedo ( int albedo ) #
Sets a value indicating if albedo data of the landscape layer map is to be used.Arguments
- int albedo - 1 to enable using albedo data of the landscape layer map, 0 - to disable it.
int isEnabledAlbedo ( ) #
Returns a value indicating if albedo data of the landscape layer map is to be used.Return value
1 if albedo data of the landscape layer map is to be used; otherwise, 0.void setEnabledMask ( int mask, int enabled ) #
Sets a value indicating if the data of the detail mask with the specified number is to be used.Arguments
- int mask - Detail mask number in the [0; 19] range.
- int enabled - 1 to enable using the data of the specified detail mask, 0 - to disable it.
int isEnabledMask ( int mask ) #
Returns a value indicating if the data of the detail mask with the specified number is to be used.Arguments
- int mask - Detail mask number in the [0; 19] range.
Return value
1 if the data of the detail mask with the specified number is to be used; otherwise, 0.void setEnabledOpacityHeight ( int height ) #
Sets a value indicating if opacity information for heights data of the landscape layer map is to be used. Opacity information is required to blend data of several landscape layer maps.Arguments
- int height - 1 to enable using opacity information for heights data of the landscape layer map, 0 - to disable it.
int isEnabledOpacityHeight ( ) #
Returns a value indicating if opacity information for heights data of the landscape layer map is to be used. Opacity information is required to blend data of several landscape layer maps.Return value
1 if opacity information for heights data of the landscape layer map is to be used; otherwise, 0.void setEnabledOpacityAlbedo ( int albedo ) #
Sets a value indicating if opacity information for albedo data of the landscape layer map is to be used. Opacity information is required to blend data of several landscape layer maps.Arguments
- int albedo - 1 to enable using opacity information for albedo data of the landscape layer map, 0 - to disable it.
int isEnabledOpacityAlbedo ( ) #
Returns a value indicating if opacity information for the albedo data of the landscape layer map is to be used. Opacity information is required to blend data of several landscape layer maps.Return value
1 if opacity information for the albedo data of the landscape layer map is to be used; otherwise, 0.void setEnabledOpacityMask ( int mask, int enabled ) #
Sets a value indicating if opacity information for the heights data of the detail mask with the specified number is to be used. Opacity information is required to blend data of several landscape layer maps.Arguments
- int mask - Detail mask number in the [0; 19] range.
- int enabled - 1 to enable using opacity information for the data of the specified detail mask, 0 - to disable it.
int isEnabledOpacityMask ( int mask ) #
Returns a value indicating if opacity information for the data of the detail mask with the specified number is to be used. Opacity information is required to blend data of several landscape layer maps.Arguments
- int mask - Detail mask number in the [0; 19] range.
Return value
1 if opacity information for the data of the detail mask with the specified number is to be used; otherwise, 0.ivec2 getTilesSize ( ) #
Returns the size of the landscape map tiles.Return value
Two-component vector (X, Y) representing the number of tiles in the landscape layer map along X and Y axes.ivec2 getResolution ( ) #
Returns the landscape layer map resolution.Return value
Two-component vector (X, Y) representing landscape layer map resolution along X and Y axes.UGUID getGUID ( ) #
Returns a GUID of the .lmap file containing landscape map data.Return value
GUID of the .lmap file.int isLoaded ( ) #
Returns a value indicating if the landscape map file (.lmap) is loaded.Return value
1 if opacity information for the data of the detail mask with the specified number is to be used; otherwise, 0.int load ( UGUID guid ) #
Loads landscape map settings from a file with the specified GUID.Arguments
- UGUID guid - GUID of the .lmap file containing landscape map data.
Return value
1 if opacity information for the data of the detail mask with the specified number is to be used; otherwise, 0.int apply ( ) #
Applies all settings stored in the landscape map file (.lmap).Return value
1 if landscape map file settings were successfully applied; otherwise, 0.Last update:
2020-07-31
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)