Roblox UtilitiesDevlHub Roblox Documentation

Class

MaterialService

NotCreatableService
Inherits
Instance › Object
Memory category
Instances

The game service responsible for managing materials.

MaterialService is the game service responsible for managing materials. It is the container for global MaterialVariant instances. MaterialVariant can be child or descendant of MaterialService. For each base Material type, MaterialService internally keeps a set of MaterialVariant references. MaterialVariant.Name is the key to access it. The MaterialVariant.Name and MaterialVariant.BaseMaterial are combined to work as an identifier. If more than one MaterialVariant object has the same name and BaseMaterial under MaterialService, only one of them can be used.

MaterialService has some (Material)Name properties. Assigning a MaterialVariant Name replaces the built-in material with the specified MaterialVariant. If the MaterialService can't find a matching MaterialVariant, it falls back to built-in material. Note BaseMaterial should also match, for example, a MaterialVariant with BaseMaterial Grass can only be assigned to MaterialService.GrassName, not AsphaltName or any other names. These properties are not scriptable but can read and write using MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() function.

MaterialService has a MaterialService.Use2022Materials property that switches between legacy materials and new materials introduced in year 2022. Because legacy and user-generated (new) terrain materials use different encoding, using legacy terrain materials and MaterialVariant at the same time has a performance penalty. If your game is using pre-2022 terrain materials, avoid overriding any built-in materials. Migrate to 2022 materials if possible.

Properties 41#

AsphaltNamestringSpecify MaterialVariant name to override built-in Asphalt.Read: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafeNotScriptable
BasaltNamestringSpecify MaterialVariant name to override built-in Basalt.Read: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafeNotScriptable
BrickNamestringSpecify MaterialVariant name to override built-in Brick.Read: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafeNotScriptable
CardboardNamestringSpecify MaterialVariant name to override built-in Cardboard.Read: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafeNotScriptable
CarpetNamestringSpecify MaterialVariant name to override built-in Carpet.Read: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafeNotScriptable
CeramicTilesNamestringSpecify MaterialVariant name to override built-in CeramicTiles.Read: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafeNotScriptable
ClayRoofTilesNamestringSpecify MaterialVariant name to override built-in ClayRoofTiles.Read: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafeNotScriptable
CobblestoneNamestringSpecify MaterialVariant name to override built-in Cobblestone.Read: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafeNotScriptable
ConcreteNamestringSpecify MaterialVariant name to override built-in Concrete.Read: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafeNotScriptable
CorrodedMetalNamestringSpecify MaterialVariant name to override built-in CorrodedMetal.Read: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafeNotScriptable
CrackedLavaNamestringSpecify MaterialVariant name to override built-in CrackedLava.Read: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafeNotScriptable
DiamondPlateNamestringSpecify MaterialVariant name to override built-in DiamondPlate.Read: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafeNotScriptable
FabricNamestringSpecify MaterialVariant name to override built-in Fabric.Read: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafeNotScriptable
FoilNamestringSpecify MaterialVariant name to override built-in Foil.Read: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafeNotScriptable
GlacierNamestringSpecify MaterialVariant name to override built-in Glacier.Read: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafeNotScriptable
GraniteNamestringSpecify MaterialVariant name to override built-in Granite.Read: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafeNotScriptable
GrassNamestringSpecify MaterialVariant name to override built-in Grass.Read: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafeNotScriptable
GroundNamestringSpecify MaterialVariant name to override built-in Ground.Read: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafeNotScriptable
IceNamestringSpecify MaterialVariant name to override built-in Ice.Read: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafeNotScriptable
LeafyGrassNamestringSpecify MaterialVariant name to override built-in LeafyGrass.Read: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafeNotScriptable
LeatherNamestringSpecify MaterialVariant name to override built-in Leather.Read: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafeNotScriptable
LimestoneNamestringSpecify MaterialVariant name to override built-in Limestone.Read: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafeNotScriptable
MarbleNamestringSpecify MaterialVariant name to override built-in Marble.Read: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafeNotScriptable
MetalNamestringSpecify MaterialVariant name to override built-in Metal.Read: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafeNotScriptable
MudNamestringSpecify MaterialVariant name to override built-in Mud.Read: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafeNotScriptable
PavementNamestringSpecify MaterialVariant name to override built-in Pavement.Read: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafeNotScriptable
PebbleNamestringSpecify MaterialVariant name to override built-in Pebble.Read: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafeNotScriptable
PlasterNamestringSpecify MaterialVariant name to override built-in Plaster.Read: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafeNotScriptable
PlasticNamestringSpecify MaterialVariant name to override built-in Plastic.Read: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafeNotScriptable
RockNamestringSpecify MaterialVariant name to override built-in Rock.Read: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafeNotScriptable
RoofShinglesNamestringSpecify MaterialVariant name to override built-in RoofShingles.Read: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafeNotScriptable
RubberNamestringSpecify MaterialVariant name to override built-in Rubber.Read: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafeNotScriptable
SaltNamestringSpecify MaterialVariant name to override built-in Salt.Read: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafeNotScriptable
SandNamestringSpecify MaterialVariant name to override built-in Sand.Read: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafeNotScriptable
SandstoneNamestringSpecify MaterialVariant name to override built-in Sandstone.Read: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafeNotScriptable
SlateNamestringSpecify MaterialVariant name to override built-in Slate.Read: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafeNotScriptable
SmoothPlasticNamestringSpecify MaterialVariant name to override built-in SmoothPlastic.Read: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafeNotScriptable
SnowNamestringSpecify MaterialVariant name to override built-in Snow.Read: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafeNotScriptable
Use2022MaterialsbooleanSwitch built-in material pack.Read: RobloxScriptSecurityWrite: RobloxScriptSecurityReadSafeNotReplicated
WoodNamestringSpecify MaterialVariant name to override built-in Wood.Read: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafeNotScriptable
WoodPlanksNamestringSpecify MaterialVariant name to override built-in WoodPlanks.Read: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafeNotScriptable

