Modules

NWH Vehicle Physics 2 is a collection of VehicleComponents. All aspects of it are a component - sound components, effect components, etc. - they all inherit from VehicleComponent. The only way that a module is different from an inbuilt component is that it can be added or removed as needed.
Modules carry over state system from the VehicleComponent which means that each module can be turned on or off, enabled or disabled or have LOD set.

• To add a module click on Add Component button at the bottom of the Inspector. Modules must be added to an object that already contains VehicleController.
• Each module is wrapped in a MonoBehaviour wrapper ModuleWrapper. This is a way to work around lack of multiple inheritance in C#. So, to add a module just add its wrapper to the vehicle:

Adding a new module.

Each module is wrapped in a MonoBehaviour wrapper called ModuleWrapper. This is a way to get around lack of multiple inhertance in C#.
VehicleModule inherits from VehicleComponent, but it also needs to be serialized and for that it needs to be a MonoBehaviour. The new attribute [SerializeReference] has been present in Unity since 2019.3 and original implementation used that but the amount of bugs and lack of backwards-compatibility with older versions of Unity resulted in the wrappers being used instead.

Adding modules after vehicle initialization is not supported! Consider adding the module before entering play mode or immediately after adding the VehicleController (from scripting), and keeping them Disabled until needed.

To add a module use:

 myVehicleController.gameObject.AddComponent<MyModuleWrapper>(); 

Example (adding an ABSModule):

 myVehicleController.gameObject.AddComponent<ABSModuleWrapper>(); 

Modules are VehicleComponents wrapped in MonoBehaviour containers (wrappers).

 MyModule module = myVehicleController.GetComponent<MyModuleWrapper>().module as MyModule; 

To remove a module use:

 Destroy(myVehicleController.GetComponent<MyModuleWrapper>()); 

If doing this during the runtime the module should simply be disabled instead. ModuleManager does not update the modules list during the runtime so removing the module will result in an error.

Since modules inherits from VehicleComponent they also work on the same principle:

 myModule.VC_Enable(); 

 myModule.VC_Disable(); 

Note that disabling or enabling a module will have no effect while LODs are active for that module as the LOD system will override the manual settings while active.
To disable LODs for a module use:

 myModule.LodIndex = -1; 

• In the Scripts ⇒ Vehicle ⇒ Modules ⇒ ModuleTemplate folder there is an empty example module. Copy ModuleTemplate to create a starting point for a new module.
• Modules can be placed anywhere in the project and do not have to be in the same namespace as included modules.
• Directory structure of a module should be as following:

Example module directory structure.

• Each module must have at least three files:
  • ModuleDrawer (a type of CustomPropertyDrawer) placed in Editor folder.
  • Module file(s).
  • ModuleWrapper
• Each module must have a property drawer. All module drawers inherit from ModuleDrawer which uses NUI editor GUI framework (developed by NWH coding) to render custom property drawers and editors through simplified syntax. This also makes the created module compatible with ModuleManager drawer.