m (Bot Edit: Removing count of members.) |
m (→top: Add Template:Missing API Documentation (automatic)) |
||
(4 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
+ | {{Missing API Documentation}} |
||
− | {{Infobox class |
+ | {{Infobox class}} |
− | | explorer order = 0 |
||
− | | tags = notCreatable}} |
||
Object representing a high performance bounded grid of static 4x4 parts. This class cannot be [[instantiated]]. |
Object representing a high performance bounded grid of static 4x4 parts. This class cannot be [[instantiated]]. |
||
+ | {{Member list}} |
||
− | == Properties == |
||
+ | == External links == |
||
+ | * {{DevHub class link}} |
||
− | |||
+ | * {{Roblox API Reference class link}} |
||
− | === {{property|readonly|name=IsSmooth|type=bool|deprecated}} === |
||
− | |||
− | Returns whether or not this game has smooth terrain. Flat terrain was removed in January 2017, so this is always true. |
||
− | |||
− | === {{property|readonly|name=MaxExtents|type=Region3int16}} === |
||
− | |||
− | === {{property|name=WaterColor|type=Color3}} === |
||
− | |||
− | The color of the [[Water]] material. |
||
− | |||
− | === {{property|name=WaterReflectance|type=float}} === |
||
− | |||
− | The reflectance of the [[Water]] material. |
||
− | |||
− | === {{property|name=WaterTransparency|type=float}} === |
||
− | |||
− | The transparency of the [[Water]] material. |
||
− | |||
− | === {{property|name=WaterWaveSize|type=float}} === |
||
− | |||
− | The maximum size [[Water]] waves can be. |
||
− | |||
− | === {{property|name=WaterWaveSpeed|type=float}} === |
||
− | |||
− | The speed of the [[Water]] material. |
||
− | |||
− | == Methods == |
||
− | |||
− | |||
− | |||
− | === {{method|deprecated|bool|name=AutowedgeCell|int x|int y|int z}} === |
||
− | |||
− | === {{method|deprecated|void|name=AutowedgeCells|Region3int16 region}} === |
||
− | |||
− | === {{method|Vector3|name=CellCenterToWorld|int x|int y|int z}} === |
||
− | |||
− | === {{method|Vector3|name=CellCornerToWorld|int x|int y|int z}} === |
||
− | |||
− | === {{method|void|name=Clear}} === |
||
− | |||
− | Removes all smooth terrain from the game. |
||
− | |||
− | === {{method|PluginSecurity|void|name=ConvertToSmooth|deprecated}} === |
||
− | |||
− | Converts the game from flat to smooth terrain. |
||
− | |||
− | === {{method|Instance|name=CopyRegion|Region3int16 region}} === |
||
− | |||
− | Copies the given region and returns a {{Class link|TerrainRegion}}. |
||
− | |||
− | === {{method|int|name=CountCells}} === |
||
− | |||
− | Counts the amount of terrain cells. |
||
− | |||
− | === {{method|void|name=FillBall|Vector3 center|float radius|Material material}} === |
||
− | |||
− | Creates a ball of terrain that reaches out from the given center point. |
||
− | |||
− | === {{method|void|name=FillBlock|CoordinateFrame cframe|Vector3 size|Material material}} === |
||
− | |||
− | Creates a block of terrain from the given CoordinateFrame and goes out by size. |
||
− | |||
− | === {{method|void|name=FillRegion|Region3 region|float resolution|Material material}} === |
||
− | |||
− | Fills a region with the given material. |
||
− | |||
− | === {{method|deprecated|Tuple|name=GetCell|int x|int y|int z}} === |
||
− | |||
− | Returns CellMaterial, CellBlock, CellOrientation |
||
− | |||
− | === {{method|deprecated|Tuple|name=GetWaterCell|int x|int y|int z}} === |
||
− | |||
− | Returns hasAnyWater, WaterForce, WaterDirection |
||
− | |||
− | === {{method|void|name=PasteRegion|Instance region|Vector3int16 corner|bool pasteEmptyCells}} === |
||
− | |||
− | Pastes the given {{Class link|TerrainRegion}}, with the corner being a corner. |
||
− | |||
− | === {{method|Tuple|name=ReadVoxels|Region3 region|float resolution}} === |
||
− | |||
− | === {{method|deprecated|void|name=SetCell|int x|int y|int z|CellMaterial material|CellBlock block|CellOrientation orientation}} === |
||
− | |||
− | === {{method|deprecated|void|name=SetCells|Region3int16 region|CellMaterial material|CellBlock block|CellOrientation orientation}} === |
||
− | |||
− | === {{method|deprecated|void|name=SetWaterCell|int x|int y|int z|WaterForce force|WaterDirection direction}} === |
||
− | |||
− | |||
− | |||
− | === {{method|Vector3|name=WorldToCell|Vector3 position}} === |
||
− | |||
− | === {{method|Vector3|name=WorldToCellPreferEmpty|Vector3 position}} === |
||
− | |||
− | === {{method|Vector3|name=WorldToCellPreferSolid|Vector3 position}} === |
||
− | |||
− | === {{method|void|name=WriteVoxels|Region3 region|float resolution|Array materials|Array occupancy}} === |
Latest revision as of 03:02, 23 June 2023
Missing API Documentation
This API Class does not have any or complete API documentation. Please add API documentation if possible.
Object representing a high performance bounded grid of static 4x4 parts. This class cannot be instantiated.
Properties
LastUsedModificationMethod: TerrainAcquisitionMethod
- Category: Data.
- Read security: RobloxScriptSecurity.
- Write security: RobloxScriptSecurity.
- Serialization: cannot load or save.
- Thread safety: read safe
MaterialColors: BinaryString
- Category: Appearance.
- Serialization: can save and load.
- Thread safety: read safe
MaxExtents: Region3int16
- Category: Data.
- Serialization: cannot load or save.
- Thread safety: read safe
ShorelinesUpgraded: bool
- Category: Appearance.
- Read security: RobloxScriptSecurity.
- Write security: RobloxScriptSecurity.
- Serialization: can save and load.
- Thread safety: read safe
SmoothVoxelsUpgraded: bool
- Category: Appearance.
- Read security: RobloxScriptSecurity.
- Write security: RobloxScriptSecurity.
- Serialization: can save and load.
- Thread safety: read safe
WaterColor: Color3
- Category: Appearance.
- Serialization: can save and load.
- Thread safety: read safe
WaterReflectance: float
- Category: Appearance.
- Serialization: can save and load.
- Thread safety: read safe
WaterTransparency: float
- Category: Appearance.
- Serialization: can save and load.
- Thread safety: read safe
WaterWaveSize: float
- Category: Appearance.
- Serialization: can save and load.
- Thread safety: read safe
WaterWaveSpeed: float
- Category: Appearance.
- Serialization: can save and load.
- Thread safety: read safe
Methods
AutowedgeCells(region: Region3int16): null
Name | Type |
---|---|
region | Region3int16 |
- Thread safety: unsafe
CanShorelinesBeUpgraded(): bool
- Security: RobloxScriptSecurity.
- Thread safety: unsafe
CanSmoothVoxelsBeUpgraded(): bool
- Security: RobloxScriptSecurity.
- Thread safety: unsafe
CellCenterToWorld(x: int, y: int, z: int): Vector3
Name | Type |
---|---|
x | int |
y | int |
z | int |
- Thread safety: unsafe
CellCornerToWorld(x: int, y: int, z: int): Vector3
Name | Type |
---|---|
x | int |
y | int |
z | int |
- Thread safety: unsafe
ConvertToSmooth(): null
Was previously used to convert legacy terrain to smooth terrain technology. This method no longer does anything when called because legacy terrain has been removed.
- Security: PluginSecurity.
- Thread safety: unsafe
CopyRegion(region: Region3int16): TerrainRegion
Name | Type |
---|---|
region | Region3int16 |
- Thread safety: unsafe
CountCells(): int
- Thread safety: unsafe
FillBall(center: Vector3, radius: float, material: Material): null
Name | Type |
---|---|
center | Vector3 |
radius | float |
material | Material |
- Thread safety: unsafe
FillBlock(cframe: CFrame, size: Vector3, material: Material): null
Name | Type |
---|---|
cframe | CFrame |
size | Vector3 |
material | Material |
- Thread safety: unsafe
FillCylinder(cframe: CFrame, height: float, radius: float, material: Material): null
Name | Type |
---|---|
cframe | CFrame |
height | float |
radius | float |
material | Material |
- Thread safety: unsafe
FillRegion(region: Region3, resolution: float, material: Material): null
Name | Type |
---|---|
region | Region3 |
resolution | float |
material | Material |
- Thread safety: unsafe
FillWedge(cframe: CFrame, size: Vector3, material: Material): null
Name | Type |
---|---|
cframe | CFrame |
size | Vector3 |
material | Material |
- Thread safety: unsafe
GetTerrainWireframe(cframe: CFrame, size: Vector3): Array
Name | Type |
---|---|
cframe | CFrame |
size | Vector3 |
- Security: RobloxScriptSecurity.
- Thread safety: unsafe
PasteRegion(region: TerrainRegion, corner: Vector3int16, pasteEmptyCells: bool): null
Name | Type |
---|---|
region | TerrainRegion |
corner | Vector3int16 |
pasteEmptyCells | bool |
- Thread safety: unsafe
ReadVoxels(region: Region3, resolution: float): Tuple
Name | Type |
---|---|
region | Region3 |
resolution | float |
- Thread safety: safe
ReplaceMaterial(region: Region3, resolution: float, sourceMaterial: Material, targetMaterial: Material): null
Name | Type |
---|---|
region | Region3 |
resolution | float |
sourceMaterial | Material |
targetMaterial | Material |
- Thread safety: unsafe
ReplaceMaterialInTransform(cframe: CFrame, size: Vector3, sourceMaterial: Material, targetMaterial: Material): null
Name | Type |
---|---|
cframe | CFrame |
size | Vector3 |
sourceMaterial | Material |
targetMaterial | Material |
- Security: RobloxScriptSecurity.
- Thread safety: unsafe
ReplaceMaterialInTransformSubregion(cframe: CFrame, size: Vector3, sourceMaterial: Material, targetMaterial: Material, targetRegion: Region3int16): null
Name | Type |
---|---|
cframe | CFrame |
size | Vector3 |
sourceMaterial | Material |
targetMaterial | Material |
targetRegion | Region3int16 |
- Security: RobloxScriptSecurity.
- Thread safety: unsafe
SetCell(x: int, y: int, z: int, material: CellMaterial, block: CellBlock, orientation: CellOrientation): null
Name | Type |
---|---|
x | int |
y | int |
z | int |
material | CellMaterial |
block | CellBlock |
orientation | CellOrientation |
- Thread safety: unsafe
SetCells(region: Region3int16, material: CellMaterial, block: CellBlock, orientation: CellOrientation): null
Name | Type |
---|---|
region | Region3int16 |
material | CellMaterial |
block | CellBlock |
orientation | CellOrientation |
- Thread safety: unsafe
SetMaterialColor(material: Material, value: Color3): null
Name | Type |
---|---|
material | Material |
value | Color3 |
- Thread safety: unsafe
SetMaterialInTransform(cframe: CFrame, size: Vector3, targetMaterial: Material): null
Name | Type |
---|---|
cframe | CFrame |
size | Vector3 |
targetMaterial | Material |
- Security: RobloxScriptSecurity.
- Thread safety: unsafe
SetMaterialInTransformSubregion(cframe: CFrame, size: Vector3, targetMaterial: Material, targetRegion: Region3int16): null
Name | Type |
---|---|
cframe | CFrame |
size | Vector3 |
targetMaterial | Material |
targetRegion | Region3int16 |
- Security: RobloxScriptSecurity.
- Thread safety: unsafe
SetWaterCell(x: int, y: int, z: int, force: WaterForce, direction: WaterDirection): null
Name | Type |
---|---|
x | int |
y | int |
z | int |
force | WaterForce |
direction | WaterDirection |
- Thread safety: unsafe
SmoothRegion(region: Region3, resolution: float, strength: float): Tuple
Name | Type |
---|---|
region | Region3 |
resolution | float |
strength | float |
- Security: RobloxScriptSecurity.
- Thread safety: safe
WorldToCellPreferEmpty(position: Vector3): Vector3
Name | Type |
---|---|
position | Vector3 |
- Thread safety: unsafe
WorldToCellPreferSolid(position: Vector3): Vector3
Name | Type |
---|---|
position | Vector3 |
- Thread safety: unsafe
WriteVoxels(region: Region3, resolution: float, materials: Array, occupancy: Array): null
Name | Type |
---|---|
region | Region3 |
resolution | float |
materials | Array |
occupancy | Array |
- Thread safety: unsafe
Removed members
Methods
Properties
Events
External links
- Terrain in the Roblox Creator Documentation
- Terrain in the Roblox API Reference