Class CustomMaterialLibrary

Custom material library.

Remarks

Contains custom materials created through the editor, through scripting or by importing.

Hierarchy (View Summary)

MaterialLibrary
- CustomMaterialLibrary

Index

Properties

Accessors

Methods

add find remove

Properties

`Readonly`materials

materials: CustomMaterial[]

The materials defined in the library.

Accessors

name

get name(): string
The library name.

Returns string
Inherited from MaterialLibrary.name

path

get path(): string
The unique library path.

Returns string
Overrides MaterialLibrary.path

Methods

add

add(name: string): null | CustomMaterial
Creates a custom material and adds it to the library.
Parameters
- name: string
  The unique name for the custom material.
Returns null | CustomMaterial
The created custom material, or null if the material name was not unique.

find

find(name: string): null | CustomMaterial
Finds a custom material with the specified name.
Parameters
- name: string
  The material name.
Returns null | CustomMaterial
The material, or null if not found.

Overrides MaterialLibrary.find

remove

remove(name: string): boolean
Removes the custom material with the specified name.
Parameters
- name: string
  The custom material name.
Returns boolean
True if the custom material was removed, false otherwise.