OnInputUpdate

OxideCarbonElectronic

Called when an input is updated.

object OnInputUpdate(IOEntity iOEntity, int inputAmount, int inputSlot)

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

Parameters

iOEntity: IOEntity
inputAmount: int
inputSlot: int

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 OnInputUpdate(IOEntity iOEntity, int inputAmount, int inputSlot)
{
    Puts("OnInputUpdate");

    // 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 IOEntity.UpdateFromInput(int, int)

Passes: IOEntity iOEntity, int inputAmount, int inputSlot

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: AllAssembly-CSharp.dll

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

public virtual void UpdateFromInput(int inputAmount, int inputSlot)
{
	if (Interface.CallHook("OnInputUpdate", this, inputAmount, inputSlot) != null)
	{
		return;
	}
	if (inputs[inputSlot].type != ioType || inputs[inputSlot].type == IOType.Industrial)
	{
		IOStateChanged(inputAmount, inputSlot);
		return;
	}
// …

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.