AzFramework::CommandRegistration Class Reference

#include <CommandRegistrationBus.h>

Inherits AZ::EBusTraits.

Public Member Functions
virtual bool	RegisterCommand (AZStd::string_view identifier, AZStd::string_view helpText, AZ::u32 commandFlags, CommandFunction callback)=0
virtual bool	UnregisterCommand (AZStd::string_view identifier)=0

Static Public Attributes
static const AZ::EBusHandlerPolicy	HandlerPolicy = AZ::EBusHandlerPolicy::Single
static const AZ::EBusAddressPolicy	AddressPolicy = AZ::EBusAddressPolicy::Single

Detailed Description

A command registration system to register console commands

Member Function Documentation

RegisterCommand()

virtual bool AzFramework::CommandRegistration::RegisterCommand ( AZStd::string_view  identifier, AZStd::string_view  helpText, AZ::u32  commandFlags, CommandFunction  callback  )

pure virtual

Adds a command callback function to be executed with a string identifier

UnregisterCommand()

virtual bool AzFramework::CommandRegistration::UnregisterCommand ( AZStd::string_view  identifier )

pure virtual

Removes a command (using its identifier)

---

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

• Code/Framework/AzFramework/AzFramework/CommandLine/CommandRegistrationBus.h