SCS_Node.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "UObject/Object.h"
#include "Misc/Guid.h"
#include "Engine/BlueprintGeneratedClass.h"
#include "Engine/SimpleConstructionScript.h"
#include "Engine/Blueprint.h"
#include "SCS_Node.generated.h"
 
class UBlueprint;
 
DECLARE_DELEGATE_OneParam( FSCSNodeNameChanged, const FName& );
 
UCLASS(MinimalAPI)
class USCS_Node : public UObject
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY()
    TObjectPtr<UClass> ComponentClass;
 
    UPROPERTY()
    TObjectPtr<class UActorComponent> ComponentTemplate;
 
    UPROPERTY()
    FBlueprintCookedComponentInstancingData CookedComponentInstancingData;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY()
    FText CategoryName;
#endif //WITH_EDITORONLY_DATA
 
    UPROPERTY()
    FName AttachToName;
 
    UPROPERTY()
    FName ParentComponentOrVariableName;
 
    //@TODO: We can potentially remove this if/when inherited SCS component template instances are included in subobject serialization, as we could then infer that the owner class is always the same as the BP class.
    UPROPERTY()
    FName ParentComponentOwnerClassName;
 
    UPROPERTY()
    bool bIsParentComponentNative;
 
    UPROPERTY()
    TArray<TObjectPtr<class USCS_Node>> ChildNodes;
 
    UPROPERTY(EditAnywhere, Category=BPVariableDescription)
    TArray<struct FBPVariableMetaDataEntry> MetaDataArray;
 
    UPROPERTY()
    FGuid VariableGuid;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY()
    bool bIsNative_DEPRECATED;
 
    /* (DEPRECATED) If this is a native component, this is the name of the UActorComponent */
    UPROPERTY()
    FName NativeComponentName_DEPRECATED;
 
    UPROPERTY()
    bool bVariableNameAutoGenerated_DEPRECATED;
#endif // WITH_EDITORONLY_DATA
 
    //~ Begin UObject Interface
    virtual void Serialize(FArchive& Ar) override;
    virtual void PostLoad() override;
    //~ End UObject Interface
 
#if WITH_EDITOR
 
    TWeakObjectPtr<USceneComponent> EditorComponentInstance;
 
    ENGINE_API void ValidateGuid();
 
    virtual EDataValidationResult IsDataValid(class FDataValidationContext& Context) const override;
#endif // WITH_EDITOR
 
    ENGINE_API UActorComponent* ExecuteNodeOnActor(AActor* Actor, USceneComponent* ParentComponent, const FTransform* RootTransform, const struct FRotationConversionCache* RootRelativeRotationCache, bool bIsDefaultTransform, ESpawnActorScaleMethod TransformScaleMethod = ESpawnActorScaleMethod::OverrideRootScale);
 
    ENGINE_API UActorComponent* GetActualComponentTemplate(class UBlueprintGeneratedClass* ActualBPGC) const;
 
    ENGINE_API const FBlueprintCookedComponentInstancingData* GetActualComponentTemplateData(class UBlueprintGeneratedClass* ActualBPGC) const;
 
    TArray<USCS_Node*> GetAllNodes();
    
    const TArray<USCS_Node*>& GetChildNodes() const { return ChildNodes; }
 
    ENGINE_API void AddChildNode(USCS_Node* InNode, bool bAddToAllNodes = true);
 
    ENGINE_API void RemoveChildNode(USCS_Node* InNode, bool bRemoveFromAllNodes = true);
 
    ENGINE_API void RemoveChildNodeAt(int32 ChildIndex, bool bRemoveFromAllNodes = true);
 
    ENGINE_API void MoveChildNodes(USCS_Node* SourceNode, int32 InsertLocation = INDEX_NONE);
 
    TArray<const USCS_Node*> GetAllNodes() const;
 
    ENGINE_API bool IsChildOf(USCS_Node* TestParent);
 
    ENGINE_API void PreloadChain();
 
    ENGINE_API bool IsRootNode() const;
 
    inline FName GetVariableName() const
    {
        return InternalVariableName;
    }
 
    ENGINE_API void SetVariableName(const FName& NewName, bool bRenameTemplate = true);
 
    class USimpleConstructionScript* GetSCS() const
    {
        return CastChecked<USimpleConstructionScript>(GetOuter());
    }
 
#if WITH_EDITOR
    ENGINE_API void SetOnNameChanged(const FSCSNodeNameChanged& OnChange);
 
    ENGINE_API void NameWasModified();
#endif
 
    ENGINE_API void SetMetaData(FName Key, FString Value);
 
    ENGINE_API const FString& GetMetaData(FName Key) const;
 
    ENGINE_API void RemoveMetaData(FName Key);
 
    ENGINE_API int32 FindMetaDataEntryIndexForKey(FName Key) const;
 
#if WITH_EDITOR
    ENGINE_API void SetParent(USCS_Node* InParentNode);
 
    ENGINE_API void SetParent(const USceneComponent* InParentComponent);
 
    ENGINE_API USceneComponent* GetParentComponentTemplate(UBlueprint* InBlueprint) const;
 
    ENGINE_API USceneComponent* GetParentComponentTemplate(UBlueprintGeneratedClass* BPGC) const;
 
    ENGINE_API void SaveToTransactionBuffer();
#endif
 
protected:
    static void RenameComponentTemplate(UActorComponent* ComponentTemplate, const FName& NewName);
        
private:
    UPROPERTY()
    FName InternalVariableName;
 
#if WITH_EDITOR
    FSCSNodeNameChanged       OnNameChangedExternal;
#endif
};