RustTip

OnNpcTargetSense

OxideCarbonNPC

Called when npc target sense occurs.

object OnNpcTargetSense(BaseEntity owner, BaseEntity ent, AIBrainSenses brainSenses)
Works — the game method in this build is the one the hook was written for.

Parameters

owner
BaseEntity
ent
BaseEntity
brainSenses
AIBrainSenses

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 OnNpcTargetSense(BaseEntity owner, BaseEntity ent, AIBrainSenses brainSenses)
{
    Puts("OnNpcTargetSense");

    // 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 Rust.Ai.SimpleAIMemory.SetKnown(BaseEntity, BaseEntity, AIBrainSenses)

Passes: BaseEntity owner, BaseEntity ent, AIBrainSenses brainSenses

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

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

public void SetKnown(BaseEntity ent, BaseEntity owner, AIBrainSenses brainSenses)
{
	if (Interface.CallHook("OnNpcTargetSense", owner, ent, brainSenses) != null)
	{
		return;
	}
	IAISenses iAISenses = owner as IAISenses;
	BasePlayer basePlayer = ent as BasePlayer;
	if (basePlayer != null && PlayerIgnoreList.Contains(basePlayer))
	{
		return;
// …

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.