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

#include <TagComponentBus.h>

Inherits AZ::EBusTraits.

Classes

struct  ConnectionPolicy
 

Public Types

using BusIdType = Tag
 

Public Member Functions

virtual void OnEntityTagAdded (const AZ::EntityId &)=0
 
virtual void OnEntityTagRemoved (const AZ::EntityId &)=0
 

Static Public Attributes

static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::ById
 

Detailed Description

Use this bus if you want to know when the list of all entities with a given tag changes. When you connect to this bus it will fire your handler once for each entity already with this tag

Member Function Documentation

◆ OnEntityTagAdded()

virtual void LmbrCentral::TagGlobalNotifications::OnEntityTagAdded ( const AZ::EntityId &  )
pure virtual

When connecting to this bus, your OnEntityTagAdded handler will fire once for each entity that already has this tag. After initial connection you will be alerted when ever a new entity gains or loses the given tag

◆ OnEntityTagRemoved()

virtual void LmbrCentral::TagGlobalNotifications::OnEntityTagRemoved ( const AZ::EntityId &  )
pure virtual

You will be alerted when ever an entity with a given tag has that tag removed


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