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.
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:
ModuleManagerdrawer. Go to
VehicleControllerto see all of the available modules. This is to avoid cluttering the inspector with a multitude of different editors. Modules can also be filtered by category to make navigation easier.
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.
To add a module use:
Example (adding an ABSModule):
ABSModule absModule = myVehicleController.moduleManager.AddModule<ABSModuleWrapper, ABSModule>();
To get a module use:
Example (getting ABSModule):
ABSModule absModule = myVehicleController.moduleManager.GetModule<ABSModule>();
Alternatively, module can be retrieved through MonoBehaviour. The next snippet does exactly the same as the snippet above but might be more practical in some cases:
MyModule module = myVehicleController.GetComponent<MyModuleWrapper>().module as MyModule;
To remove a module use:
Example (removing ABSModule):
Since modules inherits from VehicleComponent they also work on the same principle:
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;
For class reference click here.
Scripts ⇒ Vehicle ⇒ Modules ⇒ ModuleTemplatefolder there is an empty example module. Copy
ModuleTemplateto create a starting point for a new module.
ModuleDrawer(a type of
CustomPropertyDrawer) placed in
ModuleDrawerwhich 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 is a
VehicleComponent that manages
For more info on Modules check Modules page.
Side Cd(Cd = coefficient of drag) fields. Data for different vehicles is available here.
Downforce is calculated in a simplified fashion by applying downforce to a number of points over the vehicle. In the simplest form a single downforce point at the center of the vehicle can be used, or one point at the front and one point at the end of the vehicle.
Downforce Points should be below the
WheelControllerposition, or even as low as the floor of the vehicle. This is because all the force is applied in a single point which, if applied too high, can cause the vehicle to snap oversteer when changing direction.
Max Downforce Speed.
Max Downforce Speedat which it reaches
Adds additional motorcycle balancing, steering and lean functionality to the NWH Vehicle Physics. The rest of the setup is similar to the conventional vehicle, just with two wheels and transmission outputting directly to the rear wheel, without the use of differentials.
Trikes can be implemented without this module as they do not require the additional functionality.
Field explanations can be seen by hovering over fields in the Unity inspector.
Lean is implemented through a PID controller and is one of the more important settings of the module. It determines in which manner the vehicle will lean and balance. PID controller is required because the balancing is done through physics (AddTorque). The tuning of the said controller requires a bit of tweaking (adjustable at runtime) but the default settings should be adequate for a vast majority of motorcycles.
Module containing a collection of assists aimed at achieving arcade-like behavior from the vehicles. Current functionality:
Adds artificial steer torque to the vehicle, independent of the tire grip. This helps rotate the vehicle.
Prevents the vehicle from drifting over the set angle, effectively preventing spin-outs.
Module for simulating the fuel system in a vehicle. Fuel consumption gets automatically generated from engine efficiency (average ICE efficiency is used) and fuel energy content. Consumption can be adjusted through
Amountindicates the amount of fuel currently in the tank while
Capacityindicates maximum tank capacity.
TrailerModule works in tandem with
VehicleController that has
TrailerModule is able attach to a
VehicleController that has
Attachment Pointis the point at which the trailer will be attached to the towing vehicle.
Trailer Standis the object which will be enabled if the trailer is detached and vice versa. It prevents the trailer from tipping forward on trailers with only the back axle.
Synchronize Gear Shiftsis enabled the trailer object will be kept in the same gear. This allows for powered trailer or vehicles that are constructed out of two Rigidbodies.
Also check Trailer Hitch module.
TrailerHitchModule can attach a
TrailerModule as a trailer.
TrailerModulecan be present on one vehicle at the same time.
AttachmentPointis the point at which the trailer will be attached. The trailer will be moved so that both trailer and hitch
AttachmentPoints are at the same position. This is where the physics joint gets created.
Also check Trailer module.