RustTip

CanHackCrate

OxideCarbonPlayer

Called to determine whether to hack crate.

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

object CanHackCrate(BasePlayer player, HackableLockedCrate hackableLockedCrate)
Works — the game method in this build is the one the hook was written for.

Parameters

player
BasePlayer
hackableLockedCrate
HackableLockedCrate

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 CanHackCrate(BasePlayer player, HackableLockedCrate hackableLockedCrate)
{
    Puts("CanHackCrate");

    // 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 HackableLockedCrate.RPC_Hack(BaseEntity.RPCMessage)

Passes: BasePlayer player, HackableLockedCrate hackableLockedCrate

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: UseArgumentString (a0.player, this)Assembly-CSharp.dll

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

[RPC_Server]
[RPC_Server.IsVisible(3f)]
public void RPC_Hack(RPCMessage msg)
{
	if (!IsBeingHacked() && !IsFullyHacked())
	{
		if (Interface.CallHook("CanHackCrate", msg.player, this) != null)
		{
			return;
		}
		Analytics.Azure.OnLockedCrateStarted(msg.player, this);
		originalHackerPlayerId = msg.player.userID;
		if (!string.IsNullOrEmpty(achievementStartHacking))
		{
			msg.player?.GiveAchievement(achievementStartHacking);
// …

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.