Oxygen

OnPlayerMeleeAttack

This hook is triggered when a player performs a melee attack. Returning false will cancel the attack.

Definition

public override bool OnPlayerMeleeAttack(PlayerBase player, string victimName)
{
    return true;
}

Parameters

ParameterTypeDescription
playerPlayerBaseThe instance of the player performing the attack.
victimNamestringThe name of the target entity being attacked.

Return Value

TypeDescription
boolReturn true to allow the attack, or false to cancel it.

Usage Example

public override bool OnPlayerMeleeAttack(PlayerBase player, string victimName)
{
    if (victimName == "SafeZone_Target")
    {
        return false;
    }
    return true;
}

On this page