engine.materials Functions

Interface for managing loaded materials via the code. All materials existing in the project are loaded on its start-up and saved on world's saving or on calling the materials_save console command.

Materials Class

Members

---

int engine.materials.isMaterial(string name)

Checks if there is a material with a given name.

Arguments

• string name - Material name.

Return value

1 if the material exists; otherwise, 0.

int engine.materials.isMaterial(UGUID guid)

Checks if there is a material with a given GUID.

Arguments

• UGUID guid - A material GUID.

Return value

1 if the material exists; otherwise, 0.

Material engine.materials.findMaterial(string name)

Searches for a material with a given name.

Arguments

• string name - Material name.

Return value

Material, if found; otherwise, 0.

void engine.materials.reloadMaterials()

Reloads all loaded materials.

void engine.materials.destroyTextures()

Deletes all textures used by the loaded materials.

int engine.materials.replaceMaterial(Material material, Material new_material)

Replaces the material with the given one.

Arguments

• Material material - A material to be replaced.
• Material new_material - A replacing material.

Return value

1 if the material is replaced successfully; otherwise, 0.

Material engine.materials.findManualMaterial(string name)

Searches for a manual material by the given name.

Arguments

• string name - A manual material name.

Return value

A manual material.

Material engine.materials.findBaseMaterial(string name)

Searches for a base material by the given name.

Arguments

• string name - A base material name.

Return value

A base material.

void engine.materials.createShaders()

Creates all shaders for the loaded materials.

int engine.materials.saveMaterials()

Saves changes made for all loaded materials.

Return value

1 if materials are saved successfully; otherwise, 0.

Material engine.materials.getMaterial(int num)

Returns the material by its number.

Arguments

• int num - Material number.

Return value

A material.

Material engine.materials.findMaterialByPath(string path)

Searches for a material stored by the specified path.

Arguments

• string path - A loading path of the material (including a material's name).

Return value

A material.

Material engine.materials.loadMaterial(string path)

Loads a material stored by the given path. The function can be used to load materials created during application execution or stored outside the data directory.

Arguments

• string path - A path to the material (including its name).

Return value

A loaded material.

void engine.materials.reloadShaders()

Reloads all shaders used by the loaded materials.

Material engine.materials.findMaterialByGUID(UGUID guid)

Searches for a material with the given GUID.

Arguments

• UGUID guid - A material GUID.

Return value

A material.

int engine.materials.isManualMaterial(string name)

Checks if the material with the given name is the manual one.

Arguments

• string name - A material name.

Return value

1 if the material is the manual one; otherwise, 0.

int engine.materials.isBaseMaterial(string name)

Checks if the material with the given name is the base one.

Arguments

• string name - A material name.

Return value

1 if the material is the base one; otherwise, 0.

void engine.materials.destroyShaders()

Deletes all shaders used for the loaded materials.

int engine.materials.getNumMaterials()

Returns the number of materials loaded for the current project.

Return value

The number of materials.

string engine.materials.getMaterialName(int num)

Returns a name of the material with the given number.

Arguments

• int num - A material number.

Return value

A material name.

int engine.materials.removeMaterial(UGUID guid, int remove_file = 0)

Deletes a material. If the remove_file flag is enabled, the material file will be deleted as well. If the flag is disabled, the deleted material will be loaded again on the next application start-up.

Arguments

• UGUID guid - A material GUID.
• int remove_file - A flag indicating if the material file will be deleted.

Return value

1 if the material has been deleted successfully; otherwise, 0.