OnPlayerPveDamage

OxideStructure

object OnPlayerPveDamage(BaseEntity Initiator, HitInfo info, BuildingBlock buildingBlock)

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

Parameters

Initiator: BaseEntity
info: HitInfo
buildingBlock: BuildingBlock

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 OnPlayerPveDamage(BaseEntity Initiator, HitInfo info, BuildingBlock buildingBlock)
{
    Puts("OnPlayerPveDamage");

    // 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 BuildingBlock.Hurt(HitInfo)

Passes: BaseEntity Initiator, HitInfo info, BuildingBlock buildingBlock

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

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

public override void Hurt(HitInfo info)
{
	if (ConVar.Server.pve && (bool)info.Initiator && info.Initiator is BasePlayer)
	{
		if (Interface.CallHook("OnPlayerPveDamage", info.Initiator, info, this) != null)
		{
			return;
		}
		(info.Initiator as BasePlayer).Hurt(info.damageTypes.Total(), DamageType.Generic);
	}
	else
	{
		if ((bool)info.Initiator && info.Initiator is BasePlayer { IsInTutorial: not false })
// …

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.