Reference API Roblox

Engine API

Website

Related

Reference API Roblox

TerrainRegion

Memory categoryInstances

Member index 10

HistoryMember
553IsSmooth: bool
553SizeInCells: Vector3
573ApplyTransform(rotation: CFrame, size: Vector3): null
582ApplyTransformSubregion(rotation: CFrame, size: Vector3, region: Region3int16): TerrainRegion
573ConvertToSmooth(): null
569GetRegionWireframe(): Array
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

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 24

Members 10

ApplyTransform

Parameters (2)
rotationCFrame
sizeVector3
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 4

ApplyTransformSubregion

Parameters (3)
rotationCFrame
sizeVector3
regionRegion3int16
Returns (1)
TerrainRegion
SecurityRobloxScriptSecurity
Thread safetyUnsafe

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.

This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
SecurityPluginSecurity
Thread safetyUnsafe

History 4

Tags: [Deprecated]

GetRegionWireframe

Parameters (0)
No parameters.
Returns (1)
Array
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

IsSmooth

TypeDefault
booltrue

The state of this property shows whether or not this TerrainRegion contains smooth terrain.

This property is deprecated. It exists only for backward compatibility, and should not be used for new work.
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryData
Loaded/Savedfalse

History 5

Tags: [ReadOnly, NotReplicated, Deprecated]

SizeInCells

TypeDefault
Vector31, 1, 1

The size of this TerrainRegion in cells.

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryData
Loaded/Savedfalse

History 4

Tags: [ReadOnly, NotReplicated]

Settings