Class Rigidbody

The rigidbody component is used to apply forces to an entity and detect collisions.

Hierarchy

Component
- Rigidbody

Index

Constructors

constructor

Properties

Accessors

id

Methods

Constructors

constructor

new Rigidbody(): Rigidbody

Inherited from Component.constructor
- Defined in entity/components/component.ts:23
Construct a new component.

Returns Rigidbody

Properties

acceleration

acceleration: Vector2 = ...

The rigidbody acceleration.

enabled

enabled: boolean

Is the component enabled.

entity

entity: Entity

Entity that this component is attached to.

friction

friction: number = 1

Friction of the rigidbody.

useGravity

useGravity: boolean = true

Gravity should be applied to the rigidbody.

velocity

velocity: Vector2 = ...

The rigidbody velocity.

Accessors

id

get id(): string

Inherited from Component.id
- Defined in entity/components/component.ts:31
Returns the component id.

Returns string
The component id.

Methods

addForce

addForce(force: Vector2): void

- Defined in entity/components/rigidbody.ts:32
Add force to the rigidbody.

Parameters
- force: Vector2
  
  The force to apply.
Returns void

awake

awake(): void

Inherited from Component.awake
- Defined in entity/components/component.ts:38
Awake.

Returns void

lateUpdate

lateUpdate(): void

Inherited from Component.lateUpdate
- Defined in entity/components/component.ts:53
Late update.

Returns void

start

start(): void

Inherited from Component.start
- Defined in entity/components/component.ts:43
Start.

Returns void

update

update(): void

Inherited from Component.update
- Defined in entity/components/component.ts:48
Update.

Returns void

Generated using TypeDoc