SimpleConstructionScript.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 "GameFramework/Actor.h"
#include "SimpleConstructionScript.generated.h"
 
class USCS_Node;
class FStaticMeshComponentBulkReregisterContext;
 
UCLASS(MinimalAPI)
class USimpleConstructionScript : public UObject
{
    GENERATED_UCLASS_BODY()
 
    
    ENGINE_API static const FString ComponentTemplateNameSuffix;
 
    //~ Begin UObject Interface
    virtual void Serialize(FArchive& Ar) override;
    virtual void PostLoad() override;
    //~ End UObject Interface
 
    void PreloadChain();
 
    ENGINE_API void FixupRootNodeParentReferences();
 
    static void RegisterInstancedComponent(UActorComponent* Component);
 
    void ExecuteScriptOnActor(AActor* Actor, const TInlineComponentArray<USceneComponent*>& NativeSceneComponents, const FTransform& RootTransform, const FRotationConversionCache* RootRelativeRotationCache, bool bIsDefaultTransform, ESpawnActorScaleMethod TransformScaleMethod = ESpawnActorScaleMethod::OverrideRootScale);
 
    ENGINE_API void CreateNameToSCSNodeMap();
 
    ENGINE_API void RemoveNameToSCSNodeMap();
 
#if WITH_EDITOR
    ENGINE_API class UBlueprint* GetBlueprint() const;
 
    ENGINE_API USceneComponent* GetSceneRootComponentTemplate(bool bShouldUseDefaultRoot = false, USCS_Node** OutSCSNode = nullptr) const;
 
    ENGINE_API void SaveToTransactionBuffer();
#endif
 
    ENGINE_API class UClass* GetOwnerClass() const;
 
    ENGINE_API class UClass* GetParentClass() const;
 
#if WITH_EDITOR
    ENGINE_API const TArray<USCS_Node*>& GetAllNodes() const;
#else
    const TArray<USCS_Node*>& GetAllNodes() const { return AllNodes; }
#endif  
 
    const TArray<USCS_Node*>& GetRootNodes() const { return RootNodes; }
 
    const class USCS_Node* GetDefaultSceneRootNode() const { return DefaultSceneRootNode; }
 
    class USCS_Node* GetDefaultSceneRootNode() { return DefaultSceneRootNode; }
 
    ENGINE_API void AddNode(USCS_Node* Node);
 
    ENGINE_API void RemoveNode(USCS_Node* Node, bool bValidateSceneRootNodes = true);
 
    ENGINE_API void RemoveNodeAndPromoteChildren(USCS_Node* Node);
 
    ENGINE_API USCS_Node* FindParentNode(USCS_Node* InNode) const;
 
    ENGINE_API USCS_Node* FindSCSNode(const FName InName) const;
 
    ENGINE_API USCS_Node* FindSCSNodeByGuid(const FGuid Guid) const;
 
    ENGINE_API void ValidateSceneRootNodes();
 
#if WITH_EDITOR
    virtual EDataValidationResult IsDataValid(class FDataValidationContext& Context) const override;
#endif // WITH_EDITOR
 
    FStaticMeshComponentBulkReregisterContext* GetReregisterContext() const { return ReregisterContext; }
 
private:
    UPROPERTY()
    TArray<TObjectPtr<class USCS_Node>> RootNodes;
 
    UPROPERTY()
    TArray<TObjectPtr<class USCS_Node>> AllNodes;
 
    UPROPERTY()
    TObjectPtr<class USCS_Node> DefaultSceneRootNode;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY()
    TObjectPtr<class USCS_Node> RootNode_DEPRECATED;
 
    UPROPERTY()
    TArray<TObjectPtr<USCS_Node>> ActorComponentNodes_DEPRECATED;
#endif
 
    int32 FindPromotableChildNodeIndex(USCS_Node* InParentNode) const;
 
    void FixupSceneNodeHierarchy();
 
#if WITH_EDITOR
    void GenerateListOfExistingNames(TSet<FName>& CurrentNames) const;
 
    USCS_Node* CreateNodeImpl(UActorComponent* NewComponentTemplate, FName ComponentVariableName);
 
public:
    ENGINE_API FName GenerateNewComponentName(const UClass* ComponentClass, FName DesiredName = NAME_None) const;
 
    ENGINE_API USCS_Node* CreateNode(class UClass* NewComponentClass, FName NewComponentVariableName = NAME_None);
 
    ENGINE_API USCS_Node* CreateNodeAndRenameComponent(UActorComponent* ExistingTemplate);
 
    ENGINE_API void ValidateNodeVariableNames(class FCompilerResultsLog& MessageLog);
 
    ENGINE_API void ValidateNodeTemplates(class FCompilerResultsLog& MessageLog);
 
    ENGINE_API void ClearEditorComponentReferences();
 
    ENGINE_API void BeginEditorComponentConstruction();
 
    ENGINE_API void EndEditorComponentConstruction();
 
    bool IsConstructingEditorComponents() const
    {
        return bIsConstructingEditorComponents;
    }
 
    void SetComponentEditorActorInstance(class AActor* InActor)
    {
        EditorActorInstancePtr = InActor;
    }
 
    class AActor* GetComponentEditorActorInstance() const
    {
        return EditorActorInstancePtr.Get();
    }
 
private:
    TWeakObjectPtr<class AActor> EditorActorInstancePtr;
 
    bool bIsConstructingEditorComponents;
#endif
 
    int32 NameToSCSNodeMapRefCount;
 
    TMap<FName, USCS_Node*> NameToSCSNodeMap;
 
    FStaticMeshComponentBulkReregisterContext* ReregisterContext;
    friend FStaticMeshComponentBulkReregisterContext;
 
    friend struct FSCSAllNodesHelper;
};
 
struct FSCSAllNodesHelper
{
private:
    static void Remove(USimpleConstructionScript* SCS, USCS_Node* SCSNode);
    static void Add(USimpleConstructionScript* SCS, USCS_Node* SCSNode);
 
    friend class USCS_Node;
};