OnCardSwipe

OxideCarbonElectronic

Called when card swipe occurs.

object OnCardSwipe(CardReader cardReader, Keycard local2, BasePlayer local0)

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

Parameters

cardReader: CardReader
local2: Keycard
local0: 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 OnCardSwipe(CardReader cardReader, Keycard local2, BasePlayer local0)
{
    Puts("OnCardSwipe");

    // 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 CardReader.ServerCardSwiped(BaseEntity.RPCMessage)

Passes: CardReader cardReader, Keycard local2, BasePlayer local0

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: UseArgumentString (this, l2, l0)Assembly-CSharp.dll

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

// …
}
NetworkableId uid = msg.read.EntityID();
Keycard keycard = BaseNetworkable.serverEntities.Find(uid) as Keycard;
Effect.server.Run(swipeEffect.resourcePath, audioPosition.position, Vector3.up, player.net.connection);
if (keycard == null)
{
	return;
}
if (Interface.CallHook("OnCardSwipe", this, keycard, player) != null)
{
	return;
}
Item item = keycard.GetItem();
if (item == null || item.parent.playerOwner != player)
{
	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.