AsphaltName: string#

NotScriptableRead: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafe

Specify MaterialVariant name to override built-in Asphalt. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Asphalt. This property is not scriptable; use MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() to access it from scripts.

BasaltName: string#

NotScriptableRead: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafe

Specify MaterialVariant name to override built-in Basalt. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Basalt. This property is not scriptable; use MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() to access it from scripts.

BrickName: string#

NotScriptableRead: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafe

Specify MaterialVariant name to override built-in Brick. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Brick. This property is not scriptable; use MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() to access it from scripts.

CardboardName: string#

NotScriptableRead: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafe

Specify MaterialVariant name to override built-in Cardboard. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Cardboard. This property is not scriptable; use MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() to access it from scripts.

CarpetName: string#

NotScriptableRead: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafe

Specify MaterialVariant name to override built-in Carpet. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Carpet. This property is not scriptable; use MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() to access it from scripts.

CeramicTilesName: string#

NotScriptableRead: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafe

Specify MaterialVariant name to override built-in CeramicTiles. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to CeramicTiles. This property is not scriptable; use MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() to access it from scripts.

ClayRoofTilesName: string#

NotScriptableRead: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafe

Specify MaterialVariant name to override built-in ClayRoofTiles. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to ClayRoofTiles. This property is not scriptable; use MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() to access it from scripts.

CobblestoneName: string#

NotScriptableRead: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafe

Specify MaterialVariant name to override built-in Cobblestone. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Cobblestone. This property is not scriptable; use MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() to access it from scripts.

ConcreteName: string#

NotScriptableRead: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafe

Specify MaterialVariant name to override built-in Concrete. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Concrete. This property is not scriptable; use MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() to access it from scripts.

CorrodedMetalName: string#

NotScriptableRead: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafe

Specify MaterialVariant name to override built-in CorrodedMetal. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to CorrodedMetal. This property is not scriptable; use MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() to access it from scripts.

CrackedLavaName: string#

NotScriptableRead: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafe

Specify MaterialVariant name to override built-in CrackedLava. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to CrackedLava. This property is not scriptable; use MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() to access it from scripts.

DiamondPlateName: string#

NotScriptableRead: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafe

Specify MaterialVariant name to override built-in DiamondPlate. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to DiamondPlate. This property is not scriptable; use MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() to access it from scripts.

FabricName: string#

NotScriptableRead: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafe

Specify MaterialVariant name to override built-in Fabric. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Fabric. This property is not scriptable; use MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() to access it from scripts.

FoilName: string#

NotScriptableRead: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafe

Specify MaterialVariant name to override built-in Foil. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Foil. This property is not scriptable; use MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() to access it from scripts.

GlacierName: string#

NotScriptableRead: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafe

Specify MaterialVariant name to override built-in Glacier. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Glacier. This property is not scriptable; use MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() to access it from scripts.

GraniteName: string#

NotScriptableRead: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafe

Specify MaterialVariant name to override built-in Granite. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Granite. This property is not scriptable; use MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() to access it from scripts.

GrassName: string#

NotScriptableRead: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafe

Specify MaterialVariant name to override built-in Grass. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Grass. This property is not scriptable; use MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() to access it from scripts.

GroundName: string#

NotScriptableRead: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafe

Specify MaterialVariant name to override built-in Ground. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Ground. This property is not scriptable; use MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() to access it from scripts.

IceName: string#

NotScriptableRead: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafe

Specify MaterialVariant name to override built-in Ice. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Ice. This property is not scriptable; use MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() to access it from scripts.

LeafyGrassName: string#

NotScriptableRead: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafe

Specify MaterialVariant name to override built-in LeafyGrass. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to LeafyGrass. This property is not scriptable; use MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() to access it from scripts.

LeatherName: string#

NotScriptableRead: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafe

Specify MaterialVariant name to override built-in Leather. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Leather. This property is not scriptable; use MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() to access it from scripts.

LimestoneName: string#

NotScriptableRead: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafe

Specify MaterialVariant name to override built-in Limestone. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Limestone. This property is not scriptable; use MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() to access it from scripts.

MarbleName: string#

NotScriptableRead: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafe

Specify MaterialVariant name to override built-in Marble. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Marble. This property is not scriptable; use MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() to access it from scripts.

