Class CachedArray<T>

Cached array is a data structure for objects cache, it's designed for persistent data. Its content array length will keep grow.

Type parameters

T

Hierarchy

CachedArray

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

newCachedArray(length: number, compareFn?: undefined | ((a: T, b: T) => number)): CachedArray

- Defined in cocos/core/memop/cached-array.ts:56
Parameters
- length: number
  
  Initial length
- Optional compareFn: undefined | ((a: T, b: T) => number)
  
  Comparison function for sorting
Returns CachedArray

Properties

Private _compareFn

_compareFn: any

array

array: T[]

The array which stores actual content

length

length: number = 0

The actual count of data object

Methods

clear

clear(): void

- Defined in cocos/core/memop/cached-array.ts:113
Clear the cache. The length will be set to 0, but the internal array will keep its size.

Returns void

concat

concat(array: T[]): void

- Defined in cocos/core/memop/cached-array.ts:146
Add all elements of a given array to the end of the current array

Parameters
- array: T[]
  
  The given array to be appended
Returns void

destroy

destroy(): void

- Defined in cocos/core/memop/cached-array.ts:123
Clear the cache. The length will be set to 0, and clear the internal array.

Returns void

fastRemove

fastRemove(idx: number): void

- Defined in cocos/core/memop/cached-array.ts:157
Delete the element at the specified location and move the last element to that location.

Parameters
- idx: number
  
  The index of the element to be deleted
Returns void

get

get(idx: number): T

- Defined in cocos/core/memop/cached-array.ts:103
Get the element at the specified index of the array

Parameters
- idx: number
  
  The index of the requested element
Returns T

The element at given index

indexOf

indexOf(val: T): number

- Defined in cocos/core/memop/cached-array.ts:170
Returns the first index at which a given element can be found in the array.

Parameters
- val: T
  
  The element
Returns number

pop

pop(): T | undefined

- Defined in cocos/core/memop/cached-array.ts:91
Pop the last element in the array. The length will reduce, but the internal array will keep its size.

Returns T | undefined

The last element.

push

push(item: T): void

- Defined in cocos/core/memop/cached-array.ts:80
Push an element to the end of the array

Parameters
- item: T
  
  The item to be added
Returns void

sort

sort(): void

- Defined in cocos/core/memop/cached-array.ts:134
Sort the existing elements in cache

Returns void

Generated using TypeDoc