Terrain | เอกสาร - ศูนย์กลางครีเอเตอร์ Roblox

local terrainRegion = workspace.Terrain:CopyRegion(workspace.Terrain.MaxExtents)
workspace.Terrain:Clear()

task.wait(5)

workspace.Terrain:PasteRegion(terrainRegion, workspace.Terrain.MaxExtents.Min, true)

CountCells

ความสามารถ: Environment

Terrain:CountCells():number

ส่งค่ากลับ

number

FillBall

ความสามารถ: Environment

Terrain:FillBall(

center:Vector3, radius:number, material:Enum.Material

):()

พารามิเตอร์

center:Vector3

radius:number

material:Enum.Material

ส่งค่ากลับ

()

FillBlock

ความสามารถ: Environment

Terrain:FillBlock(

cframe:CFrame, size:Vector3, material:Enum.Material

):()

พารามิเตอร์

cframe:CFrame

size:Vector3

material:Enum.Material

ส่งค่ากลับ

()

FillCylinder

ความสามารถ: Environment

Terrain:FillCylinder(

cframe:CFrame, height:number, radius:number, material:Enum.Material

):()

พารามิเตอร์

cframe:CFrame

height:number

radius:number

material:Enum.Material

ส่งค่ากลับ

()

FillRegion

ความสามารถ: Environment

Terrain:FillRegion(

region:Region3, resolution:number, material:Enum.Material

):()

พารามิเตอร์

region:Region3

resolution:number

material:Enum.Material

ส่งค่ากลับ

()

FillWedge

ความสามารถ: Environment

Terrain:FillWedge(

cframe:CFrame, size:Vector3, material:Enum.Material

):()

พารามิเตอร์

cframe:CFrame

size:Vector3

material:Enum.Material

ส่งค่ากลับ

()

GetCell

เลิกใช้แล้ว

GetMaterialColor

เขียนพร้อมๆ กัน

ความสามารถ: Environment

Terrain:GetMaterialColor(material:Enum.Material):Color3

พารามิเตอร์

material:Enum.Material

ส่งค่ากลับ

Color3

GetMaterialSlot

ความสามารถ: Environment

Terrain:GetMaterialSlot(slotIndex:number):Tuple

พารามิเตอร์

slotIndex:number

ส่งค่ากลับ

Tuple

ตัวอย่างโค้ด

ช่องวัสดุภูมิประเทศ

local MaterialService = game:GetService("MaterialService")
local Terrain = workspace.Terrain

-- ช่อง 2 ถึง 63 สามารถเขียนได้; ช่อง 0 และ 1 ถูกสงวนไว้สำหรับอากาศและน้ำ
local SLOT_INDEX = 2
local BASE_MATERIAL = Enum.Material.Grass
local VARIANT_NAME = "SwampVariant"

-- ค้นหาวัสดุ Variant ที่มีอยู่สำหรับวัสดุพื้นฐาน หรือสร้างใหม่
-- SetMaterialSlot() คาดหวังชื่อของ variant ไม่ใช่ชื่อที่แสดงของ Material Manager
local variant = MaterialService:FindFirstChild(VARIANT_NAME)
if not variant then
	variant = Instance.new("MaterialVariant")
	variant.Name = VARIANT_NAME
	variant.BaseMaterial = BASE_MATERIAL
	variant.Parent = MaterialService
end

-- กำหนดค่าช่องด้วยวัสดุพื้นฐาน ชื่อ MaterialVariant และสี
-- ส่งสตริงว่างแทนชื่อ variant เพื่อใช้รูปลักษณ์เริ่มต้นของวัสดุพื้นฐานที่มีสีที่กำหนด
Terrain:SetMaterialSlot(SLOT_INDEX, BASE_MATERIAL, variant.Name, Color3.fromRGB(50, 60, 30))

local baseMaterial, materialVariant, color = Terrain:GetMaterialSlot(SLOT_INDEX)
print(baseMaterial, materialVariant, color)

-- เขียนพื้นที่ของ voxel ที่อ้างอิงช่องตามดัชนี แทนที่จะเป็น Enum.Material โดยใช้ช่อง SolidMaterialIndex
local region = Region3.new(Vector3.new(0, 0, 0), Vector3.new(16, 16, 16)):ExpandToGrid(4)
local size = region.Size / 4

