TerrainRegion
An object that stores a chunk of terrain voxel data, produced by Terrain:CopyRegion() and consumed by Terrain:PasteRegion().
| Memory category | Instances |
|---|
Member index 10
Description
A TerrainRegion is a snapshot of Terrain retrieved from the Terrain:CopyRegion() method. Can be later pasted into the Terrain using Terrain:PasteRegion().
History 36
- 731 Add
- 731 Change Default of SizeInCells from to Vector3(1, 1, 1)
- 731 Change Default of IsSmooth from to true
- 731 Add
- 731 Add
- 731 Add
- 726 Remove
- 726 Change Default of SizeInCells from Vector3(1, 1, 1) to
- 726 Change Default of IsSmooth from true to
- 726 Remove
- 726 Remove
- 726 Remove
- 582 Add ApplyTransformSubregion
- 573 Change ReturnType of ConvertToSmooth from void to null
- 573 Change ReturnType of ApplyTransform from void to null
- 569 Add GetRegionWireframe
- 557 Add ApplyTransform
- 554 Remove ApplyTransform
- 555 Add ApplyTransform
- 553 Add
- 553 Change Default of SizeInCells from to Vector3(1, 1, 1)
- 553 Change Default of IsSmooth from to true
- 553 Add
- 553 Add
- 553 Add
- 486 Change ThreadSafety of SizeInCells from ReadOnly to ReadSafe
- 486 Change ThreadSafety of IsSmooth from ReadOnly to ReadSafe
- 462 Change ThreadSafety of ConvertToSmooth from to Unsafe
- 462 Change ThreadSafety of SizeInCells from to ReadOnly
- 462 Change ThreadSafety of IsSmooth from to ReadOnly
- 297 Change Tags of ConvertToSmooth from [] to [Deprecated]
- 297 Change Tags of IsSmooth from [ReadOnly, NotReplicated] to [ReadOnly, NotReplicated, Deprecated]
- 193 Add ConvertToSmooth
- 193 Add IsSmooth
- 130 Add SizeInCells
- 130 Add TerrainRegion
Members 10
ApplyTransform
| Parameters (2) | ||
|---|---|---|
| rotation | CFrame | |
| size | Vector3 | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 4
- 573 Change ReturnType of ApplyTransform from void to null
- 557 Add ApplyTransform
- 554 Remove ApplyTransform
- 555 Add ApplyTransform
ApplyTransformSubregion
| Parameters (3) | ||
|---|---|---|
| rotation | CFrame | |
| size | Vector3 | |
| region | Region3int16 | |
| Returns (1) | ||
| TerrainRegion | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
ConvertToSmooth
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| null | ||
Calling this method transforms the TerrainRegion into a TerrainRegion usable for Terrain. This can only be done from a plugin, when in edit mode.
The game can't be running, nor can it have a NetworkServer.
| Security | PluginSecurity |
|---|---|
| Thread safety | Unsafe |
History 4
- 573 Change ReturnType of ConvertToSmooth from void to null
- 462 Change ThreadSafety of ConvertToSmooth from to Unsafe
- 297 Change Tags of ConvertToSmooth from [] to [Deprecated]
- 193 Add ConvertToSmooth
GetRegionWireframe
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Array | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
IsSmooth
| Type | Default | |
|---|---|---|
| bool | true | |
The state of this property shows whether or not this TerrainRegion contains smooth terrain.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
History 7
- 731 Change Default of IsSmooth from to true
- 726 Change Default of IsSmooth from true to
- 553 Change Default of IsSmooth from to true
- 486 Change ThreadSafety of IsSmooth from ReadOnly to ReadSafe
- 462 Change ThreadSafety of IsSmooth from to ReadOnly
- 297 Change Tags of IsSmooth from [ReadOnly, NotReplicated] to [ReadOnly, NotReplicated, Deprecated]
- 193 Add IsSmooth
SizeInCells
| Type | Default | |
|---|---|---|
| Vector3 | 1, 1, 1 | |
Returns a Vector3 whose components indicate the number of terrain cells along each axis of the stored region. Each terrain cell occupies 4 studs in world space, so multiplying by 4 gives the region's world-space dimensions. The value is set when the region is captured by Terrain:CopyRegion() and cannot be changed afterward.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
History 6
- 731 Change Default of SizeInCells from to Vector3(1, 1, 1)
- 726 Change Default of SizeInCells from Vector3(1, 1, 1) to
- 553 Change Default of SizeInCells from to Vector3(1, 1, 1)
- 486 Change ThreadSafety of SizeInCells from ReadOnly to ReadSafe
- 462 Change ThreadSafety of SizeInCells from to ReadOnly
- 130 Add SizeInCells