Class CollisionComponent

Hierarchy

Component
- CollisionComponent

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new CollisionComponent(data: CollisionComponentData): CollisionComponent

Overrides Component.constructor
- Defined in components/collisioncomponent.ts:41
Class constructor.

Parameters
- data: CollisionComponentData
Returns CollisionComponent

Properties

Protected _data

_data: IComponentData

Protected _owner

_owner: undefined | Entity

Private _shape

_shape: IShape2D

Private _static

_static: boolean

name

name: string

Accessors

isStatic

get isStatic(): boolean
set isStatic(value: boolean): void

- Defined in components/collisioncomponent.ts:27
Checks if the object is static. Will not be included in collisions if the object is static.

Returns boolean
boolean
- Defined in components/collisioncomponent.ts:34
Sets the object to static or not.

Parameters
- value: boolean
Returns void
boolean

owner

get owner(): undefined | Entity

Inherited from Component.owner
- Defined in components/component.ts:13
Gets the owner of the component.

Returns undefined | Entity
Entity

shape

get shape(): IShape2D

- Defined in components/collisioncomponent.ts:19
Gets the collision shape.

Returns IShape2D
IShape2D

Methods

destroy

destroy(): void

Inherited from Component.destroy
- Defined in components/component.ts:28
Destroys the component.

Returns void
void

load

load(): void

Overrides Component.load
- Defined in components/collisioncomponent.ts:50
Loads the collision component.

Returns void
void

onCollisionEntry

onCollisionEntry(other: CollisionComponent): void

- Defined in components/collisioncomponent.ts:79
Handler for collision entry.

Parameters
- other: CollisionComponent
Returns void
void

onCollisionExit

onCollisionExit(other: CollisionComponent): void

- Defined in components/collisioncomponent.ts:96
Handler for the collision exit.

Parameters
- other: CollisionComponent
Returns void
void

onCollisionUpdate

onCollisionUpdate(other: CollisionComponent): void

- Defined in components/collisioncomponent.ts:88
Handler for the collision update.

Parameters
- other: CollisionComponent
Returns void
void

render

render(shader: Shader): void

Overrides Component.render
- Defined in components/collisioncomponent.ts:61
Renders the collision component.

Parameters
- shader: Shader
Returns void
void

setOwner

setOwner(owner: Entity): void

Inherited from Component.setOwner
- Defined in components/component.ts:51
Sets the owner as the entity given.

Parameters
- owner: Entity
Returns void
void

update

update(delta: number): void

Overrides Component.update
- Defined in components/collisioncomponent.ts:69
Updates the collision component.

Parameters
- delta: number
Returns void
void

updateReady

updateReady(): void

Inherited from Component.updateReady
- Defined in components/component.ts:66
Gets if the update is ready.

Returns void
void

Generated using TypeDoc