1. Epic GamesDeveloper
  3. UPhysicsSettings

UPhysicsSettings

Default physics settings.

API > API/Runtime > API/Runtime/Engine

Default physics settings.

   
Name UPhysicsSettings
Type class
Header File /Engine/Source/Runtime/Engine/Classes/PhysicsEngine/PhysicsSettings.h
Include Path #include "PhysicsEngine/PhysicsSettings.h"

Syntax

UCLASS (Config=Engine, defaultconfig, Meta=(DisplayName="Physics"), MinimalAPI)  
class UPhysicsSettings : public UPhysicsSettingsCore

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UPhysicsSettings ( const FObjectInitializer& ObjectInitializer
)

   PhysicsEngine/PhysicsSettings.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AnimPhysicsMinDeltaTime float Min Delta Time below which anim dynamics and rigidbody nodes will not simulate. PhysicsEngine/PhysicsSettings.h
  • Config
  • EditAnywhere
  • Meta=(ClampMin="0.0", UIMin="0.0", ClampMax="1.0", UIMax="1.0")
  • Category=Framerate
AsyncFixedTimeStepSize float If using async, the time step size to tick at. PhysicsEngine/PhysicsSettings.h
  • Config
  • EditAnywhere
  • Category=Framerate
  • Meta=(editcondition="bTickPhysicsAsync")
bDisableActiveActors bool If true, physx will not update unreal with any bodies that have moved during the simulation. PhysicsEngine/PhysicsSettings.h
  • Config
  • EditAnywhere
  • Category=Optimization
bDisableCCD bool If true CCD will be ignored. PhysicsEngine/PhysicsSettings.h
  • Config
  • EditAnywhere
  • Category=Simulation
bDisableKinematicKinematicPairs bool Whether to disable generating KK pairs, enabling this speeds up contact generation, however it is required when using APEX destruction. PhysicsEngine/PhysicsSettings.h
  • Config
  • EditAnywhere
  • Category=Optimization
bDisableKinematicStaticPairs bool Whether to disable generating KS pairs, enabling this makes switching between dynamic and static slower for actors - but speeds up contact generation by early rejecting these pairs PhysicsEngine/PhysicsSettings.h
  • Config
  • EditAnywhere
  • Category=Optimization
bSimulateAnimPhysicsAfterReset bool Whether to simulate anim physics nodes in the tick where they're reset. PhysicsEngine/PhysicsSettings.h
  • Config
  • EditAnywhere
  • Category=Simulation
bSubstepping bool Whether to substep the physics simulation. PhysicsEngine/PhysicsSettings.h
  • Config
  • EditAnywhere
  • Category=Framerate
bSubsteppingAsync bool Whether to substep the async physics simulation. PhysicsEngine/PhysicsSettings.h
  • Config
  • EditAnywhere
  • Category=Framerate
bSupportUVFromHitResults bool If true, store extra information to allow FindCollisionUV to derive UV info from a line trace hit result, using the FindCollisionUV utility PhysicsEngine/PhysicsSettings.h
  • Config
  • EditAnywhere
  • Category=Optimization
  • Meta=(DisplayName="Support UV From Hit Results", ConfigRestartRequired=true)
bSuppressFaceRemapTable bool If true, the internal physx face to UE face mapping will not be generated. PhysicsEngine/PhysicsSettings.h
  • Config
  • EditAnywhere
  • Category=Optimization
bTickPhysicsAsync bool Whether to tick physics simulation on an async thread. PhysicsEngine/PhysicsSettings.h
  • Config
  • EditAnywhere
  • Category=Framerate
ChaosSettings FChaosPhysicsSettings Chaos physics engine settings PhysicsEngine/PhysicsSettings.h
  • Config
  • EditAnywhere
  • Category=ChaosPhysics
DefaultBroadphaseSettings FBroadphaseSettings If we want to Enable MPB or not globally. PhysicsEngine/PhysicsSettings.h
  • Config
  • EditAnywhere
  • Category=Broadphase
DefaultDegreesOfFreedom TEnumAsByte< ESettingsDOF::Type > Useful for constraining all objects in the world, for example if you are making a 2D game using 3D environments. PhysicsEngine/PhysicsSettings.h
  • Config
  • EditAnywhere
  • Category=Simulation
