Class Highlights

Entity highlights. Stores all highlights that are applied to entities.

Hierarchy (View Summary)

Subscribable<Highlights>
- Highlights

Implements

Iterable<Highlight>

Index

Accessors

empty length subscribed

Methods

[iterator] add at clear remove subscribe unsubscribe

Accessors

empty

get empty(): boolean
Whether there are any highlights.

Returns boolean

length

get length(): number
The number of highlights.

Returns number

subscribed

get subscribed(): boolean
Whether there are any subscribers.

Returns boolean
Inherited from Subscribable.subscribed

Methods

[iterator]

"[iterator]"(): Iterator<Highlight>
Iterator for highlights.

Returns Iterator<Highlight>
Implementation of Iterable.[iterator]

add

add(entity: Entity, color: Color): boolean
Adds a highlight.
Parameters
- entity: Entity
  The entity to be highlighted.
- color: Color
  The highlight color.
Returns boolean
True if the highlight was added, false otherwise.

at

at(index: number): Highlight
Retrieves the highlight at the specified index.
Parameters
- index: number
  The highlight index.
Returns Highlight
The highlight.

clear

clear(): void
Clears all highlights.

Returns void

remove

remove(entity: Entity, color?: undefined | Color): boolean
Removes a highlight.
Parameters
- entity: Entity
  The entity for the highlight.
- color: undefined | Color = undefined
  The color for the highlight.
Returns boolean
True if the highlight was removed, false otherwise.

subscribe(subscriber: Subscriber<Highlights>): void
Subscribes to be notified when an event occurs.
Parameters
- subscriber: Subscriber<Highlights>
  The callback function.
Returns void
Inherited from Subscribable.subscribe

unsubscribe

unsubscribe(callback: Subscriber<Highlights>): boolean
Unsubscribes.
Parameters
- callback: Subscriber<Highlights>
  The callback function.
Returns boolean
True if the subscription was canceled, false otherwise.

Inherited from Subscribable.unsubscribe