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"

-- 基本マテリアルの既存のMaterialVariantを見つけるか、新しく作成します
-- SetMaterialSlot()は、マテリアルマネージャーの表示名ではなく、バリアントの名前を期待します
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名、および色合いでスロットを構成します
-- バリアント名の代わりに空の文字列を渡すと、指定された色で色付けされた基本マテリアルのデフォルトの外観が使用されます
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)

-- スロットをインデックスで参照するボクセルの領域を書き込みます; 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,
})

-- スロットをクリアすると、それを参照するボクセルが無効としてレンダリングされ、正しいスロットインデックスで再描画されるまで無効のままです
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"

-- 基本マテリアルの既存のMaterialVariantを見つけるか、新しく作成します
-- SetMaterialSlot()は、マテリアルマネージャーの表示名ではなく、バリアントの名前を期待します
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名、および色合いでスロットを構成します
-- バリアント名の代わりに空の文字列を渡すと、指定された色で色付けされた基本マテリアルのデフォルトの外観が使用されます
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)

-- スロットをインデックスで参照するボクセルの領域を書き込みます; 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,
})

-- スロットをクリアすると、それを参照するボクセルが無効としてレンダリングされ、正しいスロットインデックスで再描画されるまで無効のままです
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"

-- 基本マテリアルの既存のMaterialVariantを見つけるか、新しく作成します
-- SetMaterialSlot()は、マテリアルマネージャーの表示名ではなく、バリアントの名前を期待します
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名、および色合いでスロットを構成します
-- バリアント名の代わりに空の文字列を渡すと、指定された色で色付けされた基本マテリアルのデフォルトの外観が使用されます
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)

-- スロットをインデックスで参照するボクセルの領域を書き込みます; 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,
})

-- スロットをクリアすると、それを参照するボクセルが無効としてレンダリングされ、正しいスロットインデックスで再描画されるまで無効のままです
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)