RustTip

OnTurretIdentifierSet

OxideCarbonTurret

Called when turret identifier set occurs.

object OnTurretIdentifierSet(AutoTurret autoTurret, BasePlayer player, string newID)
Works — the game method in this build is the one the hook was written for.

Parameters

autoTurret
AutoTurret
player
BasePlayer
newID
string

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 OnTurretIdentifierSet(AutoTurret autoTurret, BasePlayer player, string newID)
{
    Puts("OnTurretIdentifierSet");

    // 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 AutoTurret.SetID(BasePlayer, string, string, bool)

Passes: AutoTurret autoTurret, BasePlayer player, string newID

WorksReturnBehavior: ExitWhenNonNullArgumentBehavior: UseArgumentString (this, a0, a2)Assembly-CSharp.dll

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

public void SetID(BasePlayer player, string oldID, string newID, bool bypassChecks = false)
{
	if ((CanChangeID(player) || bypassChecks) && (string.IsNullOrEmpty(oldID) || ComputerStation.IsValidIdentifier(oldID)) && ComputerStation.IsValidIdentifier(newID) && oldID == GetIdentifier())
	{
		if (Interface.CallHook("OnTurretIdentifierSet", this, player, newID) != null)
		{
			return;
		}
		Debug.Log("SetID success!");
		UpdateIdentifier(newID);
	}
}

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.