RustTip

OnEntityReskin

OxideCarbonCrafting

Called when entity reskin occurs.

object OnEntityReskin(BaseEntity local3, ulong local5, BasePlayer player)
Works — the game method in this build is the one the hook was written for.

Parameters

local3
BaseEntity
local5
ulong
player
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 OnEntityReskin(BaseEntity local3, ulong local5, BasePlayer player)
{
    Puts("OnEntityReskin");

    // 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 SprayCan.ChangeItemSkin(BaseEntity.RPCMessage)

Passes: BaseEntity local3, ulong local5, BasePlayer player

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

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

// …
}
else
{
	if (!GetItemDefinitionForEntity(baseEntity, out var def, useRedirect: false))
	{
		return;
	}
	ulong targetSkinID = ItemDefinition.FindSkin((def.isRedirectOf != null) ? def.isRedirectOf.itemid : def.itemid, num);
	if (Interface.CallHook("OnEntityReskin", baseEntity, targetSkinID, msg.player) != null)
	{
		return;
	}
	if (!TryFindTargetRedirect(def, num, out var targetRedirect))
	{
		baseEntity.skinID = targetSkinID;
	}
	else
// …

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.