> For the complete documentation index, see [llms.txt](https://sparkar-community.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://sparkar-community.gitbook.io/docs/materialsmodule.md).
# MaterialsModule
The `Materials` module provides access to the materials in an effect.
## Example
```
//==============================================================================
// The following example demonstrates how to access a material in the Assets,
// assign it to an object, and change it's opacity.
//
// Project setup:
// - Insert a plane
// - Create a material
//==============================================================================
// Load in the required modules
const Materials = require('Materials');
const Scene = require('Scene');
// Locate the plane in the Scene
const plane = Scene.root.find('plane0');
// Locate the plane in the Scene
const material = Materials.get('defaultMaterial0');
// Assign the material to the plane
plane.material = material;
// Set the opacity of the material to 50%
material.opacity = 0.5;
```
## Properties
This module exposes no properties.
## Methods
| Method | Description |
| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `findFirst` | findFirst(name: string): Promise\
Returns a promise that is resolved with the material of a requested name or null if none was found.
See Also: Materials.findUsingPattern, Materials.getAll.
|
| `findUsingPattern` | findUsingPattern(namePattern: string): Promise\> findUsingPattern(namePattern: string, config: {limit: number}): Promise\>
Returns a promise that is resolved with the all of the materials matching the name pattern or empty array if none was found.
Pattern format: * matches any characters sequence. \ can be used to include in pattern any of the control characters (including '' itself)
Examples: findUsingPattern("*") will retrive all of the materials. findUsingPattern("*A") will retrieve all of the materials suffixed with 'A'. findUsingPattern("A*") will retrieve all of the materials prefixed with 'A'. findUsingPattern("*A*", {limit: 10}) will retrieve at most 10 of the materials containing 'A',
limit parameter describes if findUsingPattern should finish the search if it finds specified number of results (default is no limit). Non-positive values for limit are treated as unlimited.
See Also: Materials.getAll, Materials.findFirst.
|
| `get` | get(materialName: string): MaterialBase
Returns a MaterialBase class that represents the material specified by the materialName parameter. The materials are defined in the AR Studio project.
An exception is thrown when the identifier isn't found in the project.
See Also: MaterialBase.name.
|
| `getAll` | getAll(): Promise\>
Returns a promise that is resolved with all of the materials.
See Also: Materials.findUsingPattern, Materials.findFirst.
|
## Classes
| Class | Description |
| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| [`BlendedMaterial`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/materialsmodule.blendedmaterial) | The `BlendedMaterial` class encapsulates materials blended from multiple textures. |
| [`BlendShapeToWarpMapMaterial`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/materialsmodule.blendshapetowarpmapmaterial) | The `BlendShapeToWarpMapMaterial` class. |
| [`ColorPaintMaterial`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/materialsmodule.colorpaintmaterial) | The `ColorPaintMaterial` class encapsulates a face-paint material. |
| [`ComposedMaterial`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/materialsmodule.composedmaterial) | The `ComposedMaterial` class encapsulates patch asset materials. |
| [`DefaultMaterial`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/materialsmodule.defaultmaterial) | The `DefaultMaterial` class encapsulates an image-based material. |
| [`MaterialBase`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/materialsmodule.materialbase) | The `MaterialBase` class exposes properties common to all material types. |
| [`MetallicRoughnessPbrMaterial`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/materialsmodule.metallicroughnesspbrmaterial) | The `MetallicRoughnessPbrMaterial` class encapsulates physically based materials. |
| [`RetouchingMaterial`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/materialsmodule.retouchingmaterial) | The `RetouchingMaterial` class encapsulates parameters which define the extend of certain beautification techniques. |
| [`TextureTransform`](https://sparkar.facebook.com/docs/ar-studio/reference/classes/materialsmodule.texturetransform) | The `TextureTransform` class encapsulates scaling and translation transforms about a textures UV axis. |
## Enums
| Enum | Description |
| ---------------------------------------------------------------------------------------------------- | ------------------------------------------------------- |
| [`BlendMode`](https://sparkar.facebook.com/docs/ar-studio/reference/enums/materialsmodule.blendmode) | The `BlendMode` enum describes how material is blended. |
| [`CullMode`](https://sparkar.facebook.com/docs/ar-studio/reference/enums/materialsmodule.cullmode) | The `CullMode` enum describes how material is culled. |
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://sparkar-community.gitbook.io/docs/materialsmodule.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.