Class Rigidbody

Rigibodies are physics handlers for game objects that have colliders

Hierarchy (View Summary)

LogicBehavior<void>
- Rigidbody

Index

Constructors

Properties

data gameObject mass onDataChanged

Accessors

collider linearVelocity restitution

Methods

addForce detach notifyDataChanged onDisable onEnable resolveCollisionRigidCollider resolveCollisionRigidRigid resolveCollisions setup step tick

Constructors

constructor

new Rigidbody(
    collider: Collider,
    mass?: number,
    restitution?: number,
): Rigidbody
Parameters
- collider: Collider
- mass: number = 1
- restitution: number = 0.6
Returns Rigidbody
Overrides LogicBehavior.constructor
- Defined in Extensions/PhysicsEngine/Rigidbodies/Rigidbody.ts:36

Properties

`Protected`data

data: void

`Protected`gameObject

gameObject: GameObject

mass

mass: number

`Readonly`onDataChanged

onDataChanged: Event<void> = ...

Accessors

collider

get collider(): Collider
Returns Collider
- Defined in Extensions/PhysicsEngine/Rigidbodies/Rigidbody.ts:20

linearVelocity

get linearVelocity(): Vector2
Returns Vector2
- Defined in Extensions/PhysicsEngine/Rigidbodies/Rigidbody.ts:28
set linearVelocity(value: Vector2): void
Parameters
- value: Vector2
Returns void
- Defined in Extensions/PhysicsEngine/Rigidbodies/Rigidbody.ts:32

restitution

get restitution(): number
Returns number
- Defined in Extensions/PhysicsEngine/Rigidbodies/Rigidbody.ts:24

Methods

addForce

addForce(force: Vector2): void
Add to the instantaneous force of the collider
Parameters
- force: Vector2
Returns void
- Defined in Extensions/PhysicsEngine/Rigidbodies/Rigidbody.ts:107

detach

detach(from: GameObject): void
Detach this behavior from the GameObject it is attached to.
Parameters
- from: GameObject
  The GameObject to detach this behavior from.
Returns void
Throws
Error if the behavior is not attached to the GameObject.
Inherited from LogicBehavior.detach
- Defined in Core/Behavior.ts:27

`Protected`notifyDataChanged

notifyDataChanged(): void
Returns void
Inherited from LogicBehavior.notifyDataChanged
- Defined in Core/LogicBehavior.ts:25

`Protected`onDisable

onDisable(): void
Returns void
Inherited from LogicBehavior.onDisable
- Defined in Core/Behavior.ts:39

`Protected`onEnable

onEnable(): void
Returns void
Inherited from LogicBehavior.onEnable
- Defined in Core/Behavior.ts:35

resolveCollisionRigidCollider

resolveCollisionRigidCollider(collision: Collision): void
Resolve the collision by bouncing the rigidbody away from the collider
Parameters
- collision: Collision
Returns void
- Defined in Extensions/PhysicsEngine/Rigidbodies/Rigidbody.ts:68

resolveCollisionRigidRigid

resolveCollisionRigidRigid(collision: CollisionRigidbodies): void
Resolve the collision by shocking the game object (depending on the mass)
Parameters
- collision: CollisionRigidbodies
Returns void
- Defined in Extensions/PhysicsEngine/Rigidbodies/Rigidbody.ts:90

resolveCollisions

resolveCollisions(collisions: Collision[]): void
Resolve all the collisions
Parameters
- collisions: Collision[]
Returns void
- Defined in Extensions/PhysicsEngine/Rigidbodies/Rigidbody.ts:52

setup

setup(attachedOn: GameObject): void
Like onEnable, but should only be for internal use, so some non-abstact direct behaviors could expose attachedOn to the user. AT THE END OF THIS FUNCTION, WE EXPECT this.data to be filled (and not undefined). This isn't an assertion becaus we support T as void.
Parameters
- attachedOn: GameObject
  The GameObject this behavior is attached to.
Returns void
Throws
Error if the behavior is already attached to a GameObject.
Inherited from LogicBehavior.setup
- Defined in Core/LogicBehavior.ts:20

step

step(deltaTime: number, gravity: Vector2): void
Update the rigidbody movement props for one tick: velocity, forces, acceleration (time based)
Parameters
- deltaTime: number
- gravity: Vector2
Returns void
- Defined in Extensions/PhysicsEngine/Rigidbodies/Rigidbody.ts:116

`Protected`tick

tick(_deltaTime: number): void
Protected
Called every frame. Override this method to add custom behavior.
Parameters
- _deltaTime: number
  The time in seconds since the last frame.
  
  This method should not be called directly except by the GameEngineWindowComponent.
Returns void
Inherited from LogicBehavior.tick
- Defined in Core/Behavior.ts:48