Blueprint nodes

Every node, event, and readable setting the plugin adds to Blueprints. Component nodes appear when you drag from a Physics Volume Box, Physics Volume Sphere, or Physics Volume Capsule component; level-volume nodes appear when you drag from a Filtering Physics Volume. Both are listed under Physics Volume in the node menu.

Callable nodes have execution pins. Pure nodes have none and run when a connected node reads their output. Every setter takes effect at once for actors already inside the volume.

Component nodes#

The three shapes share the same nodes, settings, and events, but each shape has its own copy of them, so a node's Target is the specific component type.

Set Volume Enabled#

Callable · Target: Physics Volume Box, Sphere, or Capsule · Menu: Physics Volume

Turns the volume on or off without removing it. Actors inside are affected at once: disabling fires On Actor Left Volume for them, and enabling fires On Actor Entered Volume. Does nothing if the state does not change. On a replicated actor, call it on the server; the settings reach clients automatically.

Set Volume Settings#

Callable · Target: Physics Volume Box, Sphere, or Capsule · Menu: Physics Volume

Replaces every setting, including Enabled and the filter. Actors already inside pick up the change without leaving and re-entering. To change one setting, read the current settings, change that member with a Set Members node, and pass the result. On a replicated actor, call it on the server; the settings reach clients automatically.

Set Filter#

Callable · Target: Physics Volume Box, Sphere, or Capsule · Menu: Physics Volume › Filter

Replaces the actor filter. Actors already inside are checked against the new filter straight away. On a replicated actor, call it on the server; the settings reach clients automatically.

Add Filtered Class#

Callable · Target: Physics Volume Box, Sphere, or Capsule · Menu: Physics Volume › Filter

Adds a class to the filter's Classes list. Ignores None and classes already listed. Remove Filtered Class removes every copy of the class.

Add Filtered Tag#

Callable · Target: Physics Volume Box, Sphere, or Capsule · Menu: Physics Volume › Filter

Adds a tag to the filter's Actor Tags list. Ignores None and tags already listed. Remove Filtered Tag removes every copy of the tag.

Set Volume Collision Profile#

Callable · Target: Physics Volume Box, Sphere, or Capsule · Menu: Physics Volume › Collision

Sets the volume's collision preset by its exact name, for example OverlapAllDynamic, and leaves custom channel responses.

Set Volume Collision Response To Channel#

Callable · Target: Physics Volume Box, Sphere, or Capsule · Menu: Physics Volume › Collision

Sets how the volume responds to one collision channel. The first call switches the volume to custom responses, starting from its current preset. Only Overlap lets the volume affect actors on that channel.

Can Volume Affect Anything#

Pure · Target: Physics Volume Box, Sphere, or Capsule · Menu: Physics Volume › Collision

False when the volume's collision cannot affect anything: query collision is off, no channel is set to Overlap, or the volume does not exist yet because the game has not started. Use it to diagnose a volume that looks configured but does nothing.

Get Hosted Volume#

Pure · Target: Physics Volume Box, Sphere, or Capsule · Menu: Physics Volume

Returns the physics volume this component drives: the volume a Character's Get Physics Volume reports while it is inside. It is a kind of Filtering Physics Volume, so the level-volume nodes work on it.

Use it to:

• check whether a Character is inside this volume, by comparing its Get Physics Volume with this result;
• call Would Affect Actor, Get Volume Settings, or Refresh Overlapping Actors;
• pass the volume to logic that works with any Filtering Physics Volume.

Changes made through it, such as Set Volume Priority or Clear Filter, apply only on the machine that makes them and are replaced the next time the component applies its own settings: after any component setter, a replicated settings update, or the component being registered again. For lasting changes, use the component's own nodes, such as Set Volume Settings with a new Priority.

The engine's shape nodes, such as Set Box Extent, Set Sphere Radius, and Set Capsule Size, also reshape the volume. Shape and collision changes do not replicate.

Component events#

Select the component and click + next to the event in the Events section of the Details panel.

On Actor Entered Volume#

Event · Target: Physics Volume Box, Sphere, or Capsule

