Navigation
API > API/Plugins > API/Plugins/InstancedActors
Base class for 'modifier' operations to run against Instanced Actors within AInstancedActorsManager's
Used by UInstancedActorsModifierVolumeComponent's to modify instances within their volumes.
Subclasses must implement at least ModifyInstance but can also override ModifyAllInstances to provide a whole-manager fast path.
| Name | UInstancedActorsModifierBase |
| Type | class |
| Header File | /Engine/Plugins/Runtime/InstancedActors/Source/InstancedActors/Public/InstancedActorsModifiers.h |
| Include Path | #include "InstancedActorsModifiers.h" |
Syntax
UCLASS (MinimalAPI, Abstract)
class UInstancedActorsModifierBase : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UInstancedActorsModifierBase
Derived Classes
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| InstanceTagsQuery | FGameplayTagQuery | Optional tag query to filter instances to modify | InstancedActorsModifiers.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool DoesRequireSpawnedEntities () |
If true, this modifier will wait to be called on Managers only after Mass entities have been spawned for all instances. | InstancedActorsModifiers.h | |
virtual void ModifyAllInstances
(
AInstancedActorsManager& Manager, |
Callback to modify all instances in Manager, providing a 'fast path' opportunity for modifiers to perform whole-manager operations. | InstancedActorsModifiers.h | |
void ModifyAllInstancesInBounds
(
const TBoundsType& Bounds, |
Callback to modify all instances in Manager, whose location falls within Bounds. | InstancedActorsModifiers.h | |
virtual bool ModifyInstance
(
const FInstancedActorsInstanceHandle& InstanceHandle, |
Per-instance callback to modify single instances. | InstancedActorsModifiers.h |