MetalName: string#

NotScriptableRead: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafe

Specify MaterialVariant name to override built-in Metal. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Metal. This property is not scriptable; use MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() to access it from scripts.

MudName: string#

NotScriptableRead: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafe

Specify MaterialVariant name to override built-in Mud. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Mud. This property is not scriptable; use MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() to access it from scripts.

PavementName: string#

NotScriptableRead: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafe

Specify MaterialVariant name to override built-in Pavement. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Pavement. This property is not scriptable; use MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() to access it from scripts.

PebbleName: string#

NotScriptableRead: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafe

Specify MaterialVariant name to override built-in Pebble. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Pebble. This property is not scriptable; use MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() to access it from scripts.

PlasterName: string#

NotScriptableRead: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafe

Specify MaterialVariant name to override built-in Plaster. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Plaster. This property is not scriptable; use MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() to access it from scripts.

PlasticName: string#

NotScriptableRead: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafe

Specify MaterialVariant name to override built-in Plastic. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Plastic. This property is not scriptable; use MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() to access it from scripts.

RockName: string#

NotScriptableRead: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafe

Specify MaterialVariant name to override built-in Rock. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Rock. This property is not scriptable; use MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() to access it from scripts.

RoofShinglesName: string#

NotScriptableRead: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafe

Specify MaterialVariant name to override built-in RoofShingles. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to RoofShingles. This property is not scriptable; use MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() to access it from scripts.

RubberName: string#

NotScriptableRead: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafe

Specify MaterialVariant name to override built-in Rubber. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Rubber. This property is not scriptable; use MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() to access it from scripts.

SaltName: string#

NotScriptableRead: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafe

Specify MaterialVariant name to override built-in Salt. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Salt. This property is not scriptable; use MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() to access it from scripts.

SandName: string#

NotScriptableRead: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafe

Specify MaterialVariant name to override built-in Sand. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Sand. This property is not scriptable; use MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() to access it from scripts.

SandstoneName: string#

NotScriptableRead: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafe

Specify MaterialVariant name to override built-in Sandstone. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Sandstone. This property is not scriptable; use MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() to access it from scripts.

SlateName: string#

NotScriptableRead: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafe

Specify MaterialVariant name to override built-in Slate. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Slate. This property is not scriptable; use MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() to access it from scripts.

SmoothPlasticName: string#

NotScriptableRead: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafe

Specify MaterialVariant name to override built-in SmoothPlastic. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to SmoothPlastic. This property is not scriptable; use MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() to access it from scripts.

SnowName: string#

NotScriptableRead: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafe

Specify MaterialVariant name to override built-in Snow. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Snow. This property is not scriptable; use MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() to access it from scripts.

Use2022Materials: boolean#

NotReplicatedRead: RobloxScriptSecurityWrite: RobloxScriptSecurityReadSafe

When it's false, built-in materials use the material pack before 2022. When it's true, built-in materials use the material pack released in 2022.

WoodName: string#

NotScriptableRead: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafe

Specify MaterialVariant name to override built-in Wood. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Wood. This property is not scriptable; use MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() to access it from scripts.

WoodPlanksName: string#

NotScriptableRead: RobloxEngineSecurityWrite: RobloxEngineSecurityReadSafe

Specify MaterialVariant name to override built-in WoodPlanks. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to WoodPlanks. This property is not scriptable; use MaterialService:GetBaseMaterialOverride() and MaterialService:SetBaseMaterialOverride() to access it from scripts.

Methods 3#

GetBaseMaterialOverrideGet the override MaterialVariant name of specified Material type.
GetMaterialVariantGet the effective MaterialVariant reference given a name and Material.
SetBaseMaterialOverrideSet a MaterialVariant name that overrides a built-in material.

GetBaseMaterialOverride(material: Material): string#

Get the override MaterialVariant name of specified Material type.

NameTypeDefaultDescription
materialMaterialMaterial type to be fetched.
Returns
  • string — MaterialVariant name currently set as override.

GetMaterialVariant(material: Material, name: string): MaterialVariant#

Get the effective MaterialVariant reference given a MaterialVariant name and BaseMaterial. This MaterialVariant must be a descendant of MaterialService. Returns nil if no matching instance exists.

NameTypeDefaultDescription
materialMaterialBaseMaterial of MaterialVariant.
namestringName of MaterialVariant.
Returns

SetBaseMaterialOverride(material: Material, name: string): ()#

Set a MaterialVariant name that overrides a built-in material.

NameTypeDefaultDescription
materialMaterialThe Material type to be changed.
namestringName of the MaterialVariant object.
Returns
  • ()

Inherited members#

Inherited from Instance 58
Properties (10)

Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId

Methods (39)

AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild

Events (9)

AncestryChanged, AttributeChanged, ChildAdded, childAdded, ChildRemoved, DescendantAdded, DescendantRemoving, Destroying, StyledPropertiesChanged

Inherited from Object 6
Properties (2)

ClassName, className

Methods (3)

GetPropertyChangedSignal, IsA, isA

Events (1)

Changed