CanUseWires

OxideCarbonPlayer

Called to determine whether to use wires.

Return true to allow the action and false to block it.

object CanUseWires(BasePlayer player, bool cached, float cacheDuration, IOEntity targetIoEnt)

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

Parameters

player: BasePlayer
cached: bool
cacheDuration: float
targetIoEnt: IOEntity

Return value

objectThe returned value replaces the game result; null lets the game decide.

Example

object — you can affect the game: return a value to change or cancel the action.

private object CanUseWires(BasePlayer player, bool cached, float cacheDuration, IOEntity targetIoEnt)
{
    Puts("CanUseWires");

    // change nothing — the game continues as usual
    return null;

    // to affect the game:
    // return false; // your value instead of the game result
}

Works in both Oxide and Carbon: Carbon loads Oxide plugins as is.

Injection point

Rust.opj (Oxide)

bool WireTool.CanPlayerUseWires(BasePlayer, bool, float, IOEntity)

Passes: BasePlayer player, bool cached, float cacheDuration, IOEntity targetIoEnt

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: JustParamsAssembly-CSharp.dll

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

public static bool CanPlayerUseWires(BasePlayer player, bool cached = false, float cacheDuration = 1f, IOEntity targetIoEnt = null)
{
	object returnvar = Interface.CallHook("CanUseWires", player, cached, cacheDuration, targetIoEnt);
	if (returnvar is bool)
	{
		return (bool)returnvar;
	}
	if (player != null && player.IsInCreativeMode && Creative.unlimitedIo)
	{
		return true;
	}
// …

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.