InitialAverageFrameRate float Physics delta time initial average. PhysicsEngine/PhysicsSettings.h
  • Config
  • EditAnywhere
  • AdvancedDisplay
  • Meta=(ClampMin="0.0013", UIMin="0.0013", ClampMax="1.0", UIMax="1.0")
  • Category=Framerate
MaxPhysicsDeltaTime float Max Physics Delta Time to be clamped. PhysicsEngine/PhysicsSettings.h
  • Config
  • EditAnywhere
  • Meta=(ClampMin="0.0013", UIMin="0.0013", ClampMax="1.0", UIMax="1.0")
  • Category=Framerate
MaxSubstepDeltaTime float Max delta time (in seconds) for an individual simulation substep. PhysicsEngine/PhysicsSettings.h
  • Config
  • EditAnywhere
  • Meta=(ClampMin="0.0013", UIMin="0.0013", ClampMax="1.0", UIMax="1.0", editcondition="bSubStepping")
  • Category=Framerate
MaxSubsteps int32 Max number of substeps for physics simulation. PhysicsEngine/PhysicsSettings.h
  • Config
  • EditAnywhere
  • Meta=(ClampMin="1", UIMin="1", ClampMax="16", UIMax="16", editcondition="bSubstepping")
  • Category=Framerate
MinDeltaVelocityForHitEvents float Minimum velocity delta required on a collinding object for Chaos to send a hit event PhysicsEngine/PhysicsSettings.h
  • Config
  • EditAnywhere
  • Category=ChaosPhysics
MinPhysicsDeltaTime float Min Physics Delta Time; the simulation will not step if the delta time is below this value PhysicsEngine/PhysicsSettings.h
  • Config
  • EditAnywhere
  • Meta=(ClampMin="0.0", UIMin="0.0", ClampMax="0.0001", UIMax="0.0001")
  • Category=Framerate
PhysicalSurfaces TArray< FPhysicalSurfaceName > PhysicalMaterial Surface Types. PhysicsEngine/PhysicsSettings.h
  • Config
  • EditAnywhere
  • Category=PhysicalSurfaces
PhysicErrorCorrection FRigidBodyErrorCorrection Default settings for physics replication using EPhysicsReplicationMode::Default PhysicsEngine/PhysicsSettings.h
  • Config
  • EditAnywhere
  • Category=Replication
  • Meta=(DisplayName="Default Physics Replication Settings (EPhysicsReplicationMode::Default)")
PhysicsPrediction FPhysicsPredictionSettings Settings for Networked Physics Prediction, experimental. PhysicsEngine/PhysicsSettings.h
  • Config
  • EditAnywhere
  • Category=Replication
  • Meta=(DisplayName="Physics Prediction (Experimental)")
PhysXTreeRebuildRate int The number of frames it takes to rebuild the PhysX scene query AABB tree. PhysicsEngine/PhysicsSettings.h
  • Config
  • EditAnywhere
  • AdvancedDisplay
  • Meta=(ClampMin="4", UIMin="4")
  • Category=Framerate
SyncSceneSmoothingFactor float Physics delta time smoothing factor for sync scene. PhysicsEngine/PhysicsSettings.h
  • Config
  • EditAnywhere
  • AdvancedDisplay
  • Meta=(ClampMin="0.0", UIMin="0.0", ClampMax="1.0", UIMax="1.0")
  • Category=Framerate

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual bool CanEditChange ( const FProperty* Property
) const

   PhysicsEngine/PhysicsSettings.h  

int32 GetPhysicsHistoryCount()

   PhysicsEngine/PhysicsSettings.h
  • BlueprintCallable
  • Category="Physics"

void LoadSurfaceType ()

 Load Material Type data from INI file this changes displayname meta data. PhysicsEngine/PhysicsSettings.h  

Overridden from UPhysicsSettingsCore

Name Remarks Include Path Unreal Specifiers

virtual void PostInitProperties()

   PhysicsEngine/PhysicsSettings.h  

Overridden from UDeveloperSettings

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   PhysicsEngine/PhysicsSettings.h  

Static

Name Remarks Include Path Unreal Specifiers

static UPhysicsSettings * Get()

   PhysicsEngine/PhysicsSettings.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
LockedAxis_DEPRECATED TEnumAsByte< ESettingsLockedAxis::Type >   PhysicsEngine/PhysicsSettings.h
  • Config

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page