UCFRollingFXComponent

MODULECrushformWheelINCLUDECFRollingFXComponent.hPARENTUSceneComponent

The rolling effect of a body's wheels (dust, mud, spray): one Niagara component per wheel the host reports, made when first needed. The system and its intensity parameter come from the surface's row in UCFSettings::Surfaces, the tuning from UCFWheelSettings unless bOverrideTuning. Every effect stops while the body and its fastest grounded wheel are slower than SleepSpeedKPH. Presentation only: idle on a dedicated server. An inactive component (Auto Activate off) does nothing until activated.

Functions

AUTHORITY · server, every machineLOCAL · this machinePURE · read only

bool IsActiveForNetMode(ENetMode NetMode)

C++ ONLY

False only for a dedicated server, which draws nothing.

void SetCrushformHost(UObject* NewHost)

C++ ONLY

Sets who answers ICFWheelHost for the owner; null means the registry's host for the owner. Call before BeginPlay: a later call is refused.

UObject* GetCrushformHost() const

PUREC++ ONLY

The explicit host, else UCFHostRegistry::FindHost(Owner, UCFWheelHost).

FWheelFXState GetWheelFXState(int32 WheelIndex) const

PUREC++ ONLY

The last tick's state of the wheel's effect; a default state for a wheel never reported.

void SetSpeedOverrideForTest(TOptional<float> KPH)

C++ ONLY

Tests only: an unset override restores the host's speeds; a set one is every wheel's rolling and ground speed, km/h.

Properties

bool bOverrideTuning = false

Uses this component's Tuning instead of UCFWheelSettings::FXTuning.

Default

false

Category

Crushform|Rolling FX

FCFRollingFXTuning Tuning

The tuning used when Override Tuning is on.

Category

Crushform|Rolling FX