RustTip

OnSaveLoad

OxideCarbonServer

Called when a remote RCON command is received.

Provides access to the raw RCON message so you can log or modify behavior.

object OnSaveLoad(Dictionary<BaseEntity, ProtoBuf.Entity> dictionary)
Works — the game method in this build is the one the hook was written for.

Parameters

dictionary
Dictionary<BaseEntity, ProtoBuf.Entity>

Return value

objectThe returned value replaces the game result; null lets the game decide.

Example

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

private object OnSaveLoad(Dictionary<BaseEntity, ProtoBuf.Entity> dictionary)
{
    Puts("OnSaveLoad");

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

    // to affect the game:
    // return false; // your value instead of the game result
}

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

Injection point

Rust.opj (Oxide)
bool SaveRestore.Load(string, bool)

Passes: Dictionary<BaseEntity, ProtoBuf.Entity> dictionary

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: UseArgumentString (l1)Assembly-CSharp.dll

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

// …
{
	if (!(item == null))
	{
		item.SpawnAsMapEntity();
	}
}
DebugEx.Log("\tdone.");
DebugEx.Log("Spawning " + dictionary.Count + " entities from save");
object returnvar = Interface.CallHook("OnSaveLoad", dictionary);
if (returnvar is bool)
{
	return (bool)returnvar;
}
BaseNetworkable.LoadInfo info = new BaseNetworkable.LoadInfo
{
	fromDisk = true
};
// …

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.