OnFrankensteinPetSleep

OxidePet

object OnFrankensteinPetSleep(FrankensteinPet frankensteinPet, FrankensteinTable frankensteinTable, BasePlayer owner)

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

Parameters

frankensteinPet: FrankensteinPet
frankensteinTable: FrankensteinTable
owner: BasePlayer

Return value

objectReturn non-null to stop the game method.

Example

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

private object OnFrankensteinPetSleep(FrankensteinPet frankensteinPet, FrankensteinTable frankensteinTable, BasePlayer owner)
{
    Puts("OnFrankensteinPetSleep");

    // 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 FrankensteinTable.SleepFrankenstein(BasePlayer)

Passes: FrankensteinPet frankensteinPet, FrankensteinTable frankensteinTable, BasePlayer owner

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

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

private void SleepFrankenstein(BasePlayer owner)
{
	if (IsInventoryEmpty() && !(owner == null) && (!needsBuildingPrivilegeToUse || owner.CanBuild()) && !(owner.PetEntity == null))
	{
		FrankensteinPet frankensteinPet = owner.PetEntity as FrankensteinPet;
		if (!(frankensteinPet == null) && !(Vector3.Distance(transform.position, frankensteinPet.transform.position) >= 5f))
		{
			if (Interface.CallHook("OnFrankensteinPetSleep", frankensteinPet, this, owner) != null)
			{
				return;
			}
			ReturnFrankensteinItems(frankensteinPet);
			ItemManager.DoRemoves();
			SendNetworkUpdateImmediate();
			frankensteinPet.Kill();
		}
// …

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.