Class NapeList<T>

Generic typed wrapper around Haxe list objects (BodyList, ShapeList, etc.).

Provides a modern iterable interface with for...of, length, at(), etc.

Deprecated

The engine's list getters (e.g. body.shapes) now return the cached typed list directly; this wrapper is kept for backwards compatibility only and allocates on every construction.

Type Parameters

Implements

Iterable<T>

Index

Accessors

empty length

Methods

[iterator] add at clear forEach has pop push remove shift toArray toString unshift

Accessors

empty

get empty(): boolean
Whether the list is empty.

Returns boolean
- Defined in packages/nape-js/src/util/NapeList.ts:56

length

get length(): number
Number of elements in the list.

Returns number
- Defined in packages/nape-js/src/util/NapeList.ts:26

Methods

[iterator]

"[iterator]"(): Iterator<T>
Iterate over all elements.

Returns Iterator<T>
Implementation of Iterable.[iterator]
- Defined in packages/nape-js/src/util/NapeList.ts:81

add

add(item: T & { _inner?: any }): void
Add an element to the list.
Parameters
- item: T & { _inner?: any }
Returns void
- Defined in packages/nape-js/src/util/NapeList.ts:36

at

at(index: number): T
Get element at index.
Parameters
- index: number
Returns T
- Defined in packages/nape-js/src/util/NapeList.ts:31

clear

clear(): void
Remove all elements.

Returns void
- Defined in packages/nape-js/src/util/NapeList.ts:51

forEach

forEach(fn: (item: T, index: number) => void): void
Apply a function to each element.
Parameters
- fn: (item: T, index: number) => void
Returns void
- Defined in packages/nape-js/src/util/NapeList.ts:93

has

has(item: T & { _inner?: any }): boolean
Check if the list contains an element.
Parameters
- item: T & { _inner?: any }
Returns boolean
- Defined in packages/nape-js/src/util/NapeList.ts:46

pop

pop(): T
Pop the last element.

Returns T
- Defined in packages/nape-js/src/util/NapeList.ts:66

push

push(item: T & { _inner?: any }): void
Push an element to the end.
Parameters
- item: T & { _inner?: any }
Returns void
- Defined in packages/nape-js/src/util/NapeList.ts:61

remove

remove(item: T & { _inner?: any }): void
Remove an element from the list.
Parameters
- item: T & { _inner?: any }
Returns void
- Defined in packages/nape-js/src/util/NapeList.ts:41

shift

shift(): T
Shift the first element.

Returns T
- Defined in packages/nape-js/src/util/NapeList.ts:71

toArray

toArray(): T[]
Convert to a plain array.

Returns T[]
- Defined in packages/nape-js/src/util/NapeList.ts:88

toString

toString(): string
Returns a string representation of an object.

Returns string
- Defined in packages/nape-js/src/util/NapeList.ts:99

unshift

unshift(item: T & { _inner?: any }): void
Unshift an element to the front.
Parameters
- item: T & { _inner?: any }
Returns void
- Defined in packages/nape-js/src/util/NapeList.ts:76

Class NapeList<T>

Deprecated

Type Parameters

Implements

Index

Accessors

Methods

Accessors

empty

Returns boolean

length

Returns number

Methods

[iterator]

Returns Iterator<T>

add

Parameters

Returns void

at

Parameters

Returns T

clear

Returns void

forEach

Parameters

Returns void

has

Parameters

Returns boolean

pop

Returns T

push

Parameters

Returns void

remove

Parameters

Returns void

shift

Returns T

toArray

Returns T[]

toString

Returns string

unshift

Parameters

Returns void

Settings

On This Page