Class Materials

Readonlycustom

libraries

• get libraries(): readonly MaterialLibrary[]

  The complete list of material libraries stored in the database.

  Returns readonly MaterialLibrary[]

add

• add(name: string): null | CustomMaterial

  Creates a custom material and adds it to the custom material 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.

addLibrary

• addLibrary(path: string): null | RemoteMaterialLibrary

  Adds a remote material library to the database.

  Parameters

  • path: string

    The path to the remote material library definition file.

  Returns null | RemoteMaterialLibrary

  The remote material library that was added, or null if the operation failed.

  Remarks

  This function will return null if the library has already been added or if the remote library could not be loaded from the specified path. The path specifies the location of a JSON file which contains the material definitions. See the standard library https://play.prototwin.com/assets/materials/library.json for an example library definition file.

find

• find(name: string): null | Material

  Finds a material with the specified name.

  Parameters

  • name: string

    The material name.

  Returns null | Material

  The material, or null if not found.

  Remarks

  This function will first check the custom material library for a custom material with the specified name. If no custom material was found then it checks each remote library in the order in which the remote libraries were added.

getLibrary

• getLibrary(path: string): null | MaterialLibrary

  Retrieves the remote material library with the specified path.

  Parameters

  • path: string

    The path to the remote material library definition file.

  Returns null | MaterialLibrary

  The corresponding remote material library, or null if not previously added.

getOrAddLibrary

• getOrAddLibrary(path: string): null | MaterialLibrary

  Retrieves the remote material library with the specified path and adds it to the database if it hasn't already been added.

  Parameters

  • path: string

    The path to the remote material library definition file.

  Returns null | MaterialLibrary

  The corresponding remote material library, or null if the operation failed.

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.

removeLibrary

• removeLibrary(path: string): boolean

  Removes the remote material library with the specified path from the database.

  Parameters

  • path: string

    The path to the remote material library definition file.

  Returns boolean

  True if the remote material library was removed, false otherwise.