Class
TerrainRegion
An object that stores a chunk of terrain voxel data, produced by
Terrain:CopyRegion() and consumed by Terrain:PasteRegion().
A TerrainRegion is a snapshot of Terrain retrieved from the
Terrain:CopyRegion() method. Can be later pasted into the Terrain
using Terrain:PasteRegion().
Properties 2#
IsSmoothboolean | The state of this property shows whether or not this TerrainRegion
contains smooth terrain.ReadSafeDeprecatedReadOnlyNotReplicated |
SizeInCellsVector3 | The size of this TerrainRegion in cells.ReadSafeReadOnlyNotReplicated |
IsSmooth: boolean#
ReadOnlyNotReplicatedDeprecatedReadSafeDeprecated
Deprecated. This item is a deprecated function of a legacy Terrain engine that
has been removed. Do not use it for new work.
The state of this property shows whether or not this TerrainRegion
contains smooth terrain.
SizeInCells: Vector3#
ReadOnlyNotReplicatedReadSafe
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.
Methods 1#
| ConvertToSmooth | Transforms the TerrainRegion so it can be used with smooth terrain.PluginSecurity securityDeprecated |
ConvertToSmooth(): ()#
DeprecatedPluginSecurity securityDeprecated
Deprecated. This item is a deprecated function of a legacy Terrain engine that
has been removed. Do not use it for new work.
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.
Returns
()
Inherited members#
Inherited from Instance 58
Properties (10)
Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId
Methods (39)
AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild