YACC API Documentation

Navigate on the sidebar to read the documentation.

You can read the custom example page for a detailed way to setup a MonoBehaviour script using YACC.

In a ballpark the API documentation is split into 3 main namespaces:

• YACC contains the main classes and structs used by YACC.
• YACC.Controllers contains the MonoBehaviour scripts that can be used to control a vehicle.
• YACC.Audio contains the MonoBehaviour scripts that can be used to control the audio of a vehicle.

YACC namespace

Contains the main Engine, Wheel(s) and GearBox classes. In a nutshell:

• YACC.Engine manages the engine, it can be used to configure a torque curve and few other RPM limits for a vehicle. It will manage the engine RPM automatically by setting the throttle input. Keeps track of the general state of the engine.
• YACC.Wheels is the main class that manages the wheels, it can be used to configure the wheels of a vehicle and orchestrate them without the need to manually reach each wheel with your code/update loop.
• YACC.GearBox manages the gears of a vehicle, it can be used to configure the gears of a vehicle, ratios, etc. It provides methods to shift gears and keep track of the general state of a gearbox.

YACC.Controllers namespace

Contains the MonoBehaviour scripts that can be used to control a vehicle. In a nutshell:

• YACC.Controllers.CarEngineController is the main MonoBehaviour script that can be used to control a vehicle, it can be used to control the throttle, brakes, steering, hand brake and gears of a vehicle.
• YACC.Controllers.CarLightsController can be used to control the lights of a vehicle.
• YACC.Controllers.CarResetController can be used to reset the position of a vehicle.
• YACC.Controllers.WheelGripController readapts the wheel collider slip based on the physics material it is currently touching.
• YACC.Controllers.WheelSkidParticleSystemController can be used to control the particle system component attached on the wheel gameobject.
• YACC.Controllers.WheelSkidVisualEffectController can be used to control the visual effect particle component attached on the wheel gameobject.

YACC.Audio namespace

Contains the MonoBehaviour scripts that can be used to control various aspects of the audio coming from a vehicle:

• YACC.Audio.EngineAudio can be used to control the engine audio from the CarEngineController
• YACC.Audio.SuspensionAudio monitors the wheel collider to play sounds when hitting objects.
• YACC.Audio.WheelAudio monitors the wheel collider to play the tire skid sound.