OnDemoRecordingStart

OxideCarbonPlayer

Called when a demo recording starts.

object OnDemoRecordingStart(string local0, BasePlayer basePlayer)

Works — the game method in this build is the one the hook was written for.

Parameters

local0: string
basePlayer: BasePlayer

Return value

objectReturn non-null to cancel the game action.

Example

object — you can affect the game: return a value to change or cancel the action.

private object OnDemoRecordingStart(string local0, BasePlayer basePlayer)
{
    Puts("OnDemoRecordingStart");

    // change nothing — the game continues as usual
    return null;

    // to affect the game:
    // return false; // non-null cancels the game action
}

Works in both Oxide and Carbon: Carbon loads Oxide plugins as is.

Injection point

Rust.opj (Oxide)

void BasePlayer.StartServerDemoRecording()

Passes: string local0, BasePlayer basePlayer

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: UseArgumentString (l0, this)Assembly-CSharp.dll

Where it is called (this branch's game code)

public void StartServerDemoRecording()
{
	if (net != null && net.connection != null && !net.connection.IsRecording)
	{
		string text = $"demos/{UserIDString}/{DateTime.Now:yyyy-MM-dd-hhmmss}.dem";
		if (Interface.CallHook("OnDemoRecordingStart", text, this) != null)
		{
			return;
		}
		Debug.Log(ToString() + " recording started: " + text);
		net.connection.StartRecording(text, new Demo.Header
		{
			version = Demo.Version,
			level = SceneManager.GetActiveScene().name,
// …

Sources: Rust.opj from OxideMod/Oxide.Rust (MIT) and hook metadata of the Carbon documentation (MIT). Method code is decompiled from this branch's server.