Reference API Roblox

Engine API

Website

Related

Reference API Roblox

MaterialService

This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
Tags: [NotCreatable, Service]

Member index 52

HistoryMember
553AsphaltName: string
553BasaltName: string
553BrickName: string
588CardboardName: string
588CarpetName: string
588CeramicTilesName: string
588ClayRoofTilesName: string
553CobblestoneName: string
553ConcreteName: string
553CorrodedMetalName: string
553CrackedLavaName: string
553DiamondPlateName: string
553FabricName: string
553FoilName: string
553GlacierName: string
553GraniteName: string
553GrassName: string
553GroundName: string
553IceName: string
553LeafyGrassName: string
588LeatherName: string
553LimestoneName: string
553MarbleName: string
553MetalName: string
553MudName: string
553PavementName: string
553PebbleName: string
588PlasterName: string
553PlasticName: string
553RockName: string
588RoofShinglesName: string
588RubberName: string
553SaltName: string
553SandName: string
553SandstoneName: string
553SlateName: string
553SmoothPlasticName: string
553SnowName: string
553Use2022Materials: bool
553WoodName: string
553WoodPlanksName: string
519GetBaseMaterialOverride(material: Material): string
630GetIsMaterialActionAsToolEnabled(): bool
523GetMaterialOverrideChanged(material: Material): RBXScriptSignal
521GetMaterialVariant(material: Material, name: string): MaterialVariant
524GetOverrideStatus(material: Material): PropertyStatus
573SetBaseMaterialOverride(material: Material, name: string): null
620SetCurrentMaterial(baseMaterial: Material, materialVariant: string): null
630ToggleMaterialFillToolEnabled(): null
630MaterialFillToolEnabledChanged(shouldEnable: bool)
524OverrideStatusChanged(material: Material)
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553ClassName: string
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
553className: string
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
462GetPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsA(className: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
462isA(className: string): bool
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462Changed(property: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)

Removed member index 49

HistoryMember
529Brick: MaterialVariant
529Cobblestone: MaterialVariant
529Concrete: MaterialVariant
529CorrodedMetal: MaterialVariant
529DiamondPlate: MaterialVariant
529Fabric: MaterialVariant
529Foil: MaterialVariant
529Granite: MaterialVariant
529Grass: MaterialVariant
529Ice: MaterialVariant
529Marble: MaterialVariant
529Metal: MaterialVariant
529Pebble: MaterialVariant
529Plastic: MaterialVariant
529Sand: MaterialVariant
529Slate: MaterialVariant
529SmoothPlastic: MaterialVariant
529TerrainAsphalt: MaterialVariant
529TerrainBasalt: MaterialVariant
529TerrainBrick: MaterialVariant
529TerrainCobblestone: MaterialVariant
529TerrainConcrete: MaterialVariant
529TerrainCrackedLava: MaterialVariant
529TerrainGlacier: MaterialVariant
529TerrainGrass: MaterialVariant
529TerrainGround: MaterialVariant
529TerrainIce: MaterialVariant
529TerrainLeafyGrass: MaterialVariant
529TerrainLimestone: MaterialVariant
529TerrainMud: MaterialVariant
529TerrainPavement: MaterialVariant
529TerrainRock: MaterialVariant
529TerrainSalt: MaterialVariant
529TerrainSand: MaterialVariant
529TerrainSandstone: MaterialVariant
529TerrainSlate: MaterialVariant
529TerrainSnow: MaterialVariant
529TerrainWoodPlanks: MaterialVariant
529Wood: MaterialVariant
529WoodPlanks: MaterialVariant
529ClearOverridePartMaterial(material: Material): void
529ClearOverrideTerrainMaterial(material: Material): void
519GetMaterialOverride(material: Material): string
529GetOverridePartMaterial(material: Material): MaterialVariant
529GetOverrideTerrainMaterial(material: Material): MaterialVariant
519SetMaterialOverride(material: Material, name: string): void
529SetOverridePartMaterial(materialVariant: MaterialVariant): void
529SetOverrideTerrainMaterial(materialVariant: MaterialVariant): void

History 246

Members 52

AsphaltName

TypeDefault
stringAsphalt
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

BasaltName

TypeDefault
stringBasalt
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

BrickName

TypeDefault
stringBrick
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

CardboardName

TypeDefault
stringCardboard
This property is not scriptable. It cannot be accessed by script code.

History 1

Tags: [NotScriptable]

CarpetName

TypeDefault
stringCarpet
This property is not scriptable. It cannot be accessed by script code.

History 1

Tags: [NotScriptable]

CeramicTilesName

TypeDefault
stringCeramicTiles
This property is not scriptable. It cannot be accessed by script code.

History 1

Tags: [NotScriptable]

ClayRoofTilesName

TypeDefault
stringClayRoofTiles
This property is not scriptable. It cannot be accessed by script code.

History 1

Tags: [NotScriptable]

CobblestoneName

TypeDefault
stringCobblestone
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

ConcreteName

TypeDefault
stringConcrete
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

CorrodedMetalName

TypeDefault
stringCorrodedMetal
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

CrackedLavaName

TypeDefault
stringCrackedLava
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

DiamondPlateName

TypeDefault
stringDiamondPlate
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

FabricName

TypeDefault
stringFabric
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

FoilName

TypeDefault
stringFoil
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

GetBaseMaterialOverride

Parameters (1)
materialMaterial
Returns (1)
string

History 1

GetIsMaterialActionAsToolEnabled

Parameters (0)
No parameters.
Returns (1)
bool

History 1

GetMaterialOverrideChanged

Parameters (1)
materialMaterial
Returns (1)
RBXScriptSignal

History 1

GetMaterialVariant

Parameters (2)
materialMaterial
namestring
Returns (1)
MaterialVariant

History 1

GetOverrideStatus

Parameters (1)
materialMaterial
Returns (1)
PropertyStatus

History 1

GlacierName

TypeDefault
stringGlacier
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

GraniteName

TypeDefault
stringGranite
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

GrassName

TypeDefault
stringGrass
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

GroundName

TypeDefault
stringGround
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

IceName

TypeDefault
stringIce
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

LeafyGrassName

TypeDefault
stringLeafyGrass
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

LeatherName

TypeDefault
stringLeather
This property is not scriptable. It cannot be accessed by script code.

History 1

Tags: [NotScriptable]

LimestoneName

TypeDefault
stringLimestone
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

MarbleName

TypeDefault
stringMarble
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

MaterialFillToolEnabledChanged

Parameters (1)
shouldEnablebool

History 1

MetalName

TypeDefault
stringMetal
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

MudName

TypeDefault
stringMud
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

OverrideStatusChanged

Parameters (1)
materialMaterial

History 1

PavementName

TypeDefault
stringPavement
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

PebbleName

TypeDefault
stringPebble
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

PlasterName

TypeDefault
stringPlaster
This property is not scriptable. It cannot be accessed by script code.

History 1

Tags: [NotScriptable]

PlasticName

TypeDefault
stringPlastic
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

RockName

TypeDefault
stringRock
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

RoofShinglesName

TypeDefault
stringRoofShingles
This property is not scriptable. It cannot be accessed by script code.

History 1

Tags: [NotScriptable]

RubberName

TypeDefault
stringRubber
This property is not scriptable. It cannot be accessed by script code.

History 1

Tags: [NotScriptable]

SaltName

TypeDefault
stringSalt
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

SandName

TypeDefault
stringSand
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

SandstoneName

TypeDefault
stringSandstone
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

SetBaseMaterialOverride

Parameters (2)
materialMaterial
namestring
Returns (1)
null

History 2

SetCurrentMaterial

Parameters (2)
baseMaterialMaterial
materialVariantstring
Returns (1)
null

History 1

SlateName

TypeDefault
stringSlate
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

SmoothPlasticName

TypeDefault
stringSmoothPlastic
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

SnowName

TypeDefault
stringSnow
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

ToggleMaterialFillToolEnabled

Parameters (0)
No parameters.
Returns (1)
null

History 1

Use2022Materials

TypeDefault
boolfalse
This property is not replicated. Its interface does not cross the network boundary.

History 5

Tags: [NotReplicated]

WoodName

TypeDefault
stringWood
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

WoodPlanksName

TypeDefault
stringWoodPlanks
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

Removed members 49

Brick

TypeDefault
MaterialVariant
This property is not scriptable. It cannot be accessed by script code.

History 5

  • 529 Remove Brick
  • 504 Change Tags of Brick from [] to [NotScriptable]
  • 504 Change WriteSecurity of Brick from None to RobloxSecurity
  • 504 Change ReadSecurity of Brick from None to RobloxSecurity
  • 494 Add Brick
Tags: [NotScriptable]

ClearOverridePartMaterial

Parameters (1)
materialMaterial
Returns (1)
void

History 2

ClearOverrideTerrainMaterial

Parameters (1)
materialMaterial
Returns (1)
void

History 2

Cobblestone

TypeDefault
MaterialVariant
This property is not scriptable. It cannot be accessed by script code.

History 5

Tags: [NotScriptable]

Concrete

TypeDefault
MaterialVariant
This property is not scriptable. It cannot be accessed by script code.

History 5

Tags: [NotScriptable]

CorrodedMetal

TypeDefault
MaterialVariant
This property is not scriptable. It cannot be accessed by script code.

History 5

Tags: [NotScriptable]

DiamondPlate

TypeDefault
MaterialVariant
This property is not scriptable. It cannot be accessed by script code.

History 5

Tags: [NotScriptable]

Fabric

TypeDefault
MaterialVariant
This property is not scriptable. It cannot be accessed by script code.

History 5

Tags: [NotScriptable]

Foil

TypeDefault
MaterialVariant
This property is not scriptable. It cannot be accessed by script code.

History 5

  • 529 Remove Foil
  • 504 Change WriteSecurity of Foil from None to RobloxSecurity
  • 504 Change Tags of Foil from [] to [NotScriptable]
  • 504 Change ReadSecurity of Foil from None to RobloxSecurity
  • 494 Add Foil
Tags: [NotScriptable]

GetMaterialOverride

Parameters (1)
materialMaterial
Returns (1)
string

History 2

GetOverridePartMaterial

Parameters (1)
materialMaterial
Returns (1)
MaterialVariant

History 2

GetOverrideTerrainMaterial

Parameters (1)
materialMaterial
Returns (1)
MaterialVariant

History 2

Granite

TypeDefault
MaterialVariant
This property is not scriptable. It cannot be accessed by script code.

History 5

Tags: [NotScriptable]

Grass

TypeDefault
MaterialVariant
This property is not scriptable. It cannot be accessed by script code.

History 5

  • 529 Remove Grass
  • 504 Change WriteSecurity of Grass from None to RobloxSecurity
  • 504 Change ReadSecurity of Grass from None to RobloxSecurity
  • 504 Change Tags of Grass from [] to [NotScriptable]
  • 494 Add Grass
Tags: [NotScriptable]

Ice

TypeDefault
MaterialVariant
This property is not scriptable. It cannot be accessed by script code.

History 5

  • 529 Remove Ice
  • 504 Change Tags of Ice from [] to [NotScriptable]
  • 504 Change ReadSecurity of Ice from None to RobloxSecurity
  • 504 Change WriteSecurity of Ice from None to RobloxSecurity
  • 494 Add Ice
Tags: [NotScriptable]

Marble

TypeDefault
MaterialVariant
This property is not scriptable. It cannot be accessed by script code.

History 5

Tags: [NotScriptable]

Metal

TypeDefault
MaterialVariant
This property is not scriptable. It cannot be accessed by script code.

History 5

  • 529 Remove Metal
  • 504 Change ReadSecurity of Metal from None to RobloxSecurity
  • 504 Change Tags of Metal from [] to [NotScriptable]
  • 504 Change WriteSecurity of Metal from None to RobloxSecurity
  • 494 Add Metal
Tags: [NotScriptable]

Pebble

TypeDefault
MaterialVariant
This property is not scriptable. It cannot be accessed by script code.

History 5

Tags: [NotScriptable]

Plastic

TypeDefault
MaterialVariant
This property is not scriptable. It cannot be accessed by script code.

History 5

Tags: [NotScriptable]

Sand

TypeDefault
MaterialVariant
This property is not scriptable. It cannot be accessed by script code.

History 5

  • 529 Remove Sand
  • 504 Change ReadSecurity of Sand from None to RobloxSecurity
  • 504 Change Tags of Sand from [] to [NotScriptable]
  • 504 Change WriteSecurity of Sand from None to RobloxSecurity
  • 494 Add Sand
Tags: [NotScriptable]

SetMaterialOverride

Parameters (2)
materialMaterial
namestring
Returns (1)
void

History 2

SetOverridePartMaterial

Parameters (1)
materialVariantMaterialVariant
Returns (1)
void

History 2

SetOverrideTerrainMaterial

Parameters (1)
materialVariantMaterialVariant
Returns (1)
void

History 2

Slate

TypeDefault
MaterialVariant
This property is not scriptable. It cannot be accessed by script code.

History 5

  • 529 Remove Slate
  • 504 Change ReadSecurity of Slate from None to RobloxSecurity
  • 504 Change WriteSecurity of Slate from None to RobloxSecurity
  • 504 Change Tags of Slate from [] to [NotScriptable]
  • 494 Add Slate
Tags: [NotScriptable]

SmoothPlastic

TypeDefault
MaterialVariant
This property is not scriptable. It cannot be accessed by script code.

History 5

Tags: [NotScriptable]

TerrainAsphalt

TypeDefault
MaterialVariant
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

TerrainBasalt

TypeDefault
MaterialVariant
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

TerrainBrick

TypeDefault
MaterialVariant
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

TerrainCobblestone

TypeDefault
MaterialVariant
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

TerrainConcrete

TypeDefault
MaterialVariant
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

TerrainCrackedLava

TypeDefault
MaterialVariant
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

TerrainGlacier

TypeDefault
MaterialVariant
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

TerrainGrass

TypeDefault
MaterialVariant
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

TerrainGround

TypeDefault
MaterialVariant
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

TerrainIce

TypeDefault
MaterialVariant
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

TerrainLeafyGrass

TypeDefault
MaterialVariant
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

TerrainLimestone

TypeDefault
MaterialVariant
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

TerrainMud

TypeDefault
MaterialVariant
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

TerrainPavement

TypeDefault
MaterialVariant
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

TerrainRock

TypeDefault
MaterialVariant
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

TerrainSalt

TypeDefault
MaterialVariant
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

TerrainSand

TypeDefault
MaterialVariant
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

TerrainSandstone

TypeDefault
MaterialVariant
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

TerrainSlate

TypeDefault
MaterialVariant
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

TerrainSnow

TypeDefault
MaterialVariant
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

TerrainWoodPlanks

TypeDefault
MaterialVariant
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

Wood

TypeDefault
MaterialVariant
This property is not scriptable. It cannot be accessed by script code.

History 5

  • 529 Remove Wood
  • 504 Change ReadSecurity of Wood from None to RobloxSecurity
  • 504 Change Tags of Wood from [] to [NotScriptable]
  • 504 Change WriteSecurity of Wood from None to RobloxSecurity
  • 494 Add Wood
Tags: [NotScriptable]

WoodPlanks

TypeDefault
MaterialVariant
This property is not scriptable. It cannot be accessed by script code.

History 5

Tags: [NotScriptable]

Settings