Skip to content
Roblox API Reference

MaterialService

The game service responsible for managing materials.
  • Not creatable
  • Service
Memory category
Instances
Own members
52
Inherited members
75
Subclasses
0
Siblings
608

Properties65

Inherited fromObject2

Property categoryData

Inherited fromInstance21

Property categoryBehavior

Property categoryData

Property categoryPermissions

Defined byMaterialService42

Property categoryMaterial Overrides

  • MaterialService.AsphaltName: string = "Asphalt"
    Specify MaterialVariant name to override built-in Asphalt.
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Material
  • MaterialService.BasaltName: string = "Basalt"
    Specify MaterialVariant name to override built-in Basalt.
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Material
  • MaterialService.BrickName: string = "Brick"
    Specify MaterialVariant name to override built-in Brick.
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Material
  • MaterialService.CardboardName: string = "Cardboard"
    Specify MaterialVariant name to override built-in Cardboard.
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Material
  • MaterialService.CarpetName: string = "Carpet"
    Specify MaterialVariant name to override built-in Carpet.
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Material
  • MaterialService.CeramicTilesName: string = "CeramicTiles"
    Specify MaterialVariant name to override built-in CeramicTiles.
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Material
  • MaterialService.ClayRoofTilesName: string = "ClayRoofTiles"
    Specify MaterialVariant name to override built-in ClayRoofTiles.
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Material
  • MaterialService.CobblestoneName: string = "Cobblestone"
    Specify MaterialVariant name to override built-in Cobblestone.
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Material
  • MaterialService.ConcreteName: string = "Concrete"
    Specify MaterialVariant name to override built-in Concrete.
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Material
  • MaterialService.CorrodedMetalName: string = "CorrodedMetal"
    Specify MaterialVariant name to override built-in CorrodedMetal.
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Material
  • MaterialService.CrackedLavaName: string = "CrackedLava"
    Specify MaterialVariant name to override built-in CrackedLava.
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Material
  • MaterialService.DiamondPlateName: string = "DiamondPlate"
    Specify MaterialVariant name to override built-in DiamondPlate.
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Material
  • MaterialService.FabricName: string = "Fabric"
    Specify MaterialVariant name to override built-in Fabric.
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Material
  • MaterialService.FoilName: string = "Foil"
    Specify MaterialVariant name to override built-in Foil.
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Material
  • MaterialService.GlacierName: string = "Glacier"
    Specify MaterialVariant name to override built-in Glacier.
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Material
  • MaterialService.GraniteName: string = "Granite"
    Specify MaterialVariant name to override built-in Granite.
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Material
  • MaterialService.GrassName: string = "Grass"
    Specify MaterialVariant name to override built-in Grass.
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Material
  • MaterialService.GroundName: string = "Ground"
    Specify MaterialVariant name to override built-in Ground.
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Material
  • MaterialService.IceName: string = "Ice"
    Specify MaterialVariant name to override built-in Ice.
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Material
  • MaterialService.LeafyGrassName: string = "LeafyGrass"
    Specify MaterialVariant name to override built-in LeafyGrass.
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Material
  • MaterialService.LeatherName: string = "Leather"
    Specify MaterialVariant name to override built-in Leather.
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Material
  • MaterialService.LimestoneName: string = "Limestone"
    Specify MaterialVariant name to override built-in Limestone.
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Material
  • MaterialService.MarbleName: string = "Marble"
    Specify MaterialVariant name to override built-in Marble.
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Material
  • MaterialService.MetalName: string = "Metal"
    Specify MaterialVariant name to override built-in Metal.
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Material
  • MaterialService.MudName: string = "Mud"
    Specify MaterialVariant name to override built-in Mud.
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Material
  • MaterialService.PavementName: string = "Pavement"
    Specify MaterialVariant name to override built-in Pavement.
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Material
  • MaterialService.PebbleName: string = "Pebble"
    Specify MaterialVariant name to override built-in Pebble.
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Material
  • MaterialService.PlasterName: string = "Plaster"
    Specify MaterialVariant name to override built-in Plaster.
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Material
  • MaterialService.PlasticName: string = "Plastic"
    Specify MaterialVariant name to override built-in Plastic.
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Material
  • MaterialService.RockName: string = "Rock"
    Specify MaterialVariant name to override built-in Rock.
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Material
  • MaterialService.RoofShinglesName: string = "RoofShingles"
    Specify MaterialVariant name to override built-in RoofShingles.
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Material
  • MaterialService.RubberName: string = "Rubber"
    Specify MaterialVariant name to override built-in Rubber.
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Material
  • MaterialService.SaltName: string = "Salt"
    Specify MaterialVariant name to override built-in Salt.
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Material
  • MaterialService.SandName: string = "Sand"
    Specify MaterialVariant name to override built-in Sand.
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Material
  • MaterialService.SandstoneName: string = "Sandstone"
    Specify MaterialVariant name to override built-in Sandstone.
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Material
  • MaterialService.SlateName: string = "Slate"
    Specify MaterialVariant name to override built-in Slate.
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Material
  • MaterialService.SmoothPlasticName: string = "SmoothPlastic"
    Specify MaterialVariant name to override built-in SmoothPlastic.
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Material
  • MaterialService.SnowName: string = "Snow"
    Specify MaterialVariant name to override built-in Snow.
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Material
  • MaterialService.WoodName: string = "Wood"
    Specify MaterialVariant name to override built-in Wood.
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Material
  • MaterialService.WoodPlanksName: string = "WoodPlanks"
    Specify MaterialVariant name to override built-in WoodPlanks.
    • Not scriptable
    • Roblox engine security
    • Read capabilities: Material

