MaterialService
The game service responsible for managing materials.
| Memory category | Instances |
|---|
Member index 52
Removed member index 49
Description
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.
History 246
- 630 Add MaterialFillToolEnabledChanged
- 630 Add ToggleMaterialFillToolEnabled
- 630 Add GetIsMaterialActionAsToolEnabled
- 620 Add SetCurrentMaterial
- 588 Add RubberName
- 588 Add RoofShinglesName
- 588 Add PlasterName
- 588 Add LeatherName
- 588 Add ClayRoofTilesName
- 588 Add CeramicTilesName
- 588 Add CarpetName
- 588 Add CardboardName
- 573 Change ReturnType of SetBaseMaterialOverride from void to null
- 553 Change Default of WoodPlanksName from to WoodPlanks
- 553 Change Default of WoodName from to Wood
- 553 Add
- 553 Change Default of Use2022Materials from to false
- 553 Change Default of SnowName from to Snow
- 553 Change Default of SmoothPlasticName from to SmoothPlastic
- 553 Change Default of SlateName from to Slate
- 553 Change Default of SandstoneName from to Sandstone
- 553 Change Default of SandName from to Sand
- 553 Change Default of SaltName from to Salt
- 553 Change Default of RockName from to Rock
- 553 Change Default of PlasticName from to Plastic
- 553 Change Default of PebbleName from to Pebble
- 553 Change Default of PavementName from to Pavement
- 553 Change Default of MudName from to Mud
- 553 Change Default of MetalName from to Metal
- 553 Change Default of MarbleName from to Marble
- 553 Change Default of LimestoneName from to Limestone
- 553 Change Default of LeafyGrassName from to LeafyGrass
- 553 Change Default of IceName from to Ice
- 553 Change Default of GroundName from to Ground
- 553 Change Default of GrassName from to Grass
- 553 Change Default of GraniteName from to Granite
- 553 Change Default of GlacierName from to Glacier
- 553 Change Default of FoilName from to Foil
- 553 Change Default of FabricName from to Fabric
- 553 Change Default of DiamondPlateName from to DiamondPlate
- 553 Change Default of CrackedLavaName from to CrackedLava
- 553 Change Default of CorrodedMetalName from to CorrodedMetal
- 553 Change Default of ConcreteName from to Concrete
- 553 Change Default of CobblestoneName from to Cobblestone
- 553 Change Default of BrickName from to Brick
- 553 Change Default of BasaltName from to Basalt
- 553 Change Default of AsphaltName from to Asphalt
- 541 Remove
- 534 Change Tags of MaterialService from [NotCreatable, Service, NotBrowsable] to [NotCreatable, Service]
- 529 Remove SetOverrideTerrainMaterial
- 529 Remove SetOverridePartMaterial
- 529 Remove GetOverrideTerrainMaterial
- 529 Remove GetOverridePartMaterial
- 529 Remove ClearOverrideTerrainMaterial
- 529 Remove ClearOverridePartMaterial
- 529 Remove WoodPlanks
- 529 Remove Wood
- 529 Remove TerrainWoodPlanks
- 529 Remove TerrainSnow
- 529 Remove TerrainSlate
- 529 Remove TerrainSandstone
- 529 Remove TerrainSand
- 529 Remove TerrainSalt
- 529 Remove TerrainRock
- 529 Remove TerrainPavement
- 529 Remove TerrainMud
- 529 Remove TerrainLimestone
- 529 Remove TerrainLeafyGrass
- 529 Remove TerrainIce
- 529 Remove TerrainGround
- 529 Remove TerrainGrass
- 529 Remove TerrainGlacier
- 529 Remove TerrainCrackedLava
- 529 Remove TerrainConcrete
- 529 Remove TerrainCobblestone
- 529 Remove TerrainBrick
- 529 Remove TerrainBasalt
- 529 Remove TerrainAsphalt
- 529 Remove SmoothPlastic
- 529 Remove Slate
- 529 Remove Sand
- 529 Remove Plastic
- 529 Remove Pebble
- 529 Remove Metal
- 529 Remove Marble
- 529 Remove Ice
- 529 Remove Grass
- 529 Remove Granite
- 529 Remove Foil
- 529 Remove Fabric
- 529 Remove DiamondPlate
- 529 Remove CorrodedMetal
- 529 Remove Concrete
- 529 Remove Cobblestone
- 529 Remove Brick
- 525 Change CanLoad of Use2022Materials from true to false
- 524 Add OverrideStatusChanged
- 524 Add GetOverrideStatus
- 524 Change Tags of Use2022Materials from [] to [NotReplicated]
- 524 Change CanSave of Use2022Materials from true to false
- 523 Add GetMaterialOverrideChanged
- 521 Add GetMaterialVariant
- 519 Remove SetMaterialOverride
- 519 Add SetBaseMaterialOverride
- 519 Remove GetMaterialOverride
- 519 Add GetBaseMaterialOverride
- 518 Add SetMaterialOverride
- 518 Add GetMaterialOverride
- 518 Add WoodPlanksName
- 518 Add WoodName
- 518 Add SnowName
- 518 Add SmoothPlasticName
- 518 Add SlateName
- 518 Add SandstoneName
- 518 Add SandName
- 518 Add SaltName
- 518 Add RockName
- 518 Add PlasticName
- 518 Add PebbleName
- 518 Add PavementName
- 518 Add MudName
- 518 Add MetalName
- 518 Add MarbleName
- 518 Add LimestoneName
- 518 Add LeafyGrassName
- 518 Add IceName
- 518 Add GroundName
- 518 Add GrassName
- 518 Add GraniteName
- 518 Add GlacierName
- 518 Add FoilName
- 518 Add FabricName
- 518 Add DiamondPlateName
- 518 Add CrackedLavaName
- 518 Add CorrodedMetalName
- 518 Add ConcreteName
- 518 Add CobblestoneName
- 518 Add BrickName
- 518 Add BasaltName
- 518 Add AsphaltName
- 513 Add Use2022Materials
- 512 Add TerrainWoodPlanks
- 512 Add TerrainSlate
- 505 Add SetOverrideTerrainMaterial
- 505 Add GetOverrideTerrainMaterial
- 505 Add ClearOverrideTerrainMaterial
- 505 Add
- 505 Add TerrainSnow
- 505 Add TerrainSandstone
- 505 Add TerrainSand
- 505 Add TerrainSalt
- 505 Add TerrainRock
- 505 Add TerrainPavement
- 505 Add TerrainMud
- 505 Add TerrainLimestone
- 505 Add TerrainLeafyGrass
- 505 Add TerrainIce
- 505 Add TerrainGround
- 505 Add TerrainGrass
- 505 Add TerrainGlacier
- 505 Add TerrainCrackedLava
- 505 Add TerrainConcrete
- 505 Add TerrainCobblestone
- 505 Add TerrainBrick
- 505 Add TerrainBasalt
- 505 Add TerrainAsphalt
- 504 Add SetOverridePartMaterial
- 504 Add GetOverridePartMaterial
- 504 Add ClearOverridePartMaterial
- 504 Change ReadSecurity of WoodPlanks from None to RobloxSecurity
- 504 Change Tags of WoodPlanks from [] to [NotScriptable]
- 504 Change WriteSecurity of WoodPlanks from None to RobloxSecurity
- 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
- 504 Change ReadSecurity of SmoothPlastic from None to RobloxSecurity
- 504 Change Tags of SmoothPlastic from [] to [NotScriptable]
- 504 Change WriteSecurity of SmoothPlastic from None to RobloxSecurity
- 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]
- 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
- 504 Change ReadSecurity of Plastic from None to RobloxSecurity
- 504 Change WriteSecurity of Plastic from None to RobloxSecurity
- 504 Change Tags of Plastic from [] to [NotScriptable]
- 504 Change ReadSecurity of Pebble from None to RobloxSecurity
- 504 Change WriteSecurity of Pebble from None to RobloxSecurity
- 504 Change Tags of Pebble from [] to [NotScriptable]
- 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
- 504 Change ReadSecurity of Marble from None to RobloxSecurity
- 504 Change Tags of Marble from [] to [NotScriptable]
- 504 Change WriteSecurity of Marble from None to RobloxSecurity
- 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
- 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]
- 504 Change WriteSecurity of Granite from None to RobloxSecurity
- 504 Change Tags of Granite from [] to [NotScriptable]
- 504 Change ReadSecurity of Granite from None to RobloxSecurity
- 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
- 504 Change ReadSecurity of Fabric from None to RobloxSecurity
- 504 Change WriteSecurity of Fabric from None to RobloxSecurity
- 504 Change Tags of Fabric from [] to [NotScriptable]
- 504 Change ReadSecurity of DiamondPlate from None to RobloxSecurity
- 504 Change Tags of DiamondPlate from [] to [NotScriptable]
- 504 Change WriteSecurity of DiamondPlate from None to RobloxSecurity
- 504 Change ReadSecurity of CorrodedMetal from None to RobloxSecurity
- 504 Change Tags of CorrodedMetal from [] to [NotScriptable]
- 504 Change WriteSecurity of CorrodedMetal from None to RobloxSecurity
- 504 Change ReadSecurity of Concrete from None to RobloxSecurity
- 504 Change WriteSecurity of Concrete from None to RobloxSecurity
- 504 Change Tags of Concrete from [] to [NotScriptable]
- 504 Change ReadSecurity of Cobblestone from None to RobloxSecurity
- 504 Change Tags of Cobblestone from [] to [NotScriptable]
- 504 Change WriteSecurity of Cobblestone from None to RobloxSecurity
- 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 WoodPlanks
- 494 Add Wood
- 494 Add SmoothPlastic
- 494 Add Slate
- 494 Add Sand
- 494 Add Plastic
- 494 Add Pebble
- 494 Add Metal
- 494 Add Marble
- 494 Add Ice
- 494 Add Grass
- 494 Add Granite
- 494 Add Foil
- 494 Add Fabric
- 494 Add DiamondPlate
- 494 Add CorrodedMetal
- 494 Add Concrete
- 494 Add Cobblestone
- 494 Add Brick
- 494 Add MaterialService
Members 52
AsphaltName
| Type | Default | |
|---|---|---|
| string | Asphalt | |
Specify MaterialVariant name to override built-in Asphalt. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Asphalt.
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
History 2
- 553 Change Default of AsphaltName from to Asphalt
- 518 Add AsphaltName
BasaltName
| Type | Default | |
|---|---|---|
| string | Basalt | |
Specify MaterialVariant name to override built-in Basalt. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Basalt.
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
History 2
- 553 Change Default of BasaltName from to Basalt
- 518 Add BasaltName
BrickName
| Type | Default | |
|---|---|---|
| string | Brick | |
Specify MaterialVariant name to override built-in Brick. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Brick.
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
CardboardName
| Type | Default | |
|---|---|---|
| string | Cardboard | |
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
History 1
- 588 Add CardboardName
CarpetName
| Type | Default | |
|---|---|---|
| string | Carpet | |
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
History 1
- 588 Add CarpetName
CeramicTilesName
| Type | Default | |
|---|---|---|
| string | CeramicTiles | |
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
History 1
- 588 Add CeramicTilesName
ClayRoofTilesName
| Type | Default | |
|---|---|---|
| string | ClayRoofTiles | |
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
History 1
- 588 Add ClayRoofTilesName
CobblestoneName
| Type | Default | |
|---|---|---|
| string | Cobblestone | |
Specify MaterialVariant name to override built-in Cobblestone. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Cobblestone.
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
History 2
- 553 Change Default of CobblestoneName from to Cobblestone
- 518 Add CobblestoneName
ConcreteName
| Type | Default | |
|---|---|---|
| string | Concrete | |
Specify MaterialVariant name to override built-in Concrete. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Concrete.
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
History 2
- 553 Change Default of ConcreteName from to Concrete
- 518 Add ConcreteName
CorrodedMetalName
| Type | Default | |
|---|---|---|
| string | CorrodedMetal | |
Specify MaterialVariant name to override built-in CorrodedMetal. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to CorrodedMetal.
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
History 2
- 553 Change Default of CorrodedMetalName from to CorrodedMetal
- 518 Add CorrodedMetalName
CrackedLavaName
| Type | Default | |
|---|---|---|
| string | CrackedLava | |
Specify MaterialVariant name to override built-in CrackedLava. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to CrackedLava.
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
History 2
- 553 Change Default of CrackedLavaName from to CrackedLava
- 518 Add CrackedLavaName
DiamondPlateName
| Type | Default | |
|---|---|---|
| string | DiamondPlate | |
Specify MaterialVariant name to override built-in DiamondPlate. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to DiamondPlate.
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
History 2
- 553 Change Default of DiamondPlateName from to DiamondPlate
- 518 Add DiamondPlateName
FabricName
| Type | Default | |
|---|---|---|
| string | Fabric | |
Specify MaterialVariant name to override built-in Fabric. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Fabric.
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
History 2
- 553 Change Default of FabricName from to Fabric
- 518 Add FabricName
FoilName
| Type | Default | |
|---|---|---|
| string | Foil | |
Specify MaterialVariant name to override built-in Foil. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Foil.
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
GetBaseMaterialOverride
| Parameters (1) | ||
|---|---|---|
| material | Material | |
| Returns (1) | ||
| string | ||
Get the override MaterialVariant name of specified Material type.
| Thread safety | Unsafe |
|---|
History 1
GetIsMaterialActionAsToolEnabled
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| bool | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
GetMaterialOverrideChanged
| Parameters (1) | ||
|---|---|---|
| material | Material | |
| Returns (1) | ||
| RBXScriptSignal | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
GetMaterialVariant
| Parameters (2) | ||
|---|---|---|
| material | Material | |
| name | string | |
| Returns (1) | ||
| 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.
| Thread safety | Unsafe |
|---|
History 1
GetOverrideStatus
| Parameters (1) | ||
|---|---|---|
| material | Material | |
| Returns (1) | ||
| PropertyStatus | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
- 524 Add GetOverrideStatus
GlacierName
| Type | Default | |
|---|---|---|
| string | Glacier | |
Specify MaterialVariant name to override built-in Glacier. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Glacier.
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
History 2
- 553 Change Default of GlacierName from to Glacier
- 518 Add GlacierName
GraniteName
| Type | Default | |
|---|---|---|
| string | Granite | |
Specify MaterialVariant name to override built-in Granite. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Granite.
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
History 2
- 553 Change Default of GraniteName from to Granite
- 518 Add GraniteName
GrassName
| Type | Default | |
|---|---|---|
| string | Grass | |
Specify MaterialVariant name to override built-in Grass. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Grass.
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
GroundName
| Type | Default | |
|---|---|---|
| string | Ground | |
Specify MaterialVariant name to override built-in Ground. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Ground.
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
History 2
- 553 Change Default of GroundName from to Ground
- 518 Add GroundName
IceName
| Type | Default | |
|---|---|---|
| string | Ice | |
Specify MaterialVariant name to override built-in Ice. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Ice.
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
LeafyGrassName
| Type | Default | |
|---|---|---|
| string | LeafyGrass | |
Specify MaterialVariant name to override built-in LeafyGrass. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to LeafyGrass.
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
History 2
- 553 Change Default of LeafyGrassName from to LeafyGrass
- 518 Add LeafyGrassName
LeatherName
| Type | Default | |
|---|---|---|
| string | Leather | |
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
History 1
- 588 Add LeatherName
LimestoneName
| Type | Default | |
|---|---|---|
| string | Limestone | |
Specify MaterialVariant name to override built-in Limestone. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Limestone.
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
History 2
- 553 Change Default of LimestoneName from to Limestone
- 518 Add LimestoneName
MarbleName
| Type | Default | |
|---|---|---|
| string | Marble | |
Specify MaterialVariant name to override built-in Marble. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Marble.
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
History 2
- 553 Change Default of MarbleName from to Marble
- 518 Add MarbleName
MaterialFillToolEnabledChanged
| Parameters (1) | |
|---|---|
| shouldEnable | bool |
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
MetalName
| Type | Default | |
|---|---|---|
| string | Metal | |
Specify MaterialVariant name to override built-in Metal. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Metal.
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
MudName
| Type | Default | |
|---|---|---|
| string | Mud | |
Specify MaterialVariant name to override built-in Mud. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Mud.
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
OverrideStatusChanged
| Parameters (1) | |
|---|---|
| material | Material |
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
PavementName
| Type | Default | |
|---|---|---|
| string | Pavement | |
Specify MaterialVariant name to override built-in Pavement. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Pavement.
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
History 2
- 553 Change Default of PavementName from to Pavement
- 518 Add PavementName
PebbleName
| Type | Default | |
|---|---|---|
| string | Pebble | |
Specify MaterialVariant name to override built-in Pebble. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Pebble.
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
History 2
- 553 Change Default of PebbleName from to Pebble
- 518 Add PebbleName
PlasterName
| Type | Default | |
|---|---|---|
| string | Plaster | |
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
History 1
- 588 Add PlasterName
PlasticName
| Type | Default | |
|---|---|---|
| string | Plastic | |
Specify MaterialVariant name to override built-in Plastic. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Plastic.
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
History 2
- 553 Change Default of PlasticName from to Plastic
- 518 Add PlasticName
RockName
| Type | Default | |
|---|---|---|
| string | Rock | |
Specify MaterialVariant name to override built-in Rock. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Rock.
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
RoofShinglesName
| Type | Default | |
|---|---|---|
| string | RoofShingles | |
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
History 1
- 588 Add RoofShinglesName
RubberName
| Type | Default | |
|---|---|---|
| string | Rubber | |
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
History 1
- 588 Add RubberName
SaltName
| Type | Default | |
|---|---|---|
| string | Salt | |
Specify MaterialVariant name to override built-in Salt. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Salt.
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
SandName
| Type | Default | |
|---|---|---|
| string | Sand | |
Specify MaterialVariant name to override built-in Sand. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Sand.
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
SandstoneName
| Type | Default | |
|---|---|---|
| string | Sandstone | |
Specify MaterialVariant name to override built-in Sandstone. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Sandstone.
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
History 2
- 553 Change Default of SandstoneName from to Sandstone
- 518 Add SandstoneName
SetBaseMaterialOverride
| Parameters (2) | ||
|---|---|---|
| material | Material | |
| name | string | |
| Returns (1) | ||
| null | ||
Set a MaterialVariant name that overrides a built-in material.
| Thread safety | Unsafe |
|---|
History 2
- 573 Change ReturnType of SetBaseMaterialOverride from void to null
- 519 Add SetBaseMaterialOverride
SetCurrentMaterial
| Parameters (2) | ||
|---|---|---|
| baseMaterial | Material | |
| materialVariant | string | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
SlateName
| Type | Default | |
|---|---|---|
| string | Slate | |
Specify MaterialVariant name to override built-in Slate. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Slate.
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
SmoothPlasticName
| Type | Default | |
|---|---|---|
| string | SmoothPlastic | |
Specify MaterialVariant name to override built-in SmoothPlastic. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to SmoothPlastic.
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
History 2
- 553 Change Default of SmoothPlasticName from to SmoothPlastic
- 518 Add SmoothPlasticName
SnowName
| Type | Default | |
|---|---|---|
| string | Snow | |
Specify MaterialVariant name to override built-in Snow. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Snow.
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
ToggleMaterialFillToolEnabled
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
Use2022Materials
| Type | Default | |
|---|---|---|
| bool | false | |
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.
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Pack |
| Loaded/Saved | false |
History 5
- 553 Change Default of Use2022Materials from to false
- 525 Change CanLoad of Use2022Materials from true to false
- 524 Change Tags of Use2022Materials from [] to [NotReplicated]
- 524 Change CanSave of Use2022Materials from true to false
- 513 Add Use2022Materials
WoodName
| Type | Default | |
|---|---|---|
| string | Wood | |
Specify MaterialVariant name to override built-in Wood. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to Wood.
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
WoodPlanksName
| Type | Default | |
|---|---|---|
| string | WoodPlanks | |
Specify MaterialVariant name to override built-in WoodPlanks. The Specified MaterialVariant must have MaterialVariant.BaseMaterial set to WoodPlanks.
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
History 2
- 553 Change Default of WoodPlanksName from to WoodPlanks
- 518 Add WoodPlanksName
Removed members 49
Brick
| Type | Default | |
|---|---|---|
| MaterialVariant | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
ClearOverridePartMaterial
| Parameters (1) | ||
|---|---|---|
| material | Material | |
| Returns (1) | ||
| void | ||
| Thread safety | Unsafe |
|---|
History 2
ClearOverrideTerrainMaterial
| Parameters (1) | ||
|---|---|---|
| material | Material | |
| Returns (1) | ||
| void | ||
| Thread safety | Unsafe |
|---|
History 2
Cobblestone
| Type | Default | |
|---|---|---|
| MaterialVariant | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
History 5
- 529 Remove Cobblestone
- 504 Change ReadSecurity of Cobblestone from None to RobloxSecurity
- 504 Change Tags of Cobblestone from [] to [NotScriptable]
- 504 Change WriteSecurity of Cobblestone from None to RobloxSecurity
- 494 Add Cobblestone
Concrete
| Type | Default | |
|---|---|---|
| MaterialVariant | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
CorrodedMetal
| Type | Default | |
|---|---|---|
| MaterialVariant | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
History 5
- 529 Remove CorrodedMetal
- 504 Change ReadSecurity of CorrodedMetal from None to RobloxSecurity
- 504 Change Tags of CorrodedMetal from [] to [NotScriptable]
- 504 Change WriteSecurity of CorrodedMetal from None to RobloxSecurity
- 494 Add CorrodedMetal
DiamondPlate
| Type | Default | |
|---|---|---|
| MaterialVariant | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
History 5
- 529 Remove DiamondPlate
- 504 Change ReadSecurity of DiamondPlate from None to RobloxSecurity
- 504 Change Tags of DiamondPlate from [] to [NotScriptable]
- 504 Change WriteSecurity of DiamondPlate from None to RobloxSecurity
- 494 Add DiamondPlate
Fabric
| Type | Default | |
|---|---|---|
| MaterialVariant | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
Foil
| Type | Default | |
|---|---|---|
| MaterialVariant | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
GetMaterialOverride
| Parameters (1) | ||
|---|---|---|
| material | Material | |
| Returns (1) | ||
| string | ||
| Thread safety | Unsafe |
|---|
History 2
- 519 Remove GetMaterialOverride
- 518 Add GetMaterialOverride
GetOverridePartMaterial
| Parameters (1) | ||
|---|---|---|
| material | Material | |
| Returns (1) | ||
| MaterialVariant | ||
| Thread safety | Unsafe |
|---|
History 2
- 529 Remove GetOverridePartMaterial
- 504 Add GetOverridePartMaterial
GetOverrideTerrainMaterial
| Parameters (1) | ||
|---|---|---|
| material | Material | |
| Returns (1) | ||
| MaterialVariant | ||
| Thread safety | Unsafe |
|---|
History 2
Granite
| Type | Default | |
|---|---|---|
| MaterialVariant | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
Grass
| Type | Default | |
|---|---|---|
| MaterialVariant | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
Ice
| Type | Default | |
|---|---|---|
| MaterialVariant | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
Marble
| Type | Default | |
|---|---|---|
| MaterialVariant | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
Metal
| Type | Default | |
|---|---|---|
| MaterialVariant | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
Pebble
| Type | Default | |
|---|---|---|
| MaterialVariant | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
Plastic
| Type | Default | |
|---|---|---|
| MaterialVariant | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
Sand
| Type | Default | |
|---|---|---|
| MaterialVariant | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
SetMaterialOverride
| Parameters (2) | ||
|---|---|---|
| material | Material | |
| name | string | |
| Returns (1) | ||
| void | ||
| Thread safety | Unsafe |
|---|
History 2
- 519 Remove SetMaterialOverride
- 518 Add SetMaterialOverride
SetOverridePartMaterial
| Parameters (1) | ||
|---|---|---|
| materialVariant | MaterialVariant | |
| Returns (1) | ||
| void | ||
| Thread safety | Unsafe |
|---|
History 2
- 529 Remove SetOverridePartMaterial
- 504 Add SetOverridePartMaterial
SetOverrideTerrainMaterial
| Parameters (1) | ||
|---|---|---|
| materialVariant | MaterialVariant | |
| Returns (1) | ||
| void | ||
| Thread safety | Unsafe |
|---|
History 2
Slate
| Type | Default | |
|---|---|---|
| MaterialVariant | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
SmoothPlastic
| Type | Default | |
|---|---|---|
| MaterialVariant | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
History 5
- 529 Remove SmoothPlastic
- 504 Change ReadSecurity of SmoothPlastic from None to RobloxSecurity
- 504 Change Tags of SmoothPlastic from [] to [NotScriptable]
- 504 Change WriteSecurity of SmoothPlastic from None to RobloxSecurity
- 494 Add SmoothPlastic
TerrainAsphalt
| Type | Default | |
|---|---|---|
| MaterialVariant | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Terrain Overrides |
| Loaded/Saved | true |
History 2
- 529 Remove TerrainAsphalt
- 505 Add TerrainAsphalt
TerrainBasalt
| Type | Default | |
|---|---|---|
| MaterialVariant | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Terrain Overrides |
| Loaded/Saved | true |
History 2
- 529 Remove TerrainBasalt
- 505 Add TerrainBasalt
TerrainBrick
| Type | Default | |
|---|---|---|
| MaterialVariant | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Terrain Overrides |
| Loaded/Saved | true |
History 2
- 529 Remove TerrainBrick
- 505 Add TerrainBrick
TerrainCobblestone
| Type | Default | |
|---|---|---|
| MaterialVariant | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Terrain Overrides |
| Loaded/Saved | true |
History 2
- 529 Remove TerrainCobblestone
- 505 Add TerrainCobblestone
TerrainConcrete
| Type | Default | |
|---|---|---|
| MaterialVariant | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Terrain Overrides |
| Loaded/Saved | true |
History 2
- 529 Remove TerrainConcrete
- 505 Add TerrainConcrete
TerrainCrackedLava
| Type | Default | |
|---|---|---|
| MaterialVariant | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Terrain Overrides |
| Loaded/Saved | true |
History 2
- 529 Remove TerrainCrackedLava
- 505 Add TerrainCrackedLava
TerrainGlacier
| Type | Default | |
|---|---|---|
| MaterialVariant | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Terrain Overrides |
| Loaded/Saved | true |
History 2
- 529 Remove TerrainGlacier
- 505 Add TerrainGlacier
TerrainGrass
| Type | Default | |
|---|---|---|
| MaterialVariant | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Terrain Overrides |
| Loaded/Saved | true |
History 2
- 529 Remove TerrainGrass
- 505 Add TerrainGrass
TerrainGround
| Type | Default | |
|---|---|---|
| MaterialVariant | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Terrain Overrides |
| Loaded/Saved | true |
History 2
- 529 Remove TerrainGround
- 505 Add TerrainGround
TerrainIce
| Type | Default | |
|---|---|---|
| MaterialVariant | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Terrain Overrides |
| Loaded/Saved | true |
History 2
- 529 Remove TerrainIce
- 505 Add TerrainIce
TerrainLeafyGrass
| Type | Default | |
|---|---|---|
| MaterialVariant | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Terrain Overrides |
| Loaded/Saved | true |
History 2
- 529 Remove TerrainLeafyGrass
- 505 Add TerrainLeafyGrass
TerrainLimestone
| Type | Default | |
|---|---|---|
| MaterialVariant | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Terrain Overrides |
| Loaded/Saved | true |
History 2
- 529 Remove TerrainLimestone
- 505 Add TerrainLimestone
TerrainMud
| Type | Default | |
|---|---|---|
| MaterialVariant | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Terrain Overrides |
| Loaded/Saved | true |
History 2
- 529 Remove TerrainMud
- 505 Add TerrainMud
TerrainPavement
| Type | Default | |
|---|---|---|
| MaterialVariant | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Terrain Overrides |
| Loaded/Saved | true |
History 2
- 529 Remove TerrainPavement
- 505 Add TerrainPavement
TerrainRock
| Type | Default | |
|---|---|---|
| MaterialVariant | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Terrain Overrides |
| Loaded/Saved | true |
History 2
- 529 Remove TerrainRock
- 505 Add TerrainRock
TerrainSalt
| Type | Default | |
|---|---|---|
| MaterialVariant | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Terrain Overrides |
| Loaded/Saved | true |
History 2
- 529 Remove TerrainSalt
- 505 Add TerrainSalt
TerrainSand
| Type | Default | |
|---|---|---|
| MaterialVariant | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Terrain Overrides |
| Loaded/Saved | true |
History 2
- 529 Remove TerrainSand
- 505 Add TerrainSand
TerrainSandstone
| Type | Default | |
|---|---|---|
| MaterialVariant | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Terrain Overrides |
| Loaded/Saved | true |
History 2
- 529 Remove TerrainSandstone
- 505 Add TerrainSandstone
TerrainSlate
| Type | Default | |
|---|---|---|
| MaterialVariant | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Terrain Overrides |
| Loaded/Saved | true |
History 2
- 529 Remove TerrainSlate
- 512 Add TerrainSlate
TerrainSnow
| Type | Default | |
|---|---|---|
| MaterialVariant | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Terrain Overrides |
| Loaded/Saved | true |
History 2
- 529 Remove TerrainSnow
- 505 Add TerrainSnow
TerrainWoodPlanks
| Type | Default | |
|---|---|---|
| MaterialVariant | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Terrain Overrides |
| Loaded/Saved | true |
History 2
- 529 Remove TerrainWoodPlanks
- 512 Add TerrainWoodPlanks
Wood
| Type | Default | |
|---|---|---|
| MaterialVariant | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
WoodPlanks
| Type | Default | |
|---|---|---|
| MaterialVariant | ||
| Security | RobloxSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Material Overrides |
| Loaded/Saved | true |
History 5
- 529 Remove WoodPlanks
- 504 Change ReadSecurity of WoodPlanks from None to RobloxSecurity
- 504 Change Tags of WoodPlanks from [] to [NotScriptable]
- 504 Change WriteSecurity of WoodPlanks from None to RobloxSecurity
- 494 Add WoodPlanks