local materialIndices = {}
local occupancies = {}
for x = 1, size.X do
	materialIndices[x] = {}
	occupancies[x] = {}
	for y = 1, size.Y do
		materialIndices[x][y] = {}
		occupancies[x][y] = {}
		for z = 1, size.Z do
			materialIndices[x][y][z] = SLOT_INDEX
			occupancies[x][y][z] = 1
		end
	end
end

Terrain:WriteVoxelChannels(region, 4, {
	SolidMaterialIndex = materialIndices,
	SolidOccupancy = occupancies,
})

-- การลบช่องจะทำให้ voxel ที่อ้างอิงมันแสดงผลเป็นไม่ถูกต้องจนกว่าจะถูกทาสีใหม่ด้วยดัชนีช่องที่ถูกต้อง
Terrain:ResetMaterialSlot(SLOT_INDEX)

GetWaterCell

เลิกใช้แล้ว

PasteRegion

ความสามารถ: Environment

Terrain:PasteRegion(

region:TerrainRegion, corner:Vector3int16, pasteEmptyCells:boolean

):()

พารามิเตอร์

region:TerrainRegion

corner:Vector3int16

pasteEmptyCells:boolean

ส่งค่ากลับ

()

ตัวอย่างโค้ด

สร้าง คัดลอก และวางภูมิประเทศ

local Terrain = workspace.Terrain

-- สร้างภูมิประเทศง่ายๆ
local initialRegion = Region3.new(Vector3.zero, Vector3.one * 10)
Terrain:FillRegion(initialRegion, 4, Enum.Material.Grass)

-- คัดลอกภูมิประเทศ
local copyRegion = Region3int16.new(Vector3int16.new(0, 0, 0), Vector3int16.new(10, 10, 10))
local copiedRegion = Terrain:CopyRegion(copyRegion)

-- กำหนดตำแหน่งที่จะวางภูมิประเทศ
local newRegionCorner = Vector3int16.new(5, 0, 0)

-- วางภูมิประเทศ
Terrain:PasteRegion(copiedRegion, newRegionCorner, true)

ReadVoxelChannels

เขียนพร้อมๆ กัน

ความสามารถ: Environment

Terrain:ReadVoxelChannels(

region:Region3, resolution:number, channelIds:{any}

):Dictionary

พารามิเตอร์

region:Region3

resolution:number

channelIds:{any}

ส่งค่ากลับ

Dictionary

ตัวอย่างโค้ด

Terrain:ReadVoxelChannels()

local REGION_START = Vector3.new(-20, -20, -20)
local REGION_END = Vector3.new(20, 20, 20)

local function printRegion(terrain, region)
	local channelOutput = terrain:ReadVoxelChannels(region, 4, { "SolidOccupancy", "SolidMaterial", "LiquidOccupancy" })
	local size = channelOutput.Size
	for x = 1, size.X do
		for y = 1, size.Y do
			for z = 1, size.Z do
				print(
					("(%2i, %2i, %2i): %.2f %s %.2f"):format(
						x,
						y,
						z,
						channelOutput.SolidOccupancy[x][y][z],
						channelOutput.SolidMaterial[x][y][z].Name,
						channelOutput.LiquidOccupancy[x][y][z]
					)
				)
			end
		end
	end
end

local region = Region3.new(REGION_START, REGION_END)
printRegion(workspace.Terrain, region)

ReadVoxels

เขียนพร้อมๆ กัน

ความสามารถ: Environment

Terrain:ReadVoxels(

region:Region3, resolution:number

):Tuple

พารามิเตอร์

region:Region3

resolution:number

ส่งค่ากลับ

Tuple

ตัวอย่างโค้ด

Terrain:ReadVoxels()

local REGION_START = Vector3.new(-20, -20, -20)
local REGION_END = Vector3.new(20, 20, 20)

local function printRegion(terrain, region)
	local materials, occupancies = terrain:ReadVoxels(region, 4)

	local size = materials.Size -- ขนาดเดียวกับ occupancies.Size

	for x = 1, size.X, 1 do
		for y = 1, size.Y, 1 do
			for z = 1, size.Z, 1 do
				print(("(%2i, %2i, %2i): %.2f %s"):format(x, y, z, occupancies[x][y][z], materials[x][y][z].Name))
			end
		end
	end
