Exec.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Misc/AssertionMacros.h"
 
class FOutputDevice;
class UWorld;
 
#ifndef UE_ALLOW_EXEC_COMMANDS
    #if UE_BUILD_SHIPPING && !WITH_EDITOR
        #define UE_ALLOW_EXEC_COMMANDS UE_ALLOW_EXEC_COMMANDS_IN_SHIPPING
    #else
        #define UE_ALLOW_EXEC_COMMANDS 1
    #endif
#endif
 
#ifndef UE_ALLOW_EXEC_DEV
    #define UE_ALLOW_EXEC_DEV !UE_BUILD_SHIPPING && UE_ALLOW_EXEC_COMMANDS
#endif
 
#ifndef UE_ALLOW_EXEC_EDITOR
    #define UE_ALLOW_EXEC_EDITOR WITH_EDITOR && UE_ALLOW_EXEC_COMMANDS
#endif
 
// Any object that is capable of taking commands.
class FExec
{
public:
    CORE_API virtual ~FExec();
 
#if UE_ALLOW_EXEC_COMMANDS
 
    CORE_API virtual bool Exec( UWorld* InWorld, const TCHAR* Cmd, FOutputDevice& Ar );
#else // UE_ALLOW_EXEC_COMMANDS
 
    CORE_API virtual bool Exec( UWorld* InWorld, const TCHAR* Cmd, FOutputDevice& Ar ) final;
    
    CORE_API virtual bool Exec( UWorld* InWorld, const TCHAR* Cmd ) final;
 
#endif // !UE_ALLOW_EXEC_COMMANDS
 
protected:
    virtual bool Exec_Runtime( UWorld* InWorld, const TCHAR* Cmd, FOutputDevice& Ar ) { return false; }
 
    virtual bool Exec_Dev( UWorld* InWorld, const TCHAR* Cmd, FOutputDevice& Ar ) { return false; }
 
    virtual bool Exec_Editor( UWorld* InWorld, const TCHAR* Cmd, FOutputDevice& Ar ) { return false; }
 
};