OnPlayerActiveShieldDrop

OxideCarbonPlayer

Called when a player active shield is dropped.

object OnPlayerActiveShieldDrop(BasePlayer player, Shield local0)

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

Parameters

player: BasePlayer
local0: Shield

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 OnPlayerActiveShieldDrop(BasePlayer player, Shield local0)
{
    Puts("OnPlayerActiveShieldDrop");

    // 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 PlayerBelt.DropActive(Vector3, Vector3)

Passes: BasePlayer player, Shield local0

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

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

public void DropActive(Vector3 position, Vector3 velocity)
{
	if (player.TryGetActiveShield(out var foundShield))
	{
		if (Interface.CallHook("OnPlayerActiveShieldDrop", this.player, foundShield) != null)
		{
			return;
		}
		DroppedItem droppedItem = foundShield.GetItem().Drop(position, velocity) as DroppedItem;
		if (droppedItem != null)
		{
			droppedItem.DropReason = DroppedItem.DropReasonEnum.Death;
			droppedItem.DroppedBy = player.userID;
// …

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.