end

local region = Region3.new(REGION_START, REGION_END)

printRegion(workspace.Terrain, region)

ReplaceMaterial

ความสามารถ: Environment

Terrain:ReplaceMaterial(

region:Region3, resolution:number, sourceMaterial:Enum.Material, targetMaterial:Enum.Material

):()

พารามิเตอร์

region:Region3

resolution:number

sourceMaterial:Enum.Material

targetMaterial:Enum.Material

ส่งค่ากลับ

()

ตัวอย่างโค้ด

Terrain:ReplaceMaterial

local terrain = workspace.Terrain
local region = Region3.new(Vector3.new(-20, -20, -20), Vector3.new(20, 20, 20))
local resolution = 4
local materialToReplace = Enum.Material.Grass
local replacementMaterial = Enum.Material.Asphalt

terrain:ReplaceMaterial(region, resolution, materialToReplace, replacementMaterial)

ResetMaterialSlot

ความสามารถ: Environment

Terrain:ResetMaterialSlot(slotIndex:number):()

พารามิเตอร์

slotIndex:number

ส่งค่ากลับ

()

ตัวอย่างโค้ด

ช่องวัสดุภูมิประเทศ

local MaterialService = game:GetService("MaterialService")
local Terrain = workspace.Terrain

-- ช่อง 2 ถึง 63 สามารถเขียนได้; ช่อง 0 และ 1 ถูกสงวนไว้สำหรับอากาศและน้ำ
local SLOT_INDEX = 2
local BASE_MATERIAL = Enum.Material.Grass
local VARIANT_NAME = "SwampVariant"

-- ค้นหาวัสดุ Variant ที่มีอยู่สำหรับวัสดุพื้นฐาน หรือสร้างใหม่
-- SetMaterialSlot() คาดหวังชื่อของ variant ไม่ใช่ชื่อที่แสดงของ Material Manager
local variant = MaterialService:FindFirstChild(VARIANT_NAME)
if not variant then
	variant = Instance.new("MaterialVariant")
	variant.Name = VARIANT_NAME
	variant.BaseMaterial = BASE_MATERIAL
	variant.Parent = MaterialService
end

-- กำหนดค่าช่องด้วยวัสดุพื้นฐาน ชื่อ MaterialVariant และสี
-- ส่งสตริงว่างแทนชื่อ variant เพื่อใช้รูปลักษณ์เริ่มต้นของวัสดุพื้นฐานที่มีสีที่กำหนด
Terrain:SetMaterialSlot(SLOT_INDEX, BASE_MATERIAL, variant.Name, Color3.fromRGB(50, 60, 30))

local baseMaterial, materialVariant, color = Terrain:GetMaterialSlot(SLOT_INDEX)
print(baseMaterial, materialVariant, color)

-- เขียนพื้นที่ของ voxel ที่อ้างอิงช่องตามดัชนี แทนที่จะเป็น Enum.Material โดยใช้ช่อง SolidMaterialIndex
local region = Region3.new(Vector3.new(0, 0, 0), Vector3.new(16, 16, 16)):ExpandToGrid(4)
local size = region.Size / 4

local materialIndices = {}
local occupancies = {}
for x = 1, size.X do
	materialIndices[x] = {}
	occupancies[x] = {}
	for y = 1, size.Y do
		materialIndices[x][y] = {}
		occupancies[x][y] = {}
		for z = 1, size.Z do
			materialIndices[x][y][z] = SLOT_INDEX
			occupancies[x][y][z] = 1
		end
	end
end

Terrain:WriteVoxelChannels(region, 4, {
	SolidMaterialIndex = materialIndices,
	SolidOccupancy = occupancies,
})

-- การลบช่องจะทำให้ voxel ที่อ้างอิงมันแสดงผลเป็นไม่ถูกต้องจนกว่าจะถูกทาสีใหม่ด้วยดัชนีช่องที่ถูกต้อง
Terrain:ResetMaterialSlot(SLOT_INDEX)

SetCell

เลิกใช้แล้ว

SetCells

เลิกใช้แล้ว

SetMaterialColor

ความสามารถ: Environment

