Navigation
API > API/Runtime > API/Runtime/Engine
PhysicsVolume: a bounding volume which affects actor physics Each AActor is affected at any time by one PhysicsVolume Volume that causes damage over time to any Actor that overlaps its collision.
| Name | APainCausingVolume |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Classes/GameFramework/PainCausingVolume.h |
| Include Path | #include "GameFramework/PainCausingVolume.h" |
Syntax
UCLASS (MinimalAPI)
class APainCausingVolume : public APhysicsVolume
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → AActor → ABrush → AVolume → APhysicsVolume → APainCausingVolume
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
APainCausingVolume
(
const FObjectInitializer& ObjectInitializer |
GameFramework/PainCausingVolume.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BACKUP_bPainCausing | uint32 | Checkpointed bPainCausing value | GameFramework/PainCausingVolume.h | |
| bEntryPain | uint32 | If bPainCausing, cause pain when something enters the volume in addition to damage each second | GameFramework/PainCausingVolume.h |
|
| bPainCausing | uint32 | Whether volume currently causes damage. | GameFramework/PainCausingVolume.h |
|
| DamageInstigator | TObjectPtr< class AController > | Controller that gets credit for any damage caused by this volume | GameFramework/PainCausingVolume.h | |
| DamagePerSec | float | Damage done per second to actors in this volume when bPainCausing=true | GameFramework/PainCausingVolume.h |
|
| DamageType | TSubclassOf< UDamageType > | Type of damage done | GameFramework/PainCausingVolume.h |
|
| PainInterval | float | If pain causing, time between damage applications. | GameFramework/PainCausingVolume.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void CausePainTo
(
AActor* Other |
Damage overlapping actors if pain causing. | GameFramework/PainCausingVolume.h | |
virtual void PainTimer() |
Damage overlapping actors if pain-causing. | GameFramework/PainCausingVolume.h |
Overridden from APhysicsVolume
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ActorEnteredVolume
(
AActor* Other |
If bEntryPain is true, call CausePainTo() on entering actor. | GameFramework/PainCausingVolume.h |
Overridden from AActor
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void CheckForErrors() |
Function that gets called from within Map_Check to allow this actor to check itself for any potential errors and register them with map check dialog. | GameFramework/PainCausingVolume.h | |
virtual void EndPlay
(
const EEndPlayReason::Type EndPlayReason |
Overridable function called whenever this actor is being removed from a level | GameFramework/PainCausingVolume.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/PainCausingVolume.h | |
virtual void Reset() |
Reset actor to initial state - used when restarting level without reloading. | GameFramework/PainCausingVolume.h |