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 > Engine > PhysicsEngine > UPhysicsSpringComponent

Light Theme

Dark Theme

UPhysicsSpringComponent

Note: this component is still work in progress.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UPhysicsSpringComponent

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/PhysicsEngine/PhysicsSpringComponent.h
Include	#include "PhysicsEngine/PhysicsSpringComponent.h"

Syntax

class UPhysicsSpringComponent : public USceneComponent

Remarks

Note: this component is still work in progress. Uses raycast springs for simple vehicle forces Used with objects that have physics to create a spring down the X direction ie. point X in the direction you want generate spring.

Variables

	Name	Description
bool	bIgnoreSelf	If true, the spring will ignore all components in its own actor
TEnumAsByte< en...	SpringChannel	Strength of thrust force applied to the base object.
float	SpringCompression	The current compression of the spring. A spring at rest will have SpringCompression 0.
float	SpringDamping	Specifies how quickly the spring can absorb energy of a body.
float	SpringLengthAtRest	Determines how long the spring will be along the X-axis at rest.
float	SpringRadius	Determines the radius of the spring.
float	SpringStiffness	Specifies how much strength the spring has.

Constructors

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

Functions

	Name	Description
float	GetNormalizedCompressionScalar()	Returns the spring compression as a normalized scalar along spring direction.
FVector	GetSpringCurrentEndPoint()	Returns the spring current end point in world space.
FVector	GetSpringDirection()	Returns the spring direction from start to resting point
FVector	GetSpringRestingPoint()	Returns the spring resting point in world space.

Overridden from UActorComponent

		Name	Description
	void	TickComponent ( float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction* T... )	Function called every frame on this ActorComponent.

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

Take our survey

Dismiss