Class MaterialManager<TEventMap>

constructor

• new MaterialManager<TEventMap extends object = object>(): MaterialManager<
      TEventMap,
  >

• Type Parameters

  • TEventMap extends object = object

  Returns MaterialManager<TEventMap>

Readonlytemplates

applyMaterial

• applyMaterial(
      material: IMaterial,
      nameRegexOrUuid: string,
      regex?: boolean,
  ): boolean

• Parameters

  • material: IMaterial
  • nameRegexOrUuid: string
  • regex: boolean = true

  Returns boolean

clearExtensions

• clearExtensions(): void

• Returns void

clearMaterials

• clearMaterials(): void

• Returns void

convertToIMaterial

• convertToIMaterial(
      material: Material & { assetType?: "material"; iMaterial?: IMaterial },
      __namedParameters?: {
          createFromTemplate?: boolean;
          materialTemplate?: string;
          useSourceMaterial?: boolean;
      },
  ): undefined
  | IMaterial

• Creates a new material if a compatible template is found or apply minimal upgrades and returns the original material. Also checks from the registered materials, if one with the same uuid is found, it is returned instead with the new parameters. Also caches the response. Returns the same material if its already upgraded.

  Parameters

  • material: Material & { assetType?: "material"; iMaterial?: IMaterial }

    the material to upgrade/check
  • __namedParameters: {
        createFromTemplate?: boolean;
        materialTemplate?: string;
        useSourceMaterial?: boolean;
    } = {}

  Returns undefined | IMaterial

copyMaterialProps

• copyMaterialProps(c: IMaterial, material: IMaterial): boolean

• copyProps from material to c

  Parameters

  • c: IMaterial
  • material: IMaterial

  Returns boolean

create

• create<TM extends IMaterial>(
      nameOrType: string,
      params?: IMaterialParameters,
      register?: boolean,
  ): undefined | TM

• Create a material from the template name or material type

  Type Parameters

  • TM extends IMaterial

  Parameters

  • nameOrType: string
  • params: IMaterialParameters = {}
  • register: boolean = true

  Returns undefined | TM

dispose

• dispose(disposeRuntimeMaterials?: boolean): void

• Parameters

  • disposeRuntimeMaterials: boolean = true

  Returns void

exportMaterial

• exportMaterial(
      material: IMaterial,
      filename?: string,
      minify?: boolean,
      download?: boolean,
  ): File

• Parameters

  • material: IMaterial
  • Optionalfilename: string
  • minify: boolean = true
  • download: boolean = false

  Returns File

findMaterial

• findMaterial(uuid: string): undefined | IMaterial

• Parameters

  • uuid: string

  Returns undefined | IMaterial

findMaterialsByName

• findMaterialsByName(name: string | RegExp, regex?: boolean): IMaterial[]

• Parameters

  • name: string | RegExp
  • regex: boolean = false

  Returns IMaterial[]

findOrCreate

• findOrCreate(
      info: string,
      params?: Material | IMaterialParameters,
  ): undefined | IMaterial

• Parameters

  • info: string
  • Optionalparams: Material | IMaterialParameters

  Returns undefined | IMaterial

findTemplate

• findTemplate(
      nameOrType: string,
      withGenerator?: boolean,
  ): undefined | IMaterialTemplate

• Parameters

  • nameOrType: string
  • withGenerator: boolean = false

  Returns undefined | IMaterialTemplate

getAllMaterials

• getAllMaterials(): IMaterial[]

• Returns IMaterial[]

getMaterialsOfType

• getMaterialsOfType<TM extends IMaterial = IMaterial>(
      typeSlug: undefined | string,
  ): TM[]

• Type Parameters

  • TM extends IMaterial = IMaterial

  Parameters

  • typeSlug: undefined | string

  Returns TM[]

registerMaterial

• registerMaterial(material: IMaterial): void

• Parameters

  • material: IMaterial

  Returns void

registerMaterialExtension

• registerMaterialExtension(extension: MaterialExtension): void

• Parameters

  • extension: MaterialExtension

  Returns void

registerMaterials

• registerMaterials(materials: IMaterial[]): void

• Parameters

  • materials: IMaterial[]

  Returns void

registerMaterialTemplate

• registerMaterialTemplate(template: IMaterialTemplate): void

• Parameters

  • template: IMaterialTemplate

  Returns void

unregisterMaterial

• unregisterMaterial(material: IMaterial): void

• This is done automatically on material dispose.

  Parameters

  • material: IMaterial

  Returns void

unregisterMaterialExtension

• unregisterMaterialExtension(extension: MaterialExtension): void

• Parameters

  • extension: MaterialExtension

  Returns void

unregisterMaterialTemplate

• unregisterMaterialTemplate(template: IMaterialTemplate): void

• Parameters

  • template: IMaterialTemplate

  Returns void