An actor has started being governed by this volume. Actors the filter excludes never fire it.

On Actor Left Volume#

Event · Target: Physics Volume Box, Sphere, or Capsule

An actor has stopped being governed by this volume.

"Governed" means this volume is the one that applies to the actor. Moving from an outer volume into a higher-priority inner one fires On Actor Left Volume on the outer volume and On Actor Entered Volume on the inner one. The events also fire at once when a setter changes whether actors already inside qualify, for example when the volume is disabled or the filter changes. They fire only during play, never in the editor or the Blueprint preview.

In multiplayer the events fire on the server and on every client where the actor moves. Put damage, scoring, and spawning behind Has Authority; sounds and effects can run everywhere. See Overlapping volumes and multiplayer.

Component variables#

Read the component's settings with Get nodes. Both are read-only; change them with the setter nodes.

Filtering Physics Volume nodes#

A Filtering Physics Volume is placed from Place Actors → Volumes and has the same settings and events as the components. Bind its events in the Level Blueprint. Runtime changes to a placed volume do not replicate, so make them on every machine.

Set Volume Enabled#

Callable · Target: Filtering Physics Volume · Menu: Physics Volume

Turns the volume on or off without removing it. Actors inside are affected at once: disabling fires On Actor Left Volume for them, and enabling fires On Actor Entered Volume. Does nothing if the state does not change. Changes to a placed volume apply only on the machine that makes them.

Set Volume Settings#

Callable · Target: Filtering Physics Volume · Menu: Physics Volume

Replaces every setting, including Enabled and the filter. Actors already inside pick up the change without leaving and re-entering. To change one setting, read the current settings, change that member with a Set Members node, and pass the result. Changes to a placed volume apply only on the machine that makes them.

Set Filter#

Callable · Target: Filtering Physics Volume · Menu: Physics Volume › Filter

Replaces the actor filter. Actors already inside are checked against the new filter straight away. Changes to a placed volume apply only on the machine that makes them.

Add Filtered Class#

Callable · Target: Filtering Physics Volume · Menu: Physics Volume › Filter

Adds a class to the filter's Classes list. Ignores None and classes already listed. Remove Filtered Class removes every copy of the class.

Add Filtered Tag#

Callable · Target: Filtering Physics Volume · Menu: Physics Volume › Filter

Adds a tag to the filter's Actor Tags list. Ignores None and tags already listed. Remove Filtered Tag removes every copy of the tag.

Get Volume Settings#

Pure · Target: Filtering Physics Volume · Menu: Physics Volume

Returns the volume's current settings.

Set Volume Priority#

Callable · Target: Filtering Physics Volume · Menu: Physics Volume

Sets which volume wins where volumes overlap. Higher takes precedence. Give overlapping volumes different priorities; equal priorities have no fixed winner.

Clear Filter#

Callable · Target: Filtering Physics Volume · Menu: Physics Volume › Filter

Empties the filter's class and tag lists. The mode stays as it is, so a volume set to Affect Only Listed Actors then affects nothing.

Would Affect Actor#

Pure · Target: Filtering Physics Volume · Menu: Physics Volume › Filter

Whether the volume is enabled and its filter lets this actor through, wherever the actor is. It does not tell you whether the actor is inside. Component tags are read from the actor's root component.

Refresh Overlapping Actors#

Callable · Target: Filtering Physics Volume · Menu: Physics Volume

Checks every actor overlapping the volume again. The setter nodes do this for you. Otherwise, actors are checked again only when they move.

On Actor Entered Volume and On Actor Left Volume#

Event · Target: Filtering Physics Volume

The same events as the components, with an Actor pin.

The engine's own volume variables, such as Terminal Velocity or Priority, can be set on this actor, but they are replaced whenever its settings are applied. Use the nodes above.

Structures and enumerations#

The values below are also the settings shown in the Details panel.

Physics Volume Settings#

A Character's own Gravity Scale still multiplies the volume's gravity.

Physics Volume Actor Filter#

An actor matches when any listed class or tag matches it. Empty entries in the lists match nothing.

Physics Volume Collision Settings#

Gravity Mode#