API Reference

For Inspector-only setup, return to the guide. For driving inputs from a script, start with Controlling Vehicles from Code.

01Find the action you need

02How to read a signature

A signature lists a method's name and the values it needs. For example, SetEngine(RCCP_CarController vehicle, bool engineState) needs a vehicle reference and a true/false value: true starts the engine, false stops it.

• Call the methods through RCCP, for example RCCP.SetEngine(vehicle, true); inside your own method.
• vehicle must refer to the car you want to control; it is not a built-in variable.
• Returns tells you what you get back. void means there is no return value; bool means true or false.
• An overload is another version of the same method with different arguments. Choose the row matching what you need.
• An event is a notification you can listen to, such as a vehicle spawning.

Check: before using a row, you know which object it acts on, what arguments it needs, and whether you must check its result. Read the notes under the table for required modules and timing.

03How the facade behaves

RCCP is the main API entry point (sometimes called a facade). It is a static class in the global namespace. RCCP ships no assembly definition file, so it is visible from Assembly-CSharp with no using directive and no assembly reference.

The API checks for missing vehicle references and required components. Many calls log a warning and return when something is missing. Read that warning before changing settings. SpawnRCC logs an error for a missing prefab; IsRepaired is silent and returns true when there is nothing to repair.

04Spawning and registering

SpawnRCC returns null and logs an error if the prefab is null. It sets the "never auto-register" flag before instantiating, because RCCP vehicle prefabs ship active and Unity runs OnEnable synchronously inside Instantiate — so registerAsPlayerVehicle: false is honored for both active and inactive prefabs.

05Controlling a vehicle

RCCP_Settings.MobileController is TouchScreen, Gyro, SteeringWheel, Joystick.

06Gearbox and driver assists

RCCP_Gearbox.TransmissionType is Manual, Automatic, Automatic_DNRP. The bool overload of SetAutomaticGear maps true to Automatic and false to Manual, so it cannot reach Automatic_DNRP — use the enum overload for that.

targetSpeed is in km/h. All three assist methods require the vehicle's Inputs component; the gearbox methods require its Gearbox.

07Camera, photo mode and the crash cinematic

RCCP_PhotoMode.PhotoCameraMode is Orbit, FreeCam, AutoOrbit; CyclePhotoCameraMode steps through them in that order. CapturePhoto writes a super-size screenshot to persistentDataPath/Photos and returns the file path. SetPhotoFieldOfView takes degrees.

TriggerCrashCam runs the cinematic on the active player vehicle, framed just ahead of the car, and bypasses the delta-v and cooldown gates — an explicit call is an explicit intent. It returns false when there is no scene manager or no active player vehicle. CancelCrashCam is safe to call when nothing is running; IsCrashCamActive does not create the director if one is absent.

08Transport and skidmarks

Transport(position, rotation) moves the active player vehicle. The overloads that accept a vehicle move that specific car.

09Damage and repair

A repair is a request, not an instant state change: Repair raises repairNow, the damage component consumes it on its next update, and with a deformation solver present the vehicle animates back to shape over several frames. Poll IsRepaired rather than reading the repaired flag yourself — it is not true on the frame the request was made. IsRepaired returns true for a null vehicle and for a vehicle with no damage component, meaning "nothing outstanding". A vehicle deactivated before it returns true keeps its damage, because a disabled component never ticks.

10Per-vehicle recording

The per-vehicle recorder stores a clip on one car and plays it back on that same car.

These calls require a vehicle with an Other Addons manager and Recorder. Use the vehicle's module tools to add the Recorder before calling them.

11Instant replay

The replay director is scene-level and separate from the per-vehicle recorder. Add one via Tools/BoneCracker Games/Realistic Car Controller Pro/Add to Scene/Replay Director.

StartReplay and PlayReplayClip return NoDirector and log a warning when no director is in the scene. Clips are saved into persistentDataPath/RCCP_Replays with the extension .rccpreplay; characters the file system refuses become _ in the file name, and an existing clip is never overwritten. ListReplayClips returns full paths, newest first, and needs no director. Load a saved clip with RCCP_ReplayClipIO.Load(string path, out RCCP_ReplayClip clip, out string error) before passing it to PlayReplayClip.

RCCP_ReplayStartResult has eight values:

LastStartMessage also carries detail for the non-Failed outcomes, including which of a clip's vehicles were skipped for having no scene car and no matching entry in the director's Clip Vehicle Prefabs.

12Behavior presets

The index is into RCCP_Settings.behaviorTypes. Name lookups are case-insensitive; GetBehaviorIndexByName returns -1 and GetBehaviorByName returns null when there is no match, and the string overload of SetBehavior logs a warning and does nothing on a miss.

ClearBehavior turns overrideBehavior back off so global preset changes stop reaching vehicles. It does not revert values a preset already wrote — cars retain whatever is currently applied.

13Audio routing

Call SetAudioOutputBus once at boot with a group from your own mixer to route all RCCP vehicle audio through it. RCCP's mixer is nested underneath the supplied group rather than bypassed, which keeps the exposed pitch parameter the crash cinematic drives intact. Passing null, or calling ClearAudioOutputBus, restores the default of feeding the audio listener directly.

14Events

The events in RCCP_Events are static. Static events survive scene loads and outlive your objects, so unsubscribe in OnDisable — a subscriber that is destroyed without unsubscribing keeps the handler alive and throws on the next dispatch.

void OnEnable() {
    RCCP_Events.OnRCCPSpawned += VehicleSpawned;
}

void OnDisable() {
    RCCP_Events.OnRCCPSpawned -= VehicleSpawned;
}

void VehicleSpawned(RCCP_CarController vehicle) { }

Lifecycle

OnRCCPDestroyed and OnRCCPAIDestroyed fire when a vehicle is destroyed or disabled.

Collisions and damage

Three of these look interchangeable and are not:

RCCP_DamageZone is Front, Rear, Left, Right; health01 is 0 to 1 where 1 is intact. OnRCCPCaughtFire requires the damage mechanics addon on the vehicle.

Fuel, boost and cinematics

OnRCCPFuelEmpty and OnRCCPNosEmpty fire once and re-arm on refill or regeneration. OnRCCPReplayStarted fires after the live world is frozen and OnRCCPReplayEnded after it is restored. OnRCCPCrashCamEnded fires on every exit path, including cancellation.

Raising events yourself

Each event has a matching Event_* static method that raises it — Event_OnRCCPSpawned, Event_OnRCCPImpact and so on. These exist so RCCP's own components can fire events they do not own; calling them from game code fakes a notification that did not happen and will desynchronize anything listening.

15Common mistakes

16Read next

• Scripting Reference — worked examples of driving a vehicle from code, rather than a member list.
• Architecture Reference — which component owns what, and the execution order the events fire in.
• Field Reference — every serialized setting on every component, with defaults and ranges.
• Replay and Recording — what the replay director does and how to set one up before calling into it.