OnTurretToggle

OxideCarbonTurret

Called when a turret toggles.

object OnTurretToggle(AutoTurret autoTurret)

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

Parameters

autoTurret: AutoTurret

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 OnTurretToggle(AutoTurret autoTurret)
{
    Puts("OnTurretToggle");

    // 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.SetIsOnline(bool)

Passes: AutoTurret autoTurret

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: JustThisAssembly-CSharp.dll

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

// …
{
	BaseProjectile attachedWeapon = GetAttachedWeapon();
	if ((bool)attachedWeapon && attachedWeapon is ITurretNotify turretNotify)
	{
		turretNotify.OnAddedRemovedToTurret(online);
	}
	if (online != IsOn())
	{
		if (Interface.CallHook("OnTurretToggle", this) != null)
		{
			return;
		}
		using (FlagsUpdateScope flagsUpdateScope = StartSetFlags(FlagsUpdateMode.SendNetworkUpdate))
		{
			flagsUpdateScope.Set(Flags.On, online);
		}
		OnTurretPowerChanged(online);
// …

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.