Class Patrol

Moves an entity back and forth between patrol points.

Hierarchy (View Summary)

Component
- Patrol

Index

Constructors

Properties

Methods

getCurrentIndex onAttach onDetach reset reverse setSpeed update

Constructors

constructor

new Patrol(points: PatrolPoint[], speed?: number, loop?: boolean): Patrol
Parameters
- points: PatrolPoint[]
- speed: number = 100
- loop: boolean = true
Returns Patrol
Overrides Component.constructor
- Defined in packages/clik-engine/src/entity/components/Patrol.ts:21

Properties

enabled

enabled: boolean = true

entity

entity: Entity

Methods

getCurrentIndex

getCurrentIndex(): number
Get current patrol index

Returns number
- Defined in packages/clik-engine/src/entity/components/Patrol.ts:87

onAttach

onAttach(): void
Called when the component is added to an entity

Returns void
Overrides Component.onAttach
- Defined in packages/clik-engine/src/entity/components/Patrol.ts:28

onDetach

onDetach(): void
Called when the component is removed or entity is destroyed

Returns void
Inherited from Component.onDetach
- Defined in packages/clik-engine/src/entity/Component.ts:14

reset

reset(): void
Called when the owning entity is recycled from a pool. Reset internal state to defaults.

Returns void
Inherited from Component.reset
- Defined in packages/clik-engine/src/entity/Component.ts:17

reverse

reverse(): void
Reverse patrol direction

Returns void
- Defined in packages/clik-engine/src/entity/components/Patrol.ts:92

setSpeed

setSpeed(speed: number): void
Parameters
- speed: number
Returns void
- Defined in packages/clik-engine/src/entity/components/Patrol.ts:96

update

update(delta: number): void
Called every frame
Parameters
- delta: number
Returns void
Overrides Component.update
- Defined in packages/clik-engine/src/entity/components/Patrol.ts:35