LegacyFramework::FrameworkApplicationMessages Class Reference

#include <EditorFrameworkAPI.h>

Inherits AZ::EBusTraits.

Public Types
typedef AZ::EBus< FrameworkApplicationMessages >	Bus
typedef Bus::Handler	Handler

Public Member Functions
virtual bool	IsRunningInGUIMode ()=0
virtual void *	GetMainModule ()=0
virtual const char *	GetApplicationName ()=0
virtual const char *	GetApplicationModule ()=0
virtual const char *	GetApplicationDirectory ()=0
virtual void	TeardownApplicationComponent ()=0
virtual int	GetDesiredExitCode ()=0
virtual void	SetDesiredExitCode (int code)=0
virtual bool	GetAbortRequested ()=0
virtual void	SetAbortRequested ()=0
	returns true if someone called /ref SetAbortRequested. See /ref appAbortRequested, the helper function that calls this
virtual AZStd::string	GetApplicationGlobalStoragePath ()=0
	Call this to indicate that something has gone wrong and we need to bail out (of a batch process)
virtual bool	IsPrimary ()=0
virtual bool	RequiresGameProject ()=0
virtual bool	IsAppConfigWritable ()=0
	see /ref RequiresGameProject above.
virtual bool	ShouldRunAssetProcessor ()=0
	see /ref IsAppConfigWriteable above.
virtual void	RunAssetProcessor ()
	see /ref ShouldRunAssetProcessor above.

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

Detailed Description

FrameworkApplicationMessages is how you communicate to the framework itself (instead of the above /ref CoreMessages which goes the other way).

Member Function Documentation

GetApplicationGlobalStoragePath()

virtual AZStd::string LegacyFramework::FrameworkApplicationMessages::GetApplicationGlobalStoragePath ( )

pure virtual

Call this to indicate that something has gone wrong and we need to bail out (of a batch process)

returns a path that points at the place where we can store application data that is specific to this user. note that this is not the application name, its just the root of a folder that is guaranteed to not be temporary and guaranteed to be writable. it is USER-SPECIFIC, but not application specific on windows, for example, this would be the Users/Name/AppData/Roaming/

GetDesiredExitCode()

virtual int LegacyFramework::FrameworkApplicationMessages::GetDesiredExitCode ( )

pure virtual

Reads the return code set by /ref SetDesiredExitCode. Since the application itself is in control, your void main() can use this function to know what to return in case you're making tools that are used in batches.

GetMainModule()

virtual void * LegacyFramework::FrameworkApplicationMessages::GetMainModule ( )

pure virtual

(Windows) retrieves the main module of the executable. This is always going to be the main executable except in the situation where the framework may be running as a DLL belonging to another process or program.

IsPrimary()

virtual bool LegacyFramework::FrameworkApplicationMessages::IsPrimary ( )

pure virtual

this is true if you are the first, 'primary' instance running. if this is false it means another app of the same kind ran before you and is still running

IsRunningInGUIMode()

virtual bool LegacyFramework::FrameworkApplicationMessages::IsRunningInGUIMode ( )

pure virtual

Equivalent to and used by /ref IsGUIMode

RunAssetProcessor()

virtual void LegacyFramework::FrameworkApplicationMessages::RunAssetProcessor ( )

inlinevirtual

see /ref ShouldRunAssetProcessor above.

Run the asset processor on this project. only valid on projects!

SetDesiredExitCode()

virtual void LegacyFramework::FrameworkApplicationMessages::SetDesiredExitCode ( int  code )

pure virtual

If you're making a command-line program built on the Application Framework, you can use /ref SetDesiredExitCode to manipulate the return code.

TeardownApplicationComponent()

virtual void LegacyFramework::FrameworkApplicationMessages::TeardownApplicationComponent ( )

pure virtual

Internal use only.

---

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

• Code/Framework/AzToolsFramework/AzToolsFramework/UI/LegacyFramework/Core/EditorFrameworkAPI.h