OnWallpaperRemove

OxideCarbonStructure

Called when a wallpaper is removed.

object OnWallpaperRemove(BuildingBlock buildingBlock, int side)

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

Parameters

buildingBlock: BuildingBlock
side: 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 OnWallpaperRemove(BuildingBlock buildingBlock, int side)
{
    Puts("OnWallpaperRemove");

    // 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 BuildingBlock.RemoveWallpaper(int)

Passes: BuildingBlock buildingBlock, int side

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

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

public void RemoveWallpaper(int side)
if (Interface.CallHook("OnWallpaperRemove", this, side) != null)
{
	return;
}
{
	switch (side)
	{
	case 0:
		wallpaperHealth = -1f;
// …

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.