Open 3D Engine ROS2 Gem API Reference 25.05.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
ROS2::SpawnerNotifications Class Reference

Inherits AZ::EBusTraits.

Public Member Functions

 AZ_RTTI (SpawnerNotifications, "{0D22B024-48C7-457C-BFFB-D292045B68EC}")
 
virtual void OnSpawned (const AZStd::string &spawnableName, const AZ::EntityId &rootEntity, const AZStd::string &ticketName)
 
virtual void OnDespawned (const AZStd::string &ticketName)
 

Static Public Attributes

static constexpr AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Multiple
 
static constexpr AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::Single
 

Member Function Documentation

◆ OnDespawned()

virtual void ROS2::SpawnerNotifications::OnDespawned ( const AZStd::string &  ticketName)
inlinevirtual

Notifies that despawn operation was completed.

Parameters
ticketNamename of the ticket that was used to despawn the entity.

◆ OnSpawned()

virtual void ROS2::SpawnerNotifications::OnSpawned ( const AZStd::string &  spawnableName,
const AZ::EntityId &  rootEntity,
const AZStd::string &  ticketName 
)
inlinevirtual

Notifies that spawn operation was completed.

Parameters
spawnableNamename of the spawnable that was spawned.
rootEntityroot entity of the spawned spawnable.
ticketNamename of the ticket that was used to spawn the entity.

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