Property categoryMaterial Pack

  • MaterialService.Use2022Materials: boolean = false
    Switch built-in material pack.
    • Not replicated
    • Roblox script security
    • Read capabilities: Material
  • MaterialService.Use2022MaterialsXml: boolean = false
    • Hidden
    • Not scriptable
    • Read capabilities: Material

Methods50

Inherited fromObject3
  • Get an event that fires when a given property of the object changes.
    Parameters
    ParameterDescription
    property: string
    The property to connect to.
    Returns
    TypeDescription
    RBXScriptSignal
    A signal that fires whenever the property changes.
  • Object:IsA(className: string): boolean
    Returns true if an object's class matches or inherits from a given class.
    • Custom Lua state
    • Thread safe
    Parameters
    ParameterDescription
    className: string
    The class against which the Object's class will be checked. Case-sensitive.
    Returns
    TypeDescription
    boolean
    Describes whether the Object's class matched or is a subclass of the given class.
  • Object:isA(className: string): boolean
    Deprecated: This deprecated function is a variant of Object:IsA() which should be used instead.
    • Deprecated
    • Custom Lua state
    Parameters
    Parameter
    className: string
    Returns
    Type
    boolean

    Use IsA instead.

Inherited fromInstance39
Defined byMaterialService8
  • MaterialService:GetBaseMaterialOverride(material: Enum.Material): string
    Get the override MaterialVariant name of specified Material type.
    • Capabilities: Material
    Parameters
    ParameterDescription
    material: Enum.Material
    Material type to be fetched.
    Returns
    TypeDescription
    string
    MaterialVariant name currently set as override.
  • MaterialService:GetIsMaterialActionAsToolEnabled(): boolean
    • Roblox script security
    • Capabilities: Material
    Returns
    Type
    boolean
  • MaterialService:GetMaterialOverrideChanged(material: Enum.Material): RBXScriptSignal
    • Roblox script security
    • Capabilities: Material
    Parameters
    Parameter
    material: Enum.Material
    Returns
    Type
    RBXScriptSignal
  • MaterialService:GetMaterialVariant(material: Enum.Material,name: string,): MaterialVariant
    Get the effective MaterialVariant reference given a name and Material.
    • Capabilities: Material
    Parameters
    ParameterDescription
    material: Enum.Material
    BaseMaterial of MaterialVariant.
    name: string
    Name of MaterialVariant.
    Returns
    TypeDescription
    MaterialVariant
    A MaterialVariant instance that matches parameters.
  • MaterialService:GetOverrideStatus(material: Enum.Material): Enum.PropertyStatus
    • Roblox script security
    • Capabilities: Material
    Parameters
    Parameter
    material: Enum.Material
  • MaterialService:SetBaseMaterialOverride(material: Enum.Material, name: string)
    Set a MaterialVariant name that overrides a built-in material.
    • Capabilities: Material
    Parameters
    ParameterDescription
    material: Enum.Material
    The Material type to be changed.
    name: string
    Name of the MaterialVariant object.
  • MaterialService:SetCurrentMaterial(baseMaterial: Enum.Material,materialVariant: string,)
    • Roblox script security
    • Capabilities: Material
    Parameters
    Parameter
    baseMaterial: Enum.Material
    materialVariant: string
  • MaterialService:ToggleMaterialFillToolEnabled()
    • Roblox script security
    • Capabilities: Material

Events12

Inherited fromObject1
Inherited fromInstance9
Defined byMaterialService2