APhysicsVolume | Unreal Engine 5.7 Documentation

PhysicsVolume: A bounding volume which affects actor physics. Each AActor is affected at any time by one PhysicsVolume.


Name	APhysicsVolume
Type	class
Header File	/Engine/Source/Runtime/Engine/Classes/GameFramework/PhysicsVolume.h
Include Path	#include "GameFramework/PhysicsVolume.h"

Syntax

UCLASS (MinimalAPI)  
class APhysicsVolume : public AVolume

Name	Remarks	Include Path	Unreal Specifiers
APhysicsVolume ( const FObjectInitializer& ObjectInitializer )		GameFramework/PhysicsVolume.h

Name	Type	Remarks	Include Path	Unreal Specifiers
bPhysicsOnContact	uint32	By default, the origin of an AActor must be inside a PhysicsVolume for it to affect the actor.	GameFramework/PhysicsVolume.h	EditAnywhere BlueprintReadWrite Category=Volume
bWaterVolume	uint32	True if this volume contains a fluid like water	GameFramework/PhysicsVolume.h	EditAnywhere BlueprintReadWrite Category=CharacterMovement
FluidFriction	float	This property controls the amount of friction applied by the volume as pawns using CharacterMovement move through it.	GameFramework/PhysicsVolume.h	EditAnywhere BlueprintReadWrite Category=CharacterMovement
Priority	int32	Determines which PhysicsVolume takes precedence if they overlap (higher number = higher priority).	GameFramework/PhysicsVolume.h	EditAnywhere BlueprintReadWrite Category=CharacterMovement
TerminalVelocity	float	Terminal velocity of pawns using CharacterMovement when falling.	GameFramework/PhysicsVolume.h	EditAnywhere BlueprintReadWrite Category=CharacterMovement

Name	Remarks	Include Path
virtual void ActorEnteredVolume ( AActor* Other )	Called when actor enters a volume.	GameFramework/PhysicsVolume.h
virtual void ActorLeavingVolume ( AActor* Other )	Called when actor leaves a volume, Other can be NULL.	GameFramework/PhysicsVolume.h
virtual float GetGravityZ()	@Returns the Z component of the current world gravity.	GameFramework/PhysicsVolume.h
virtual bool IsOverlapInVolume ( const USceneComponent& TestComponent ) const	Given a known overlap with the given component, validate that it meets the rules imposed by bPhysicsOnContact.	GameFramework/PhysicsVolume.h

Name	Remarks	Include Path
virtual void Destroyed()	Called when this actor is explicitly being destroyed during gameplay or in the editor, not called during level streaming or gameplay ending	GameFramework/PhysicsVolume.h
virtual void EndPlay ( const EEndPlayReason::Type EndPlayReason )	Overridable function called whenever this actor is being removed from a level	GameFramework/PhysicsVolume.h
virtual void PostInitializeComponents()	Allow actors to initialize themselves on the C++ side after all of their components have been initialized, only called during gameplay	GameFramework/PhysicsVolume.h

Name	Remarks	Include Path	Unreal Specifiers
virtual void LoadedFromAnotherClass ( const FName& OldClassName )		GameFramework/PhysicsVolume.h