Class VehicleSuspensionPartConfiguration

Configuration for an animated suspension part. This can be used to animate suspension springs and suspension arms that the wheels are attached to.

Index

Constructors

Accessors

attachmentPoint baseTransform mode visualModel wheelIndex

Methods

Constructors

constructor

new VehicleSuspensionPartConfiguration(): VehicleSuspensionPartConfiguration

Returns VehicleSuspensionPartConfiguration

Overrides FrameworkObject.constructor
new VehicleSuspensionPartConfiguration(
other: VehicleSuspensionPartConfiguration,
isInternalConstructor?: boolean,
): VehicleSuspensionPartConfiguration
Parameters
- other: VehicleSuspensionPartConfiguration
- OptionalisInternalConstructor: boolean
Returns VehicleSuspensionPartConfiguration

Overrides FrameworkObject.constructor

Accessors

attachmentPoint

get attachmentPoint(): Immutable<Vector3>

Only used when in the VehicleSuspensionPartMode::Suspension mode. Defines where the suspension part is attached to the wheel.

Returns Immutable<Vector3>
set attachmentPoint(value: Immutable<Vector3>): void
Parameters
- value: Immutable<Vector3>
Returns void

baseTransform

get baseTransform(): Immutable<Transform>

For parts that are using the VehicleSuspensionPartMode::Suspension mode, this defines the transform relative to the vehicle body where the part is attached. For parts that are using the VehicleSuspensionPartMode::BrakeAssembly mode, this defines the transform relative to the wheel where the part is attached.

Returns Immutable<Transform>
set baseTransform(value: Immutable<Transform>): void
Parameters
- value: Immutable<Transform>
Returns void

mode

get mode(): EnumValue<VehicleSuspensionPartMode>

Mode of the suspension part.

Returns EnumValue<VehicleSuspensionPartMode>
set mode(value: EnumValue<VehicleSuspensionPartMode>): void
Parameters
- value: EnumValue<VehicleSuspensionPartMode>
Returns void

visualModel

get visualModel(): VehicleVisualModel

The visual model used to represent the suspension part.

Returns VehicleVisualModel
set visualModel(value: VehicleVisualModel): void
Parameters
- value: VehicleVisualModel
Returns void

wheelIndex

get wheelIndex(): number

Wheel this part is attached to.

Returns number
set wheelIndex(value: number): void
Parameters
- value: number
Returns void

Methods

copyProperties

copyProperties(
other: VehicleSuspensionPartConfiguration,
isMirrored: boolean,
): void
Copies relevant properties from other to this suspension part.
Parameters
- other: VehicleSuspensionPartConfiguration
  The other suspension part to copy the properties from.
- isMirrored: boolean
  Whether other is on the opposite side of the vehicle and vectors need to be flipped.
Returns void