RustTip

OnNpcConversationStart

OxideCarbonNPC

Called when an npc conversation starts.

object OnNpcConversationStart(NPCTalking nPCTalking, BasePlayer ply, ConversationData local2)
Method changed — check — the game method differs from the one the hook is recorded for in Oxide. The hook is still called, but its place may have shifted — worth checking after an update.

Parameters

nPCTalking
NPCTalking
ply
BasePlayer
local2
ConversationData

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 OnNpcConversationStart(NPCTalking nPCTalking, BasePlayer ply, ConversationData local2)
{
    Puts("OnNpcConversationStart");

    // 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 NPCTalking.Server_BeginTalking(BasePlayer)

Passes: NPCTalking nPCTalking, BasePlayer ply, ConversationData local2

Method changed — checkReturnBehavior: ExitWhenValidTypeArgumentBehavior: UseArgumentString (this, a0, l2)Assembly-CSharp.dll

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

// …
bool flag = num == BaseMission.MissionStatus.Active && ply.HasCompletedMission(num2);
ConversationData inPersonConversationFor = GetInPersonConversationFor(ply);
if (inPersonConversationFor != null)
{
	if (ConversationHost.IsConversingWith(ply))
	{
		OnConversationEnded(ply);
	}
	if (Interface.CallHook("OnNpcConversationStart", this, ply, inPersonConversationFor) != null)
	{
		return;
	}
	ConversationHost.StartConversation(ply);
	string text = inPersonConversationFor.entryPoint.resultingNode;
	if (flag && !ply.IsInTutorial)
	{
		ply.conversationRewardMissionId = num2;
// …

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.