mirror of
https://github.com/rojo-rbx/rojo.git
synced 2026-10-23 14:01:37 +00:00
92 lines
2.5 KiB
YAML
92 lines
2.5 KiB
YAML
# This file is automatically generated. Please don't edit it manually.
|
|
# To submit a bug report on the content, see
|
|
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
|
|
|
|
name: TerrainRegion
|
|
type: class
|
|
memory_category: Instances
|
|
summary: ''
|
|
description: |
|
|
A TerrainRegion is a snapshot of `Class.Terrain` retrieved from the
|
|
`Class.Terrain:CopyRegion()` method. Can be later pasted into the Terrain
|
|
using `Class.Terrain:PasteRegion()`.
|
|
code_samples: []
|
|
inherits:
|
|
- Instance
|
|
descendants: []
|
|
tags: []
|
|
deprecation_message: ''
|
|
properties:
|
|
- name: TerrainRegion.IsSmooth
|
|
summary: |
|
|
The state of this property shows whether or not this `Class.TerrainRegion`
|
|
contains _smooth terrain_.
|
|
description: |
|
|
The state of this property shows whether or not this `Class.TerrainRegion`
|
|
contains _smooth terrain_.
|
|
code_samples: []
|
|
type: boolean
|
|
tags:
|
|
- ReadOnly
|
|
- NotReplicated
|
|
- Deprecated
|
|
deprecation_message: |
|
|
This item is a deprecated function of a legacy `Class.Terrain` engine that
|
|
has been removed. Do not use it for new work.
|
|
security:
|
|
read: None
|
|
write: None
|
|
thread_safety: ReadSafe
|
|
category: Data
|
|
serialization:
|
|
can_load: false
|
|
can_save: false
|
|
capabilities:
|
|
- Environment
|
|
- name: TerrainRegion.SizeInCells
|
|
summary: |
|
|
The size of this TerrainRegion in cells.
|
|
description: |
|
|
The size of this TerrainRegion in cells.
|
|
code_samples: []
|
|
type: Vector3
|
|
tags:
|
|
- ReadOnly
|
|
- NotReplicated
|
|
deprecation_message: ''
|
|
security:
|
|
read: None
|
|
write: None
|
|
thread_safety: ReadSafe
|
|
category: Data
|
|
serialization:
|
|
can_load: false
|
|
can_save: false
|
|
capabilities:
|
|
- Environment
|
|
methods:
|
|
- name: TerrainRegion:ConvertToSmooth
|
|
summary: |
|
|
Transforms the TerrainRegion so it can be used with smooth terrain.
|
|
description: |
|
|
Calling this method transforms the TerrainRegion into a
|
|
`Class.TerrainRegion` usable for `Class.Terrain`. This can only be done
|
|
from a plugin, when in edit mode.
|
|
|
|
The game can't be running, nor can it have a `Class.NetworkServer`.
|
|
code_samples: []
|
|
parameters: []
|
|
returns:
|
|
- type: ()
|
|
summary: ''
|
|
tags:
|
|
- Deprecated
|
|
deprecation_message: |
|
|
This item is a deprecated function of a legacy `Class.Terrain` engine that
|
|
has been removed. Do not use it for new work.
|
|
security: PluginSecurity
|
|
thread_safety: Unsafe
|
|
capabilities:
|
|
- Environment
|
|
events: []
|
|
callbacks: []
|