Terrain:SetMaterialColor(

material:Enum.Material, value:Color3

):()

พารามิเตอร์

material:Enum.Material

value:Color3

ส่งค่ากลับ

()

SetMaterialSlot

ความสามารถ: Environment

Terrain:SetMaterialSlot(

slotIndex:number, baseMaterial:Enum.Material, materialVariant:string, color:Color3

):()

พารามิเตอร์

slotIndex:number

baseMaterial:Enum.Material

materialVariant:string

color:Color3

ส่งค่ากลับ

()

ตัวอย่างโค้ด

ช่องวัสดุภูมิประเทศ

local MaterialService = game:GetService("MaterialService")
local Terrain = workspace.Terrain

-- ช่อง 2 ถึง 63 สามารถเขียนได้; ช่อง 0 และ 1 ถูกสงวนไว้สำหรับอากาศและน้ำ
local SLOT_INDEX = 2
local BASE_MATERIAL = Enum.Material.Grass
local VARIANT_NAME = "SwampVariant"

-- ค้นหาวัสดุ Variant ที่มีอยู่สำหรับวัสดุพื้นฐาน หรือสร้างใหม่
-- SetMaterialSlot() คาดหวังชื่อของ variant ไม่ใช่ชื่อที่แสดงของ Material Manager
local variant = MaterialService:FindFirstChild(VARIANT_NAME)
if not variant then
	variant = Instance.new("MaterialVariant")
	variant.Name = VARIANT_NAME
	variant.BaseMaterial = BASE_MATERIAL
	variant.Parent = MaterialService
end

-- กำหนดค่าช่องด้วยวัสดุพื้นฐาน ชื่อ MaterialVariant และสี
-- ส่งสตริงว่างแทนชื่อ variant เพื่อใช้รูปลักษณ์เริ่มต้นของวัสดุพื้นฐานที่มีสีที่กำหนด
Terrain:SetMaterialSlot(SLOT_INDEX, BASE_MATERIAL, variant.Name, Color3.fromRGB(50, 60, 30))

local baseMaterial, materialVariant, color = Terrain:GetMaterialSlot(SLOT_INDEX)
print(baseMaterial, materialVariant, color)

-- เขียนพื้นที่ของ voxel ที่อ้างอิงช่องตามดัชนี แทนที่จะเป็น Enum.Material โดยใช้ช่อง SolidMaterialIndex
local region = Region3.new(Vector3.new(0, 0, 0), Vector3.new(16, 16, 16)):ExpandToGrid(4)
local size = region.Size / 4

local materialIndices = {}
local occupancies = {}
for x = 1, size.X do
	materialIndices[x] = {}
	occupancies[x] = {}
	for y = 1, size.Y do
		materialIndices[x][y] = {}
		occupancies[x][y] = {}
		for z = 1, size.Z do
			materialIndices[x][y][z] = SLOT_INDEX
			occupancies[x][y][z] = 1
		end
	end
end

Terrain:WriteVoxelChannels(region, 4, {
	SolidMaterialIndex = materialIndices,
	SolidOccupancy = occupancies,
})

-- การลบช่องจะทำให้ voxel ที่อ้างอิงมันแสดงผลเป็นไม่ถูกต้องจนกว่าจะถูกทาสีใหม่ด้วยดัชนีช่องที่ถูกต้อง
Terrain:ResetMaterialSlot(SLOT_INDEX)

SetWaterCell

เลิกใช้แล้ว

WorldToCell

ความสามารถ: Environment

Terrain:WorldToCell(position:Vector3):Vector3

พารามิเตอร์

position:Vector3

ส่งค่ากลับ

Vector3

WorldToCellPreferEmpty

ความสามารถ: Environment

Terrain:WorldToCellPreferEmpty(position:Vector3):Vector3

พารามิเตอร์

position:Vector3

ส่งค่ากลับ

Vector3

WorldToCellPreferSolid

ความสามารถ: Environment

Terrain:WorldToCellPreferSolid(position:Vector3):Vector3

พารามิเตอร์

position:Vector3

ส่งค่ากลับ

Vector3

WriteVoxelChannels

ความสามารถ: Environment

Terrain:WriteVoxelChannels(

region:Region3, resolution:number, channels:Dictionary

):()

