FGantryStatus

StructGantryCoreBlueprint-visible

#include "Core/GantryCoreTypes.h"

The outcome of a Gantry operation: a result code plus a message for the log.

Success and Pending are the two states that are not errors. Every other result is an error, and the message says which input or condition caused it.

In Blueprint, break the struct to read Result and Message.

In C++, test it with IsSuccess, IsPending or IsError. It is cheap to copy, so return it by value.

Properties

Property	Type	Default	Description
`Result` read-only	`EGantryResult`	`Success`	What happened. Success unless the operation said otherwise.
`Message` read-only	`FString`		Why, in words, for logs and debugging. Usually empty on success. Not localised.

Public C++ members that Blueprint does not see.

FGantryStatus::FGantryStatus()=default

A successful status with no message.

FGantryStatus::FGantryStatus(EGantryResult InResult, FString InMessage=FString())

A status with the given result and an optional explanation.

InResult:
What happened.
InMessage:
Human-readable context for logs; empty is fine for Success and Pending.

bool FGantryStatus::IsSuccess() const

True when the operation completed.

bool FGantryStatus::IsPending() const

True when the operation was accepted and will report completion later.

bool FGantryStatus::IsError() const

True for every result that is neither Success nor Pending.

FString FGantryStatus::ToString() const

"Success" or "NotFound: ".

static FGantryStatus FGantryStatus::Success()

A Success status with no message.

static FGantryStatus FGantryStatus::Pending()

A Pending status with no message.

static FGantryStatus FGantryStatus::Error(EGantryResult InResult, FString InMessage)

An error status.

InResult:
The error code. Passing Success or Pending is legal but makes IsError() false.
InMessage:
What went wrong, naming the offending input where there is one.

Returns: The status.