OnPlayerRevive

OxideCarbonPlayer

Called when a player revives.

object OnPlayerRevive(BasePlayer fromPlayer, BasePlayer basePlayer)

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

Parameters

fromPlayer: BasePlayer
basePlayer: 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 OnPlayerRevive(BasePlayer fromPlayer, BasePlayer basePlayer)
{
    Puts("OnPlayerRevive");

    // 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 BasePlayer.OnMedicalToolApplied(BasePlayer, ItemDefinition, ItemModConsumable, MedicalTool, bool)

Passes: BasePlayer fromPlayer, BasePlayer basePlayer

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

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

public virtual void OnMedicalToolApplied(BasePlayer fromPlayer, ItemDefinition itemDef, ItemModConsumable consumable, MedicalTool medicalToolEntity, bool canRevive)
{
	if ((fromPlayer != this && IsWounded()) & canRevive)
	{
		if (Interface.CallHook("OnPlayerRevive", fromPlayer, this) != null)
		{
			return;
		}
		StopWounded(fromPlayer);
	}
	foreach (ItemModConsumable.ConsumableEffect effect in consumable.effects)
	{
		if (effect.type == MetabolismAttribute.Type.Health)
// …

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.