Class RiggingModuleWrapper

MonoBehaviour wrapper for the RiggingModule.

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

ModuleWrapper

RiggingModuleWrapper

Namespace: NWH.VehiclePhysics2.Modules.Rigging

Assembly: NWH.VehiclePhysics2.dll

Syntax

[Serializable]
[DisallowMultipleComponent]
public class RiggingModuleWrapper : ModuleWrapper

Remarks

This wrapper enables the RiggingModule to be added as a Unity component and integrated into the VehicleController's module system. The wrapper must be added to a GameObject with a VehicleController.

Use this wrapper when you want to add procedural bone animation to your vehicle model. Configure bones in the module to animate suspension arms, axles, steering linkages, and other mechanical components.

Fields

module

The wrapped RiggingModule instance.

Declaration

public RiggingModule module

Field Value

Type	Description
RiggingModule

Remarks

Contains all configuration and bone definitions for the rigging system. Access this property to add or modify bones and their animation settings.

Methods

GetModule()

Gets the wrapped module as a VehicleComponent.

Declaration

public override VehicleComponent GetModule()

Returns

Type	Description
VehicleComponent	The RiggingModule instance cast to VehicleComponent

Overrides

ModuleWrapper.GetModule()

Remarks

Used by the module system for generic module handling and lifecycle management.

SetModule(VehicleComponent)

Sets the wrapped module from a VehicleComponent reference.

Declaration

public override void SetModule(VehicleComponent module)

Parameters

Type	Name	Description
VehicleComponent	module	The VehicleComponent to wrap, must be a RiggingModule instance

Overrides

ModuleWrapper.SetModule(VehicleComponent)

Remarks

Used by the module system when dynamically creating or replacing modules. The provided module must be castable to RiggingModule.