Navigation
API > API/Plugins > API/Plugins/InstancedActors
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UInstancedActorsModifierBase
- URemoveInstancedActorsModifier
References
| Module | InstancedActors |
| Header | /Engine/Plugins/Runtime/InstancedActors/Source/InstancedActors/Public/InstancedActorsModifiers.h |
| Include | #include "InstancedActorsModifiers.h" |
Syntax
UCLASS (Abstract)
class UInstancedActorsModifierBase : public UObject
Remarks
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.
Variables
| Type | Name | Description | |
|---|---|---|---|
| bool | bRequiresSpawnedEntities | If true, this modifier will wait to be called on Managers only after Mass entities have been spawned for all instances. | |
| FGameplayTagQuery | InstanceTagsQuery | Optional tag query to filter instances to modify |
Functions
| Type | Name | Description | |
|---|---|---|---|
| bool | If true, this modifier will wait to be called on Managers only after Mass entities have been spawned for all instances. | ||
| void | ModifyAllInstances
(
AInstancedActorsManager& Manager, |
Callback to modify all instances in Manager, providing a 'fast path' opportunity for modifiers to perform whole-manager operations. | |
| void | ModifyAllInstancesInBounds
(
const TBoundsType& Bounds, |
Callback to modify all instances in Manager, whose location falls within Bounds. | |
| bool | ModifyInstance
(
const FInstancedActorsInstanceHandle& InstanceHandle, |
Per-instance callback to modify single instances. |