1. Epic GamesDeveloper
  3. UActorGroupingUtils

UActorGroupingUtils

Helper class for grouping actors in the level editor

API > API/Editor > API/Editor/UnrealEd

Helper class for grouping actors in the level editor

   
Name UActorGroupingUtils
Type class
Header File /Engine/Source/Editor/UnrealEd/Public/ActorGroupingUtils.h
Include Path #include "ActorGroupingUtils.h"

Syntax

UCLASS (Transient, MinimalAPI)  
class UActorGroupingUtils : public UObject

Inheritance Hierarchy

Typedefs

Name Type Remarks Include Path
FCanGroupActors TBaseDelegate_OneParam< bool, const TArray< AActor * > & > External delegates that are run to check if a set of actors can be grouped together ActorGroupingUtils.h

Constants

Name Type Remarks Include Path
bGroupingActive bool   ActorGroupingUtils.h
CanGroupActorsDelegates TMap< FName, FCanGroupActors >   ActorGroupingUtils.h
ClassToUse FSoftClassPath   ActorGroupingUtils.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddCanGroupActorsDelegate ( const FName& Owner,
const FCanGroupActors& InGroupActorsDelegate
)

 Add a filter that is checked to see if a set of actors can be grouped together ActorGroupingUtils.h  

virtual void AddSelectedToGroup()

 Activates "Add to Group" mode which allows the user to select a group to append current selection ActorGroupingUtils.h
  • BlueprintCallable
  • Category="Editor Scripting | Actor Grouping"

bool CanGroupActors ( const TArray< AActor* >& ActorsToGroup
) const

 Check if the provided list of actors can be grouped together ActorGroupingUtils.h
  • BlueprintCallable
  • Category="Editor Scripting | Actor Grouping"

bool CanGroupSelectedActors()

 Check if the currently selected actors can be grouped together ActorGroupingUtils.h
  • BlueprintCallable
  • Category="Editor Scripting | Actor Grouping"

virtual AGroupActor * GroupActors ( const TArray< AActor* >& ActorsToGroup
)

 Creates a new group from the provided list of actors removing the actors from any existing groups they are already in ActorGroupingUtils.h
  • BlueprintCallable
  • Category="Editor Scripting | Actor Grouping"

virtual AGroupActor * GroupSelected()

 Creates a new group from the current selection removing the actors from any existing groups they are already in ActorGroupingUtils.h
  • BlueprintCallable
  • Category="Editor Scripting | Actor Grouping"

virtual void LockSelectedGroups()

 Locks any groups in the current selection ActorGroupingUtils.h
  • BlueprintCallable
  • Category="Editor Scripting | Actor Grouping"

void RemoveCanGroupActorsDelegate ( const FName& Owner
)

 Remove the filter checked before grouping actors registered by the provided owner ActorGroupingUtils.h  

virtual void RemoveSelectedFromGroup ()

 Removes any groups or actors in the current selection from their immediate parent. ActorGroupingUtils.h
  • BlueprintCallable
  • Category="Editor Scripting | Actor Grouping"

virtual void UngroupActors ( const TArray< AActor* >& ActorsToUngroup
)

 Disbands any groups that the provided actors belong to, does not attempt to maintain any hierarchy ActorGroupingUtils.h
  • BlueprintCallable
  • Category="Editor Scripting | Actor Grouping"

virtual void UngroupSelected()

 Disbands any groups in the current selection, does not attempt to maintain any hierarchy ActorGroupingUtils.h
  • BlueprintCallable
  • Category="Editor Scripting | Actor Grouping"

virtual void UnlockSelectedGroups()

 Unlocks any groups in the current selection ActorGroupingUtils.h
  • BlueprintCallable
  • Category="Editor Scripting | Actor Grouping"

Static

Name Remarks Include Path Unreal Specifiers

static UActorGroupingUtils * Get()

 Convenience method for accessing grouping utils in a blueprint or script ActorGroupingUtils.h
  • BlueprintCallable
  • Category="Editor Scripting | Actor Grouping"
  • DisplayName="Get Actor Grouping Utils"

static bool IsGroupingActive()

   ActorGroupingUtils.h
  • BlueprintCallable
  • Category="Editor Scripting | Actor Grouping"

static void SetGroupingActive ( bool bInGroupingActive
)

   ActorGroupingUtils.h
  • BlueprintCallable
  • Category="Editor Scripting | Actor Grouping"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page