Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
CoreMisc.h File Reference
+ Include dependency graph for CoreMisc.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  FSelfRegisteringExec
 
class  FStaticSelfRegisteringExec
 
class  FStaticSelfRegisteringExec_Dev
 
class  FStaticSelfRegisteringExec_Editor
 
class  FContextSupplier
 
struct  FMaintenance
 
struct  FUrlConfig
 
struct  FBoolConfigValueHelper
 
class  FScriptExceptionHandler
 
struct  FScopedScriptExceptionHandler
 
class  FAutoNamedEventsToggler
 

Macros

#define DO_BLUEPRINT_GUARD   1
 
#define SCRIPT_AUDIT_ROUTINES   1
 

Typedefs

typedef TFunction< void(ELogVerbosity::Type, const TCHAR *, const TCHAR *) FScriptExceptionHandlerFunc)
 

Functions

class FDerivedDataCacheInterfaceGetDerivedDataCache ()
 
class FDerivedDataCacheInterfaceGetDerivedDataCacheRef ()
 
class FDerivedDataCacheInterfaceTryGetDerivedDataCache ()
 
class ITargetPlatformManagerModuleGetTargetPlatformManager (bool bFailOnInitErrors=true)
 
class ITargetPlatformManagerModuleGetTargetPlatformManagerRef ()
 
bool WillNeedAudioVisualData ()
 
FORCEINLINE bool IsRunningDedicatedServer ()
 
FORCEINLINE bool IsRunningGame ()
 
FORCEINLINE bool IsRunningClientOnly ()
 
bool StringHasBadDashes (const TCHAR *Str)
 

Macro Definition Documentation

◆ DO_BLUEPRINT_GUARD

#define DO_BLUEPRINT_GUARD   1

This define enables the blueprint runaway and exception stack trace checks If this is true, it will create a FBlueprintContextTracker (previously FBlueprintExceptionTracker) which is defined in Script.h

Definition at line 332 of file CoreMisc.h.

◆ SCRIPT_AUDIT_ROUTINES

#define SCRIPT_AUDIT_ROUTINES   1

This define enables ScriptAudit exec commands

Definition at line 341 of file CoreMisc.h.

Typedef Documentation

◆ FScriptExceptionHandlerFunc

typedef TFunction<void(ELogVerbosity::Type , const TCHAR* , const TCHAR* ) FScriptExceptionHandlerFunc)

Function signature for handlers for script exceptions.

Definition at line 252 of file CoreMisc.h.

Function Documentation

◆ GetDerivedDataCache()

class FDerivedDataCacheInterface * GetDerivedDataCache ( )

Returns the derived data cache interface if it is available, otherwise null.

◆ GetDerivedDataCacheRef()

class FDerivedDataCacheInterface & GetDerivedDataCacheRef ( )

Returns the derived data cache interface, or fatal error if it is not available.

◆ GetTargetPlatformManager()

class ITargetPlatformManagerModule * GetTargetPlatformManager ( bool bFailOnInitErrors = true)

Return the Target Platform Manager interface, if it is available, otherwise return nullptr.

Parameters
bFailOnInitErrorsIf true (default) and errors occur during init of the TPM, an error will be logged and the process may terminate, otherwise will return whether there was an error or not.
Returns
The Target Platform Manager interface, if it is available, otherwise return nullptr.

◆ GetTargetPlatformManagerRef()

class ITargetPlatformManagerModule & GetTargetPlatformManagerRef ( )

Return the Target Platform Manager interface, fatal error if it is not available.

◆ IsRunningClientOnly()

FORCEINLINE bool IsRunningClientOnly ( )

Check to see if this executable is running as "the client"

  • removes all net code (WITH_SERVER_CODE=0) Editor can run as a game with -clientonly

Definition at line 195 of file CoreMisc.h.

◆ IsRunningDedicatedServer()

FORCEINLINE bool IsRunningDedicatedServer ( )

Check to see if this executable is running as dedicated server Editor can run as dedicated with -server

Definition at line 145 of file CoreMisc.h.

+ Here is the caller graph for this function:

◆ IsRunningGame()

FORCEINLINE bool IsRunningGame ( )

Check to see if this executable is running as "the game"

  • contains all net code (WITH_SERVER_CODE=1) Editor can run as a game with -game

Definition at line 170 of file CoreMisc.h.

◆ StringHasBadDashes()

bool StringHasBadDashes ( const TCHAR * Str)

◆ TryGetDerivedDataCache()

class FDerivedDataCacheInterface * TryGetDerivedDataCache ( )

Returns the derived data cache interface if it is available and initialized, otherwise null.

◆ WillNeedAudioVisualData()

bool WillNeedAudioVisualData ( )

Return true if we are currently in a commandlet is targeting platforms with AV requirements (ie not a server) or we are not targetingother platforms, and the current platform needs to render (CanEverRender())