Open 3D Engine AzFramework API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Physics::CharacterNotifications Class Reference

Messages sent by character controllers. More...

#include <CharacterBus.h>

Inherits AZ::ComponentBus.

Public Types

template<class Bus >
using ConnectionPolicy = CharacterNotificationsConnectionPolicy< Bus >
 

Public Member Functions

virtual void OnCharacterActivated ([[maybe_unused]] const AZ::EntityId &entityId)
 
virtual void OnCharacterDeactivated ([[maybe_unused]] const AZ::EntityId &entityId)
 Notifies that the character controller has deactivated on an entity.
 

Detailed Description

Messages sent by character controllers.

Member Typedef Documentation

◆ ConnectionPolicy

template<class Bus >
using Physics::CharacterNotifications::ConnectionPolicy = CharacterNotificationsConnectionPolicy<Bus>

With this connection policy, CharacterNotifications::OnCharacterActivated and CharacterNotifications::OnCharacterDeactivated events will be immediately dispatched when a handler connects to the bus.

Member Function Documentation

◆ OnCharacterActivated()

virtual void Physics::CharacterNotifications::OnCharacterActivated ( [[maybe_unused] ] const AZ::EntityId &  entityId)
inlinevirtual

Notifies that the character controller has activated on an entity. Other components that depend on the character controller can't simply rely on the component service dependencies because the character controller is activated at OnEntityActivated, after the components' activation.


The documentation for this class was generated from the following file: