MaterialService

MaterialService : Instance

Overview

MaterialService is a global service that manages the various material representation methods used in the game.

If you specify the name of a MaterialVariant to apply for each material, when selecting that material in a BasePart, the connected MaterialVariant is automatically used instead of the default material. Also, the MaterialVariant must have a BaseMaterial value that matches the target material it is intended to replace for it to apply correctly.

Properties

AsphaltName

string

Specifies MaterialVariant to replace the material.

Code Samples

BarkName

string

Specifies MaterialVariant to replace the material.

Code Samples

BasicName

string

Specifies MaterialVariant to replace the material.

Code Samples

BeigeTerrazzoFloor

string

Specifies MaterialVariant to replace the material.

Code Samples

BrickCeramicTile

string

Specifies MaterialVariant to replace the material.

Code Samples

BrickName

string

Specifies MaterialVariant to replace the material.

Code Samples

BrokenConcreteName

string

Specifies MaterialVariant to replace the material.

Code Samples

BrokenRoof

string

Specifies MaterialVariant to replace the material.

Code Samples

BrushMetal

string

Specifies MaterialVariant to replace the material.

Code Samples

CementWallName

string

Specifies MaterialVariant to replace the material.

Code Samples

CheckerTileFloorName

string

Specifies MaterialVariant to replace the material.

Code Samples

ConcreteName

string

Specifies MaterialVariant to replace the material.

Code Samples

ConcretePlateName

string

Specifies MaterialVariant to replace the material.

Code Samples

CopperName

string

Specifies MaterialVariant to replace the material.

Code Samples

CorrugatedSteelName

string

Specifies MaterialVariant to replace the material.

Code Samples

CrackedMiddleCeramicTileName

string

Specifies MaterialVariant to replace the material.

Code Samples

CrackedSmallCeramicTileName

string

Specifies MaterialVariant to replace the material.

Code Samples

DamagedRoofName

string

Specifies MaterialVariant to replace the material.

Code Samples

DistroyedBronzeName

string

Specifies MaterialVariant to replace the material.

Code Samples

EmeraldGridTile

string

Specifies MaterialVariant to replace the material.

Code Samples

GalvanizedMetal

string

Specifies MaterialVariant to replace the material.

Code Samples

GlassName

string

Specifies MaterialVariant to replace the material.

Code Samples

GrassName

string

Specifies MaterialVariant to replace the material.

Code Samples

GreyWovenFabric

string

Specifies MaterialVariant to replace the material.

Code Samples

GridBorder

string

Specifies MaterialVariant to replace the material.

Code Samples

GridBoxName

string

Specifies MaterialVariant to replace the material.

Code Samples

GridMarbleName

string

Specifies MaterialVariant to replace the material.

Code Samples

GridPentagonName

string

Specifies MaterialVariant to replace the material.

Code Samples

GridQuadName

string

Specifies MaterialVariant to replace the material.

Code Samples

GridTileName

string

Specifies MaterialVariant to replace the material.

Code Samples

GroundName

string

Specifies MaterialVariant to replace the material.

Code Samples

HalfLeafyGroundName

string

Specifies MaterialVariant to replace the material.

Code Samples

HouseBricksName

string

Specifies MaterialVariant to replace the material.

Code Samples

IndustrialRibbedSteel

string

Specifies MaterialVariant to replace the material.

Code Samples

LeafyGroundName

string

Specifies MaterialVariant to replace the material.

Code Samples

MarbleName

string

Specifies MaterialVariant to replace the material.

Code Samples

MetalName

string

Specifies MaterialVariant to replace the material.

Code Samples

MetalPlateName

string

Specifies MaterialVariant to replace the material.

Code Samples

MixRoadName

string

Specifies MaterialVariant to replace the material.

Code Samples

MosaicCarpetName

string

Specifies MaterialVariant to replace the material.

Code Samples

MossyGroundName

string

Specifies MaterialVariant to replace the material.

Code Samples

MossyRockName

string

Specifies MaterialVariant to replace the material.

