TerrainJob
Tracks an asynchronous terrain-editing operation.
Behavior
TerrainJob tracks an asynchronous terrain-editing operation.
Summary
Members6
Properties3
The number of terrain cells changed by the operation.
The fraction of the operation completed.
The operation lifecycle state.
Methods2
Cancel(): ()Requests cancellation of the asynchronous operation.
Yields until the operation finishes and returns its final status.
Events1
Fires when the asynchronous operation finishes.
Properties
CellsChanged
TerrainJob.CellsChanged: numberThe number of terrain cells changed by the operation.
Progress
TerrainJob.Progress: numberThe fraction of the operation completed.
Status
TerrainJob.Status: Enum.TerrainJobStatusThe operation lifecycle state.
Methods
Cancel
TerrainJob:Cancel(): ()Requests cancellation of the asynchronous operation.
Wait
TerrainJob:Wait(): Enum.TerrainJobStatusYields until the operation finishes and returns its final status.
Events
Completed
TerrainJob.Completed: RBXScriptSignalFires when the asynchronous operation finishes.
Operators
__index · __tostring · __type