UCFTireSettings

MODULECrushformTireINCLUDECFTireSettings.hPARENTUDeveloperSettings

Blueprint: Crushform Tire

Project-wide tyre deformation settings: Project Settings > Plugins > Crushform Tire.

The eight budget values, bEnabled through OnScreenTolerance, are the project values of the Crushform.Tire.* console variables; Scope and the sleep thresholds have none. They are applied when the module starts and again whenever a field changes in the editor, so a packaged game gets them too. The module applies them itself because the developer-settings base class syncs console variables only in the editor.

The project values sit at a priority above scalability settings, so a scalability preset leaves them alone. A console command, a command-line argument or a device profile still overrides them.

Functions

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

const UCFTireSettings* Get()

C++ ONLY

The settings object, read-only.

void ApplyConsoleVariables(EConsoleVariableFlags SetBy = ECVF_SetByProjectSetting) const

PUREC++ ONLY

Writes the budget fields into the Crushform.Tire.* console variables at the given priority. The default is the project-setting priority, which a console command overrides.

Properties

ECFTireScope Scope = ECFTireScope::Budgeted

Which tyres deform: only the viewer's own rig, the viewer's rig plus whatever the budget grants, or every registered vehicle without a limit.

Default

ECFTireScope::Budgeted

Category

Budget

bool bEnabled = true

Whether tyres deform at all. Off relaxes every tyre back to round. Console override: Crushform.Tire.Enable.

Default

true

Category

Budget

int32 MaxWheels = 30

Tyres that may deform at once. The local player's own vehicle and everything coupled to it always deform, even past this cap; what is left goes to the nearest other tyres, on-screen first. Console override: Crushform.Tire.MaxWheels.

Default

30

Category

Budget

float Radius = 4000.f

Distance from the camera, cm, within which other vehicles' tyres may deform. Console override: Crushform.Tire.Radius.

Default

4000.f

Category

Budget

float LodDistance1 = 1500.f

Distance from the camera, cm, past which a tyre traces a thinner ray fan (detail tier 1). Console override: Crushform.Tire.LodDistance1.

Default

1500.f

Category

Budget

float LodDistance2 = 3000.f

Distance from the camera, cm, past which a tyre traces the thinnest fan against simple collision (detail tier 2). Console override: Crushform.Tire.LodDistance2.

Default

3000.f

Category

Budget

float Hysteresis = 0.15f

Fraction by which a granted tyre's radius, rank and detail boundaries widen, so a tyre on a boundary does not flicker in and out. Read within 0 to 0.9. Console override: Crushform.Tire.Hysteresis.

Default

0.15f

Category

Budget

float UpdateInterval = 0.25f

Seconds between two tyre budget passes. Console override: Crushform.Tire.UpdateInterval.

Default

0.25f

Category

Budget

float OnScreenTolerance = 0.5f

Seconds since a wheel was last drawn on screen for it to still rank as on screen. Console override: Crushform.Tire.OnScreenTolerance.

Default

0.5f

Category

Budget

float SleepDistance = 1.f

A wheel that stays within this distance, cm, of its resting pose can fall asleep. A negative value never lets a wheel sleep.

Default

1.f

Category

Sleep

float SleepAngleDeg = 0.5f

How far, in degrees, a wheel's axis and down direction may turn from their resting pose while the wheel can still fall asleep.

Default

0.5f

Category

Sleep

TArray<TEnumAsByte<ECollisionChannel>> IgnoredObjectChannels

Object channels the ground trace of a tyre ignores, on top of the channels its own collision already ignores.

Category

Tracing

TSoftObjectPtr<UCFTireProfile> DefaultProfile

The tyre profile for a tyre that names none; the vehicle adapter reads it.

Category

Profile