พารามิเตอร์

region:Region3

resolution:number

channels:Dictionary

ส่งค่ากลับ

()

ตัวอย่างโค้ด

Terrain:WriteVoxelChannels()

local region = Region3.new(Vector3.new(0, 0, 0), Vector3.new(64, 32, 64))

local RESOLUTION = 4
local OCC_EPSILON = 1 / 256

local function generateRandomTerrainInRegion(regionInput)
	local region = regionInput:ExpandToGrid(4)
	local size = region.Size / 4
	local solidMaterials = {}
	local solidOccupancies = {}
	local waterOcc = {}

	for x = 1, size.X do
		table.insert(solidMaterials, {})
		table.insert(solidOccupancies, {})
		table.insert(waterOcc, {})

		for y = 1, size.Y do
			table.insert(solidMaterials[x], {})
			table.insert(solidOccupancies[x], {})
			table.insert(waterOcc[x], {})

			for z = 1, size.Z do
				local mat = if math.random() < 0.5 then Enum.Material.Air else Enum.Material.Sand
				local occ = 0
				local water = math.random()
				if mat == Enum.Material.Sand then
					occ = math.random() / 2 + 0.5
					if occ > 1 - OCC_EPSILON then
						water = 0 -- ของแข็งไม่สามารถมีน้ำได้
					end
				else
					occ = 0
				end
				table.insert(solidMaterials[x][y], mat)
				table.insert(solidOccupancies[x][y], occ)
				table.insert(waterOcc[x][y], water)
			end
		end
	end
	return { SolidMaterial = solidMaterials, SolidOccupancy = solidOccupancies, LiquidOccupancy = waterOcc }
end

local regionContent = generateRandomTerrainInRegion(region)
workspace.Terrain:WriteVoxelChannels(region, 4, regionContent)

WriteVoxels

ความสามารถ: Environment

Terrain:WriteVoxels(

region:Region3, resolution:number, materials:{any}, occupancy:{any}

):()

พารามิเตอร์

region:Region3

resolution:number

materials:{any}

occupancy:{any}

ส่งค่ากลับ

()

ตัวอย่างโค้ด

Terrain:WriteVoxels()

