Class: ChunkPipeline
Constructors
constructor
• new ChunkPipeline(): ChunkPipeline
Returns
Accessors
loadedCount
• get loadedCount(): number
Returns
number
processingCount
• get processingCount(): number
Returns
number
requestedCount
• get requestedCount(): number
Returns
number
totalCount
• get totalCount(): number
Returns
number
Methods
forEach
▸ forEach(stage, callback): void
Parameters
| Name | Type |
|---|---|
stage | "requested" | "processing" | "loaded" |
callback | (name: string) => void |
Returns
void
forEachLoaded
▸ forEachLoaded(callback): void
Parameters
| Name | Type |
|---|---|
callback | (chunk: Chunk, name: string) => void |
Returns
void
getInStage
▸ getInStage(stage): Set<string>
Parameters
| Name | Type |
|---|---|
stage | "requested" | "processing" | "loaded" |
Returns
Set<string>
getLoadedChunk
▸ getLoadedChunk(name): Chunk
Parameters
| Name | Type |
|---|---|
name | string |
Returns
getProcessingData
▸ getProcessingData(name): Object
Parameters
| Name | Type |
|---|---|
name | string |
Returns
Object
| Name | Type |
|---|---|
data | ChunkProtocol |
source | "load" | "update" |
getStage
▸ getStage(name): "requested" | "processing" | "loaded"
Parameters
| Name | Type |
|---|---|
name | string |
Returns
"requested" | "processing" | "loaded"
isInStage
▸ isInStage(name, stage): boolean
Parameters
| Name | Type |
|---|---|
name | string |
stage | "requested" | "processing" | "loaded" |
Returns
boolean
isRequestStale
▸ isRequestStale(name, staleAfterMs): boolean
Whether a request has gone unanswered long enough to be presumed lost. Measured in elapsed time rather than in world updates, so a chunk asks again on schedule however slowly the client happens to be running.
Parameters
| Name | Type |
|---|---|
name | string |
staleAfterMs | number |
Returns
boolean
markLoaded
▸ markLoaded(coords, chunk): void
Parameters
| Name | Type |
|---|---|
coords | Coords2 |
chunk | Chunk |
Returns
void
markProcessing
▸ markProcessing(coords, source, data): void
Parameters
| Name | Type |
|---|---|
coords | Coords2 |
source | "load" | "update" |
data | ChunkProtocol |
Returns
void
markRequested
▸ markRequested(coords): void
Parameters
| Name | Type |
|---|---|
coords | Coords2 |
Returns
void
remove
▸ remove(name): Chunk
Parameters
| Name | Type |
|---|---|
name | string |
Returns
resyncForRejoin
▸ resyncForRejoin(): string[]
Returns
string[]