Code Samples

OceanPanelTile

string

Specifies MaterialVariant to replace the material.

Code Samples

OfficeCeilingWhiteName

string

Specifies MaterialVariant to replace the material.

Code Samples

PaintedMetal

string

Specifies MaterialVariant to replace the material.

Code Samples

PaintedWood

string

Specifies MaterialVariant to replace the material.

Code Samples

PavingBlockName

string

Specifies MaterialVariant to replace the material.

Code Samples

PavingBrickName

string

Specifies MaterialVariant to replace the material.

Code Samples

PavingFloorName

string

Specifies MaterialVariant to replace the material.

Code Samples

PavingName

string

Specifies MaterialVariant to replace the material.

Code Samples

PavingStonesName

string

Specifies MaterialVariant to replace the material.

Code Samples

PavingWallName

string

Specifies MaterialVariant to replace the material.

Code Samples

PeelingPaintSteel

string

Specifies MaterialVariant to replace the material.

Code Samples

PlankName

string

Specifies MaterialVariant to replace the material.

Code Samples

PlasticName

string

Specifies MaterialVariant to replace the material.

Code Samples

RoadName

string

Specifies MaterialVariant to replace the material.

Code Samples

RockName

string

Specifies MaterialVariant to replace the material.

Code Samples

RoofName

string

Specifies MaterialVariant to replace the material.

Code Samples

RustBrassName

string

Specifies MaterialVariant to replace the material.

Code Samples

RustName

string

Specifies MaterialVariant to replace the material.

Code Samples

RustySteel

string

Specifies MaterialVariant to replace the material.

Code Samples

SandName

string

Specifies MaterialVariant to replace the material.

Code Samples

SandstoneBrick

string

Specifies MaterialVariant to replace the material.

Code Samples

SilverMetalName

string

Specifies MaterialVariant to replace the material.

Code Samples

SmallBrickName

string

Specifies MaterialVariant to replace the material.

Code Samples

SnowName

string

Specifies MaterialVariant to replace the material.

Code Samples

SoilRockGroundName

string

Specifies MaterialVariant to replace the material.

Code Samples

SquareCeramicTile

string

Specifies MaterialVariant to replace the material.

Code Samples

StoneBrickName

string

Specifies MaterialVariant to replace the material.

Code Samples

StoneFloorName

string

Specifies MaterialVariant to replace the material.

Code Samples

TakenOffCeramicTileName

string

Specifies MaterialVariant to replace the material.

Code Samples

TerrazzoFloorName

string

Specifies MaterialVariant to replace the material.

Code Samples

ThickCarpet

string

Specifies MaterialVariant to replace the material.

Code Samples

UnlitName

string

Name of the MaterialVariant to replace the built-in Unli material

Code Samples

UrbanSlateFloor

string

Specifies MaterialVariant to replace the material.

Code Samples

WeatheredPlasterBrick

string

Specifies MaterialVariant to replace the material.

Code Samples

WhiteCementBrick

string

Specifies MaterialVariant to replace the material.

Code Samples

WhiteGrayBrickName

string

Specifies MaterialVariant to replace the material.

Code Samples

WoodName

string

Specifies MaterialVariant to replace the material.

Code Samples

Methods

GetBaseMaterialOverride

Finds and returns the MaterialVariant with the matching name from the specified material.

Parameters

Enum.Material InMaterial

The material to search.

Return

string

The MaterialVariant name to be searched within the material.

Code Samples

GetMaterialVariant

Retrieves the MaterialVariant associated with the given material and name.

Parameters

Enum.Material InMaterial

The material to associate the variant with.

string InName

The name of the MaterialVariant to retrieve.

Return

MaterialVariant

The returned MaterialVariant.

Code Samples

local MaterialService = game:GetService("MaterialService")

local Variant = MaterialService:GetMaterialVariant(Enum.Material.Basic, "MaterialVariant1")
print(Variant)

SetBaseMaterialOverride

Currently not supported.

Parameters

Enum.Material InMaterial

string InName

Return

void