CanEntityBeHostile

OxideCarbonEntity

Called to determine whether to entity be hostile.

Return true to allow the action and false to block it.

object CanEntityBeHostile(BaseCombatEntity baseCombatEntity)
object CanEntityBeHostile(BasePlayer basePlayer)

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

Parameters

baseCombatEntity: BaseCombatEntity

Return value

objectThe returned value replaces the game result; null lets the game decide.

Example

object — you can affect the game: return a value to change or cancel the action.

private object CanEntityBeHostile(BaseCombatEntity baseCombatEntity)
{
    Puts("CanEntityBeHostile");

    // change nothing — the game continues as usual
    return null;

    // to affect the game:
    // return false; // your value instead of the game result
}

Works in both Oxide and Carbon: Carbon loads Oxide plugins as is.

Injection point 1

Rust.opj (Oxide)

bool BaseCombatEntity.IsHostile()

Passes: BaseCombatEntity baseCombatEntity

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: JustThisAssembly-CSharp.dll

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

public virtual bool IsHostile()
{
	object returnvar = Interface.CallHook("CanEntityBeHostile", this);
	if (returnvar is bool)
	{
		return (bool)returnvar;
	}
	return unHostileTime > Time.realtimeSinceStartup;
}

Injection point 2

Rust.opj (Oxide)

bool BasePlayer.IsHostile()

Passes: BasePlayer basePlayer

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: JustThisAssembly-CSharp.dll

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

public override bool IsHostile()
{
	object returnvar = Interface.CallHook("CanEntityBeHostile", this);
	if (returnvar is bool)
	{
		return (bool)returnvar;
	}
	return State.unHostileTimestamp > TimeEx.currentTimestamp;
}

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.