Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Collider

Add this in your code:

#include <engine/physics/collider.h>

Description

Parent class of collider components (BoxCollider, SphereCollider...).

Function of Collider can be used on every colllider component.

Public methods


SetIsTrigger

Set if the collider is a trigger or not.
A trigger collider will not collide with other colliders, but will still generate collision events.

Parameters:

  • isTrigger: New isTrigger value
void SetIsTrigger(bool isTrigger)

Code sample:

std::shared_ptr<BoxColldier> boxCollider = GetGameObject()->AddComponent<BoxColldier>(); 
boxCollider->SetIsTrigger(true);

IsTrigger

Check if the collider is a trigger or not.

bool IsTrigger() const

Code sample:

std::shared_ptr<BoxColldier> boxCollider = GetGameObject()->AddComponent<BoxColldier>(); 
boxCollider->SetIsTrigger(true);
bool isTrigger = boxCollider->IsTrigger(); // = true

SetGenerateCollisionEvents

Set if the collider should generate collision events or not.

Parameters:

  • generateCollisionEvents: New generateCollisionEvents value
void SetGenerateCollisionEvents(bool generateCollisionEvents)

Code sample:

std::shared_ptr<BoxColldier> boxCollider = GetGameObject()->AddComponent<BoxColldier>(); 
boxCollider->SetGenerateCollisionEvents(true);

GetGenerateCollisionEvents

Check if the collider should generate collision events or not.

bool GetGenerateCollisionEvents() const

Code sample:

std::shared_ptr<BoxColldier> boxCollider = GetGameObject()->AddComponent<BoxColldier>(); 
boxCollider->SetGenerateCollisionEvents(true);
bool generateCollisionEvents = boxCollider->GetGenerateCollisionEvents(); // = true