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

Aspalt

string

Specifies MaterialVariant to replace the material.

Code Samples

Bark

string

Specifies MaterialVariant to replace the material.

Code Samples

Basic

string

Specifies MaterialVariant to replace the material.

Code Samples

BeigeTerrazzoFloor

string

Specifies MaterialVariant to replace the material.

Code Samples

Brick

string

Specifies MaterialVariant to replace the material.

Code Samples

BrickCeramicTile

string

Specifies MaterialVariant to replace the material.

Code Samples

BrokenConcrete

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

CementWall

string

Specifies MaterialVariant to replace the material.

Code Samples

Chainmail

string

Specifies MaterialVariant to replace the material.

Code Samples

CheckerTileFloor

string

Specifies MaterialVariant to replace the material.

Code Samples

Concrete

string

Specifies MaterialVariant to replace the material.

Code Samples

ConcretePlate

string

Specifies MaterialVariant to replace the material.

Code Samples

Copper

string

Specifies MaterialVariant to replace the material.

Code Samples

CorrugatedSteel

string

Specifies MaterialVariant to replace the material.

Code Samples

CrackedMiddleCeramicTile

string

Specifies MaterialVariant to replace the material.

Code Samples

CrackedSmallCeramicTile

string

Specifies MaterialVariant to replace the material.

Code Samples

CrocEmbossedLeather

string

Specifies MaterialVariant to replace the material.

Code Samples

DamagedRoof

string

Specifies MaterialVariant to replace the material.

Code Samples

DistroyedBronze

string

Specifies MaterialVariant to replace the material.

Code Samples

EmeraldGridTile

string

Specifies MaterialVariant to replace the material.

Code Samples

FabricDenim

string

Specifies MaterialVariant to replace the material.

Code Samples

FabricWeave

string

Specifies MaterialVariant to replace the material.

Code Samples

Foil

string

Specifies MaterialVariant to replace the material.

Code Samples

GalvanizedMetal

string

Specifies MaterialVariant to replace the material.

Code Samples

Glass

string

Specifies MaterialVariant to replace the material.

Code Samples

GrainLeather

string

Specifies MaterialVariant to replace the material.

Code Samples

Grass

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

GridBox

string

Specifies MaterialVariant to replace the material.

Code Samples

GridMarble

string

Specifies MaterialVariant to replace the material.

Code Samples

GridPentagon

string

Specifies MaterialVariant to replace the material.

Code Samples

GridQuad

string

Specifies MaterialVariant to replace the material.

Code Samples

GridTile

string

Specifies MaterialVariant to replace the material.

Code Samples

Ground

string

Specifies MaterialVariant to replace the material.

Code Samples

HalfLeafyGround

string

Specifies MaterialVariant to replace the material.

Code Samples

HouseBricks

string

Specifies MaterialVariant to replace the material.

Code Samples

IndustrialRibbedSteel

string

Specifies MaterialVariant to replace the material.

Code Samples

LeafyGround

string

Specifies MaterialVariant to replace the material.

Code Samples

Marble

string

Specifies MaterialVariant to replace the material.

Code Samples

MatteRubber

string

Specifies MaterialVariant to replace the material.

Code Samples

Metal

string

Specifies MaterialVariant to replace the material.

Code Samples

MetalPlate

string

Specifies MaterialVariant to replace the material.

Code Samples

MixRoad

string

Specifies MaterialVariant to replace the material.

Code Samples

MosaicCarpet

string

Specifies MaterialVariant to replace the material.

Code Samples

MossyGround

string

Specifies MaterialVariant to replace the material.

Code Samples

MossyRock

string

Specifies MaterialVariant to replace the material.

Code Samples

OceanPanelTile

string

Specifies MaterialVariant to replace the material.

Code Samples

OfficeCeilingLight

string

Specifies MaterialVariant to replace the material.

Code Samples

OfficeCeilingWhite

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

PaintedWornWood

string

Specifies MaterialVariant to replace the material.

Code Samples

Paving

string

Specifies MaterialVariant to replace the material.

Code Samples

PavingBlock

string

Specifies MaterialVariant to replace the material.

Code Samples

PavingBrick

string

Specifies MaterialVariant to replace the material.

Code Samples

PavingFloor

string

Specifies MaterialVariant to replace the material.

Code Samples

PavingStones

string

Specifies MaterialVariant to replace the material.

Code Samples

PavingWall

string

Specifies MaterialVariant to replace the material.

Code Samples

PeelingPaintSteel

string

Specifies MaterialVariant to replace the material.

Code Samples

Plank

string

Specifies MaterialVariant to replace the material.

Code Samples

Plastic

string

Specifies MaterialVariant to replace the material.

Code Samples

Road

string

Specifies MaterialVariant to replace the material.

Code Samples

Rock

string

Specifies MaterialVariant to replace the material.

Code Samples

Roof

string

Specifies MaterialVariant to replace the material.

Code Samples

Rust

string

Specifies MaterialVariant to replace the material.

Code Samples

RustBrass

string

Specifies MaterialVariant to replace the material.

Code Samples

RustMetal

string

Specifies MaterialVariant to replace the material.

Code Samples

RustySteel

string

Specifies MaterialVariant to replace the material.

Code Samples

Sand

string

Specifies MaterialVariant to replace the material.

Code Samples

SandstoneBrick

string

Specifies MaterialVariant to replace the material.

Code Samples

SilverMetal

string

Specifies MaterialVariant to replace the material.

Code Samples

SmallBrick

string

Specifies MaterialVariant to replace the material.

Code Samples

Snow

string

Specifies MaterialVariant to replace the material.

Code Samples

SoilRockGround

string

Specifies MaterialVariant to replace the material.

Code Samples

SquareCeramicTile

string

Specifies MaterialVariant to replace the material.

Code Samples

StoneBrick

string

Specifies MaterialVariant to replace the material.

Code Samples

StoneFloor

string

Specifies MaterialVariant to replace the material.

Code Samples

TakenOffCeramicTile

string

Specifies MaterialVariant to replace the material.

Code Samples

Tatami

string

Specifies MaterialVariant to replace the material.

Code Samples

TerrazzoFloor

string

Specifies MaterialVariant to replace the material.

Code Samples

ThickCarpet

string

Specifies MaterialVariant to replace the material.

Code Samples

Unlit

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

WhiteGrayBrick

string

Specifies MaterialVariant to replace the material.

Code Samples

Wood

string

Specifies MaterialVariant to replace the material.

Code Samples

WoodLogSidingWall

string

Specifies MaterialVariant to replace the material.

Code Samples

WoodSidingWall

string

Specifies MaterialVariant to replace the material.

Code Samples

WoodTileFloor

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

SetBaseMaterialOverride

Currently not supported.

Parameters

Enum.Material InMaterial

string InName

Return

void

Code Samples

Events

See also

Last updated