UObjectMarks.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*=============================================================================
    UObjectMark.h: Unreal object marks
=============================================================================*/
 
#pragma once
 
#include "Containers/Array.h"
 
class UObject;
 
/* Here are the legacy flags that were converted to marks; listed here for find in files 
#define RF_Saved                    DECLARE_UINT64(0x0000000080000000)      // Object has been saved via SavePackage. Temporary.
#define RF_TagImp                   DECLARE_UINT64(0x0000000800000000)      // Temporary import tag in load/save.
#define RF_TagExp                   DECLARE_UINT64(0x0000001000000000)      // Temporary export tag in load/save.
#define RF_NotForClient             DECLARE_UINT64(0x0010000000000000)      // LT   Don't load this object for the game client.      These are always overwritten on save based on the virtual methods.
#define RF_NotForServer             DECLARE_UINT64(0x0020000000000000)      // LT   Don't load this object for the game server.     The base virtual methods always just look at the flag so leave things unchanged.
*/
 
enum EObjectMark
{
    OBJECTMARK_NOMARKS                      = 0x00000000,       // Zero, nothing marked
    OBJECTMARK_Saved                        = 0x00000004,       // Object has been saved via SavePackage. Temporary.
    OBJECTMARK_TagImp                       = 0x00000008,       // Temporary import tag in load/save.
    OBJECTMARK_TagExp                       = 0x00000010,       // Temporary export tag in load/save.
    OBJECTMARK_NotForClient                 = 0x00000020,       // Temporary save tag for client load flag.
    OBJECTMARK_NotForServer                 = 0x00000040,       // Temporary save tag for server load flag.
    OBJECTMARK_NotAlwaysLoadedForEditorGame = 0x00000080,       // Temporary save tag for editorgame load flag.
    OBJECTMARK_EditorOnly                   = 0x00000100,       // Temporary editor only flag
    OBJECTMARK_NotForTargetPlatform         = 0x00000200,       // Temporary save tag for stripping objets based on TargetPlatform 
    // Set of marks to inherit up the outer chain, etc
    OBJECTMARK_INHERITEDMARKS               = OBJECTMARK_NotForClient | OBJECTMARK_NotForServer | OBJECTMARK_EditorOnly | OBJECTMARK_NotForTargetPlatform,
    OBJECTMARK_ALLMARKS                     = 0xffffffff,       // -1, all possible marks
};
 
COREUOBJECT_API void MarkObject(const class UObjectBase* Object, EObjectMark Marks);
 
COREUOBJECT_API void UnMarkObject(const class UObjectBase* Object, EObjectMark Marks);
 
COREUOBJECT_API void MarkAllObjects(EObjectMark Marks);
 
COREUOBJECT_API void UnMarkAllObjects(EObjectMark Marks = OBJECTMARK_ALLMARKS);
 
COREUOBJECT_API bool ObjectHasAnyMarks(const class UObjectBase* Object, EObjectMark Marks);
 
COREUOBJECT_API bool ObjectHasAllMarks(const class UObjectBase* Object, EObjectMark Marks);
 
COREUOBJECT_API EObjectMark ObjectGetAllMarks(const class UObjectBase* Object);
 
COREUOBJECT_API void GetObjectsWithAllMarks(TArray<UObject *>& Results, EObjectMark Marks);
 
COREUOBJECT_API void GetObjectsWithAnyMarks(TArray<UObject *>& Results, EObjectMark Marks);