OnHealingItemUse

OxideCarbonItem

Called when a healing item uses.

object OnHealingItemUse(MedicalTool medicalTool, BasePlayer fromPlayer, IMedicalToolTarget toTarget)

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

Parameters

medicalTool: MedicalTool
fromPlayer: BasePlayer
toTarget: IMedicalToolTarget

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 OnHealingItemUse(MedicalTool medicalTool, BasePlayer fromPlayer, IMedicalToolTarget toTarget)
{
    Puts("OnHealingItemUse");

    // 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 MedicalTool.GiveEffectsTo(BasePlayer, IMedicalToolTarget)

Passes: MedicalTool medicalTool, BasePlayer fromPlayer, IMedicalToolTarget toTarget

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: AllAssembly-CSharp.dll

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

// …
	if (!(ownerItemDefinition == null))
	{
		ItemModConsumable component = ownerItemDefinition.GetComponent<ItemModConsumable>();
		if (component == null)
		{
			Debug.LogWarning("No consumable for medicaltool: " + name);
			return;
		}
		if (Interface.CallHook("OnHealingItemUse", this, fromPlayer, toTarget) != null)
		{
			return;
		}
		Analytics.Azure.OnMedUsed(ownerItemDefinition.shortname, fromPlayer, toTarget.GetEntity());
		toTarget.OnMedicalToolApplied(fromPlayer, ownerItemDefinition, component, this, canRevive);
	}
}

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.