local terrain = workspace.Terrain
local resolution = 4
local region = Region3.new(Vector3.new(0, 0, 0), Vector3.new(16, 28, 20)):ExpandToGrid(resolution)
local materials = {
	{
		{
			Enum.Material.CrackedLava,
			Enum.Material.CrackedLava,
			Enum.Material.CrackedLava,
			Enum.Material.CrackedLava,
			Enum.Material.CrackedLava,
		},
		{ Enum.Material.Rock, Enum.Material.Rock, Enum.Material.Rock, Enum.Material.Rock, Enum.Material.Rock },
		{ Enum.Material.Rock, Enum.Material.Rock, Enum.Material.Rock, Enum.Material.Rock, Enum.Material.Rock },
		{ Enum.Material.Sand, Enum.Material.Sand, Enum.Material.Sand, Enum.Material.Sand, Enum.Material.Sand },
		{ Enum.Material.Sand, Enum.Material.Sand, Enum.Material.Sand, Enum.Material.Sand, Enum.Material.Sand },
		{ Enum.Material.Mud, Enum.Material.Mud, Enum.Material.Mud, Enum.Material.Mud, Enum.Material.Mud },
		{ Enum.Material.Air, Enum.Material.Air, Enum.Material.Air, Enum.Material.Air, Enum.Material.Air },
	},
	{
		{
			Enum.Material.CrackedLava,
			Enum.Material.CrackedLava,
			Enum.Material.CrackedLava,
			Enum.Material.CrackedLava,
			Enum.Material.CrackedLava,
		},
		{ Enum.Material.Rock, Enum.Material.Rock, Enum.Material.Rock, Enum.Material.Rock, Enum.Material.Rock },
		{ Enum.Material.Rock, Enum.Material.Rock, Enum.Material.Rock, Enum.Material.Rock, Enum.Material.Rock },
		{ Enum.Material.Sand, Enum.Material.Sand, Enum.Material.Sand, Enum.Material.Sand, Enum.Material.Sand },
		{ Enum.Material.Sand, Enum.Material.Sand, Enum.Material.Sand, Enum.Material.Sand, Enum.Material.Sand },
		{ Enum.Material.Mud, Enum.Material.Snow, Enum.Material.Snow, Enum.Material.Snow, Enum.Material.Mud },
		{ Enum.Material.Air, Enum.Material.Snow, Enum.Material.Snow, Enum.Material.Snow, Enum.Material.Air },
	},
	{
		{
			Enum.Material.CrackedLava,
			Enum.Material.Sand,
			Enum.Material.Sand,
			Enum.Material.Sand,
			Enum.Material.CrackedLava,
		},
		{ Enum.Material.Rock, Enum.Material.Rock, Enum.Material.Rock, Enum.Material.Rock, Enum.Material.Rock },
		{ Enum.Material.Rock, Enum.Material.Rock, Enum.Material.Rock, Enum.Material.Rock, Enum.Material.Rock },
		{ Enum.Material.Sand, Enum.Material.Sand, Enum.Material.Sand, Enum.Material.Sand, Enum.Material.Sand },
		{ Enum.Material.Sand, Enum.Material.Sand, Enum.Material.Sand, Enum.Material.Sand, Enum.Material.Sand },
		{ Enum.Material.Mud, Enum.Material.Snow, Enum.Material.Snow, Enum.Material.Snow, Enum.Material.Mud },
		{ Enum.Material.Air, Enum.Material.Snow, Enum.Material.Snow, Enum.Material.Snow, Enum.Material.Air },
	},
	{
		{
			Enum.Material.CrackedLava,
			Enum.Material.CrackedLava,
			Enum.Material.CrackedLava,
			Enum.Material.CrackedLava,
			Enum.Material.CrackedLava,
		},
		{ Enum.Material.Rock, Enum.Material.Rock, Enum.Material.Rock, Enum.Material.Rock, Enum.Material.Rock },
		{ Enum.Material.Rock, Enum.Material.Rock, Enum.Material.Rock, Enum.Material.Rock, Enum.Material.Rock },
		{ Enum.Material.Sand, Enum.Material.Sand, Enum.Material.Sand, Enum.Material.Sand, Enum.Material.Sand },
		{ Enum.Material.Sand, Enum.Material.Sand, Enum.Material.Sand, Enum.Material.Sand, Enum.Material.Sand },
		{ Enum.Material.Mud, Enum.Material.Mud, Enum.Material.Mud, Enum.Material.Mud, Enum.Material.Mud },
		{ Enum.Material.Air, Enum.Material.Air, Enum.Material.Air, Enum.Material.Air, Enum.Material.Air },
	},
}
local occupancies = {
	{
		{ 1, 1, 1, 1, 1 },
		{ 1, 1, 1, 1, 1 },
		{ 1, 1, 1, 1, 1 },
		{ 1, 1, 1, 1, 1 },
		{ 1, 1, 1, 1, 1 },
		{ 0.5, 0.5, 0.5, 0.5, 0.5 },
		{ 0, 0, 0, 0, 0 },
	},
	{
		{ 1, 1, 1, 1, 1 },
		{ 1, 1, 1, 1, 1 },
		{ 1, 1, 1, 1, 1 },
		{ 1, 1, 1, 1, 1 },
		{ 1, 1, 1, 1, 1 },
		{ 0.5, 1, 1, 1, 0.5 },
		{ 0, 1, 1, 1, 0 },
	},
	{
		{ 1, 1, 1, 1, 1 },
		{ 1, 1, 1, 1, 1 },
		{ 1, 1, 1, 1, 1 },
		{ 1, 1, 1, 1, 1 },
		{ 1, 1, 1, 1, 1 },
		{ 0.5, 1, 1, 1, 0.5 },
		{ 0, 1, 1, 1, 0 },
	},
	{
		{ 1, 1, 1, 1, 1 },
		{ 1, 1, 1, 1, 1 },
		{ 1, 1, 1, 1, 1 },
		{ 1, 1, 1, 1, 1 },
		{ 1, 1, 1, 1, 1 },
		{ 0.5, 0.5, 0.5, 0.5, 0.5 },
		{ 0, 0, 0, 0, 0 },
	},
}

terrain:WriteVoxels(region, resolution, materials, occupancies)