Class CollisionDebug

CollisionDebug-Component

Attach this to a GraphicsEngine entity to debug/observe collisions.

This is for debugging/utility only. Keep in mind that it puts additional load on the calculations.

Hierarchy

Component
- CollisionDebug

Implements

CollisionEngineDebugDrawer

Index

Constructors

constructor

new CollisionDebug(): CollisionDebug
Returns CollisionDebug
Inherited from Component.constructor
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Component.ts:85

Properties

`Private` _debugLayer

_debugLayer: RenderElement

`Private` _engine

_engine: CollisionEngine = null

`Private` _limitReached

_limitReached: boolean = false

`Private` drawLimit

drawLimit: number

entity

entity: Entity = null

`Private` gfx

gfx: GraphicsEngine

`Private` poolQuads

poolQuads: QuadElement[] = []

`Private` poolQuadsUsed

poolQuadsUsed: number = 0

`Private` printLimitWarning

printLimitWarning: boolean

Accessors

Methods

createComponentRef

createComponentRef<T>(cmpName: string, activesOnly?: boolean, entityName?: string): ComponentRef<T>
A reference to another entity's component.

It'll internally search the current world for the given entity + component and keep and check the reference.

The idea is to keep the reference as a variable. This avoids ugly search code in the component space.
Type Parameters
- T extends Component<T>
Parameters
- cmpName: string
- Optional activesOnly: boolean
- Optional entityName: string
Returns ComponentRef<T>
Inherited from Component.createComponentRef
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Component.ts:133

drawLine

drawLine(x: number, y: number, x2: number, y2: number, c: Color): void
Parameters
- x: number
- y: number
- x2: number
- y2: number
- c: Color
Returns void
Implementation of CollisionEngineDebugDrawer.drawLine
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/runtime/CollisionDebug.ts:89

drawPoint

drawPoint(x: number, y: number, c: Color): void
Parameters
- x: number
- y: number
- c: Color
Returns void
Implementation of CollisionEngineDebugDrawer.drawPoint
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/runtime/CollisionDebug.ts:100

findComponent

findComponent(cmpName: any): any
Finds a component within this entitiy.
Parameters
- cmpName: any
  
  Class-Name of the component
Returns any
Inherited from Component.findComponent
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Component.ts:163

`Private` getQuad

getQuad(): QuadElement
Returns QuadElement
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/runtime/CollisionDebug.ts:70

onActivate

onActivate(): void
Returns void
Inherited from Component.onActivate
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Component.ts:177

onDeactivate

onDeactivate(): void
Returns void
Inherited from Component.onDeactivate
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Component.ts:183

onDispose

onDispose(): void
Returns void
Inherited from Component.onDispose
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Component.ts:186

onInit

onInit(): void
Returns void
Overrides Component.onInit
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/runtime/CollisionDebug.ts:38

onRender

onRender(elapsed: number): void
Overwrite this if you need to listen to render events.

It only works if you also register the outer entity to receive render events:
```
onInit() {
    this.world.requestRenderEvents(this.entity); // REQUIRED!!
}
```
Parameters
- elapsed: number
Returns void
Overrides Component.onRender
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/runtime/CollisionDebug.ts:58

onUpdate

onUpdate(elapsed: number): void
Parameters
- elapsed: number
Returns void
Inherited from Component.onUpdate
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Component.ts:180

requireComponent

requireComponent<T>(cmpType: string): T
Type Parameters
- T extends Component<T>
Parameters
- cmpType: string
Returns T
Inherited from Component.requireComponent
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Component.ts:110

requireProperty

requireProperty<T>(propName: string): T
Type Parameters
- T
Parameters
- propName: string
Returns T
Inherited from Component.requireProperty
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Component.ts:94

requireResource

requireResource<T>(resourceName: string, urlProp: string): T
Type Parameters
- T
Parameters
- resourceName: string
- urlProp: string
Returns T
Inherited from Component.requireResource
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Component.ts:102

sendMessageToActive

sendMessageToActive(name: string, params?: any): void
Send a message to all active entities
Parameters
- name: string
- Optional params: any
Returns void
Inherited from Component.sendMessageToActive
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Component.ts:144

sendMessageToAll

sendMessageToAll(name: string, params: any): void
Send a message to all entities.

This should be used with caution as there may be thousends of entities to crawl.
Parameters
- name: string
- params: any
Returns void
Inherited from Component.sendMessageToAll
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Component.ts:154

sendMessageToEntity

sendMessageToEntity(name: string, params?: any): any
Send a message to all entity components
Parameters
- name: string
- Optional params: any
Returns any
Inherited from Component.sendMessageToEntity
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Component.ts:139

Class CollisionDebug

CollisionDebug-Component

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns CollisionDebug

Properties

Private _debugLayer

Private _engine

Private _limitReached

Private drawLimit

entity

Private gfx

Private poolQuads

Private poolQuadsUsed

Private printLimitWarning

Accessors

debugLayer

Returns RenderElement

engine

Returns CollisionEngine

Parameters

v: CollisionEngine

Returns void

world

Returns World

Methods

createComponentRef

Type Parameters

T extends Component<T>

Parameters

cmpName: string

Optional activesOnly: boolean

Optional entityName: string

Returns ComponentRef<T>

drawLine

Parameters

x: number

y: number

x2: number

y2: number

c: Color

Returns void

drawPoint

Parameters

x: number

y: number

c: Color

Returns void

findComponent

Parameters

cmpName: any

Returns any

Private getQuad

Returns QuadElement

onActivate

Returns void

onDeactivate

Returns void

onDispose

Returns void

onInit

Returns void

onRender

Parameters

elapsed: number

Returns void

onUpdate

Parameters

elapsed: number

Returns void

requireComponent

Type Parameters

T extends Component<T>

`Private` _debugLayer

`Private` _engine

`Private` _limitReached

`Private` drawLimit

`Private` gfx

`Private` poolQuads

`Private` poolQuadsUsed

`Private` printLimitWarning

`Optional` activesOnly: boolean

`Optional` entityName: string

`Private` getQuad

`Optional` params: any

`Optional` params: any