OnXmasStockingFill

OxideCarbonSeasonal

Called when a xmas stocking is filled.

object OnXmasStockingFill(Stocking stocking)

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

Parameters

stocking: Stocking

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 OnXmasStockingFill(Stocking stocking)
{
    Puts("OnXmasStockingFill");

    // 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 Stocking.SpawnLoot()

Passes: Stocking stocking

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: JustThisAssembly-CSharp.dll

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

public override void SpawnLoot()
{
	if (inventory == null)
	{
		Debug.Log("CONTACT DEVELOPERS! Stocking::PopulateLoot has null inventory!!! " + name);
	}
	else if (IsEmpty())
	{
		if (Interface.CallHook("OnXmasStockingFill", this) != null)
		{
			return;
		}
		base.SpawnLoot();
		using (FlagsUpdateScope flagsUpdateScope = StartSetFlags(FlagsUpdateMode.SendNetworkUpdate))
		{
			flagsUpdateScope.Set(Flags.On, b: 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.