OnPlayerDrink

OxideCarbonPlayer

Called when player drink occurs.

object OnPlayerDrink(BasePlayer player, LiquidContainer liquidContainer)

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

Parameters

player: BasePlayer
liquidContainer: LiquidContainer

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 OnPlayerDrink(BasePlayer player, LiquidContainer liquidContainer)
{
    Puts("OnPlayerDrink");

    // 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 LiquidContainer.SVDrink(BaseEntity.RPCMessage)

Passes: BasePlayer player, LiquidContainer liquidContainer

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

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

[RPC_Server]
[RPC_Server.MaxDistance(3f)]
public void SVDrink(RPCMessage rpc)
{
	if (!rpc.player.metabolism.CanConsume())
	{
		return;
	}
	if (Interface.CallHook("OnPlayerDrink", rpc.player, this) != null)
	{
		return;
	}
	foreach (Item item in inventory.itemList)
	{
		ItemModConsume component = item.info.GetComponent<ItemModConsume>();
		if (!(component == null) && component.CanDoAction(item, rpc.player))
		{
// …

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.