OnMissionStart

OxideCarbonMission

Called when a mission starts.

object OnMissionStart(BaseMission baseMission, BaseMission.MissionInstance instance, BasePlayer assignee)

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

baseMission: BaseMission
instance: BaseMission.MissionInstance
assignee: BasePlayer

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 OnMissionStart(BaseMission baseMission, BaseMission.MissionInstance instance, BasePlayer assignee)
{
    Puts("OnMissionStart");

    // 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 BaseMission.MissionStart(BaseMission.MissionInstance, BasePlayer)

Passes: BaseMission baseMission, BaseMission.MissionInstance instance, BasePlayer assignee

Method changed — checkReturnBehavior: ExitWhenValidTypeArgumentBehavior: AllAssembly-CSharp.dll

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

public virtual void MissionStart(MissionInstance instance, BasePlayer assignee)
{
	if (Interface.CallHook("OnMissionStart", this, instance, assignee) != null)
	{
		return;
	}
	for (int i = 0; i < objectives.Length; i++)
	{
		if (!instance.IsObjectiveOmitted(i))
		{
			objectives[i].Get().MissionStarted(i, instance, assignee);
// …

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.