OnFreeableContainerRelease

OxideCarbonEntity

Called when freeable container release occurs.

object OnFreeableContainerRelease(FreeableLootContainer freeableLootContainer, BasePlayer ply)

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

Parameters

freeableLootContainer: FreeableLootContainer
ply: 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 OnFreeableContainerRelease(FreeableLootContainer freeableLootContainer, BasePlayer ply)
{
    Puts("OnFreeableContainerRelease");

    // 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 FreeableLootContainer.Release(BasePlayer)

Passes: FreeableLootContainer freeableLootContainer, BasePlayer ply

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: AllAssembly-CSharp.dll

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

public void Release(BasePlayer ply)
{
	if (Interface.CallHook("OnFreeableContainerRelease", this, ply) != null)
	{
		return;
	}
	GetRB().isKinematic = false;
	buoyancy.enabled = true;
	buoyancy.buoyancyScale = 1f;
	using (FlagsUpdateScope flagsUpdateScope = StartSetFlags(FlagsUpdateMode.SendNetworkUpdate))
	{
// …

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.