MaterialService
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.
Summary
Properties
Specify MaterialVariant name to override built-in Asphalt.
Specify MaterialVariant name to override built-in Basalt.
Specify MaterialVariant name to override built-in Brick.
Specify MaterialVariant name to override built-in Cobblestone.
Specify MaterialVariant name to override built-in Concrete.
Specify MaterialVariant name to override built-in CorrodedMetal.
Specify MaterialVariant name to override built-in CrackedLava.
Specify MaterialVariant name to override built-in DiamondPlate.
Specify MaterialVariant name to override built-in Fabric.
Specify MaterialVariant name to override built-in Foil.
Specify MaterialVariant name to override built-in Glacier.
Specify MaterialVariant name to override built-in Granite.
Specify MaterialVariant name to override built-in Grass.
Specify MaterialVariant name to override built-in Ground.
Specify MaterialVariant name to override built-in Ice.
Specify MaterialVariant name to override built-in LeafyGrass.
Specify MaterialVariant name to override built-in Limestone.
Specify MaterialVariant name to override built-in Marble.
Specify MaterialVariant name to override built-in Metal.
Specify MaterialVariant name to override built-in Mud.
Specify MaterialVariant name to override built-in Pavement.
Specify MaterialVariant name to override built-in Pebble.
Specify MaterialVariant name to override built-in Plastic.
Specify MaterialVariant name to override built-in Rock.
Specify MaterialVariant name to override built-in Salt.
Specify MaterialVariant name to override built-in Sand.
Specify MaterialVariant name to override built-in Sandstone.
Specify MaterialVariant name to override built-in Slate.
Specify MaterialVariant name to override built-in SmoothPlastic.
Specify MaterialVariant name to override built-in Snow.
Switch built-in material pack.
Specify MaterialVariant name to override built-in Wood.
Specify MaterialVariant name to override built-in WoodPlanks.
Methods
Get the override MaterialVariant name of specified Material type.
Get the effective MaterialVariant reference given a name and Material.
Set a MaterialVariant name that overrides a built-in material.