ReplaceMaterial

Unsafe

For thread safety, this property is not safe to read in an unsynchronized thread.

Function of:

Description:

ReplaceMaterial replaces terrain of a certain enum/Material within a datatype/Region3 with another material. Essentially, it is a find-and-replace operation on Terrain materials.

Constraints

When calling this method, the resolution parameter must be exactly 4. Additionally, the Region3 must be aligned to the terrain materials grid, i.e. the components of the Region3’s minimum and maximum points must be divisible by 4. Use Region3:ExpandToGrid to make a region compatible with this function.

Parameters

Name	Type	Default	Description
Name region	Type Region3	Default	Summary The region in which the replacement operation will occur
Name resolution	Type float	Default	Summary The resolution at which the replacement operation will take place; at the moment this must be exactly 4.
Name sourceMaterial	Type Material	Default	Summary The old material that shall be replaced
Name targetMaterial	Type Material	Default	Summary The new material

Returns

Return Type	Summary
Return Type void	Summary

Code Samples

Terrain:ReplaceMaterial

This code sample demonstrates the usage of Terrain/ReplaceMaterial by replacing grass near the game origin with asphalt. It does this by constructing a datatype/Region3 using two datatype/Vector3s.

			
				Terrain:ReplaceMaterial

				Expected Output
			
				Expand
				
			local min = Vector3.new(-20, -20, -20)
local max = Vector3.new(20, 20, 20)
local materialToReplace = Enum.Material.Grass
local replacementMaterial = Enum.Material.Asphalt

workspace.Terrain:ReplaceMaterial(Region3.new(min, max), 4, materialToReplace, replacementMaterial)
		
				Copy Code
			
				Light Theme

ReplaceMaterial

Constraints

Parameters

region

resolution

sourceMaterial

targetMaterial

Returns

void

Code Samples

Terrain:ReplaceMaterial