Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > FieldSystemEngine > Field > UFieldSystemComponent

Light Theme

Dark Theme

UFieldSystemComponent

FieldSystemComponent

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UPrimitiveComponent

UFieldSystemComponent

References

Module	FieldSystemEngine
Header	/Engine/Source/Runtime/Experimental/FieldSystem/Source/FieldSystemEngine/Public/Field/FieldSystemComponent.h
Include	#include "Field/FieldSystemComponent.h"

Syntax

class UFieldSystemComponent : public UPrimitiveComponent

Remarks

FieldSystemComponent

Variables

	Name	Description
bool	bHasPhysicsState
TArray< FFieldS...	BlueprintBufferedCommands
FChaosSolversMo...	ChaosModule
UFieldSystem &#...	FieldSystem
FFieldSystemPhy...	PhysicsProxy
TArray< TSoftOb...	SupportedSolvers	List of solvers this field will affect. An empty list makes this field affect all solvers.

Constructors

	Name	Description
	UFieldSystemComponent ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	AddFieldCommand ( bool Enabled, EFieldPhysicsType Target, UFieldSystemMetaData* MetaData, UFieldNodeBase* Field )	ApplyPhysicsField
void	ApplyLinearForce ( bool Enabled, FVector Direction, float Magnitude )	ApplyLinearForce This function will dispatch a command to the physics thread to apply a uniform linear force on each particle within the simulation.
void	ApplyPhysicsField ( bool Enabled, EFieldPhysicsType Target, UFieldSystemMetaData* MetaData, UFieldNodeBase* Field )	ApplyPhysicsField This function will dispatch a command to the physics thread to apply a generic evaluation of a user defined field network.
void	ApplyRadialForce ( bool Enabled, FVector Position, float Magnitude )	ApplyRadialForce This function will dispatch a command to the physics thread to apply a linear force that points away from a position.
void	ApplyRadialVectorFalloffForce ( bool Enabled, FVector Position, float Radius, float Magnitude )	ApplyRadialVectorFalloffForce This function will dispatch a command to the physics thread to apply a linear force from a position in space.
void	ApplyStayDynamicField ( bool Enabled, FVector Position, float Radius )	ApplyStayDynamicField This function will dispatch a command to the physics thread to apply a kinematic to dynamic state change for the particles within the field.
void	ApplyStrainField ( bool Enabled, FVector Position, float Radius, float Magnitude, int32 Iterations )	ApplyStrainField This function will dispatch a command to the physics thread to apply a strain field on a clustered set of geometry.
void	ApplyUniformVectorFalloffForce ( bool Enabled, FVector Position, FVector Direction, float Radius, float Magnitude )	ApplyUniformVectorFalloffForce This function will dispatch a command to the physics thread to apply a linear force in a uniform direction.
void	DispatchCommand ( const FFieldSystemCommand& InComma... )
const UField...	GetFieldSystem()
TSet< FPhysS...	GetPhysicsScenes()
void	ResetFieldSystem()	ClearFieldSystem
void	SetFieldSystem ( UFieldSystem* FieldSystemIn )	FieldSystem

Overridden from UPrimitiveComponent

		Name	Description
	FPrimitiveSc...	CreateSceneProxy()	Creates a proxy to represent the primitive to the scene manager in the rendering thread.

Overridden from USceneComponent

		Name	Description
	bool	HasAnySockets()	Returns true if this component has any sockets

Overridden from UActorComponent

	Name	Description
bool	HasValidPhysicsState()	Used to check that DestroyPhysicsState() is working correctly
void	OnCreatePhysicsState()	Used to create any physics engine information for this component
void	OnDestroyPhysicsState()	Used to shut down and physics engine structure for this component
bool	ShouldCreatePhysicsState()	Return true if CreatePhysicsState() should be called.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss