Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
FRuntimeErrors Struct Reference

#include <RuntimeErrors.h>

Public Member Functions

 DECLARE_DELEGATE_FourParams (FRuntimeErrorDelegate, ELogVerbosity::Type, const ANSICHAR *, int32, const FText &)
 

Static Public Member Functions

static void LogRuntimeIssue (ELogVerbosity::Type Verbosity, const ANSICHAR *FileName, int32 LineNumber, const FText &Message)
 
static bool LogRuntimeIssueReturningFalse (const ANSICHAR *Expr, const ANSICHAR *File, int32 Line)
 

Static Public Attributes

static FRuntimeErrorDelegate OnRuntimeIssueLogged
 

Private Member Functions

 FRuntimeErrors ()
 

Detailed Description

Definition at line 20 of file RuntimeErrors.h.

Constructor & Destructor Documentation

◆ FRuntimeErrors()

FRuntimeErrors::FRuntimeErrors ( )
inlineprivate

Definition at line 52 of file RuntimeErrors.h.

Member Function Documentation

◆ DECLARE_DELEGATE_FourParams()

FRuntimeErrors::DECLARE_DELEGATE_FourParams ( FRuntimeErrorDelegate ,
ELogVerbosity::Type ,
const ANSICHAR * ,
int32 ,
const FText &  )

◆ LogRuntimeIssue()

static void FRuntimeErrors::LogRuntimeIssue ( ELogVerbosity::Type Verbosity,
const ANSICHAR * FileName,
int32 LineNumber,
const FText & Message )
static

Prints out a runtime warning or error (typically by 'throwing' a BP script exception with the BP callstack)

Parameters
VerbosityThe verbosity of the issue (should be Warning or Error)
FileFile name ANSI string (FILE)
LineLine number (LINE)
MessageError or warning message to display, this may be surfaced to the user in the editor so make sure it is actionable (e.g., includes asset name or other useful info to help address the problem)
Returns
false in all cases.

◆ LogRuntimeIssueReturningFalse()

static bool FRuntimeErrors::LogRuntimeIssueReturningFalse ( const ANSICHAR * Expr,
const ANSICHAR * File,
int32 Line )
static

Raises a runtime error and returns false.

Parameters
ExprCode expression ANSI string (#code)
FileFile name ANSI string (FILE)
LineLine number (LINE)
Returns
false in all cases.

Member Data Documentation

◆ OnRuntimeIssueLogged

FRuntimeErrorDelegate FRuntimeErrors::OnRuntimeIssueLogged
static

Definition at line 38 of file RuntimeErrors.h.


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