Open 3D Engine AzToolsFramework 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.
AzToolsFramework::Layers::LayerResult Struct Reference

#include <LayerResult.h>

Public Member Functions

 LayerResult (LayerResultStatus resultStatus, QString resultMessage)
 
bool IsSuccess () const
 
void MessageResult ()
 

Static Public Member Functions

static LayerResult CreateSuccess ()
 

Public Attributes

LayerResultStatus m_result = LayerResultStatus::Success
 
QString m_message
 

Detailed Description

Holds the status of a layer operation, and a message detailing that status when not a success.

Member Function Documentation

◆ CreateSuccess()

static LayerResult AzToolsFramework::Layers::LayerResult::CreateSuccess ( )
inlinestatic

A helper function to make it obvious at callsites that a success is intended.

◆ IsSuccess()

bool AzToolsFramework::Layers::LayerResult::IsSuccess ( ) const
inline

Returns true if this LayerResult was a success, false if not.

◆ MessageResult()

void AzToolsFramework::Layers::LayerResult::MessageResult ( )

If a failure occured, outputs the current failure to the appropriate system. On success, does nothing.


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