OnWallpaperSet

OxideCarbonStructure

Called when wallpaper set occurs.

object OnWallpaperSet(BuildingBlock buildingBlock, ulong id, int side, float rotation)

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

Parameters

buildingBlock: BuildingBlock
id: ulong
side: int
rotation: float

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 OnWallpaperSet(BuildingBlock buildingBlock, ulong id, int side, float rotation)
{
    Puts("OnWallpaperSet");

    // 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.SetWallpaper(ulong, int, float)

Passes: BuildingBlock buildingBlock, ulong id, int side, float rotation

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

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

public void SetWallpaper(ulong id, int side = 0, float rotation = 0f)
{
	if (Interface.CallHook("OnWallpaperSet", this, id, side, rotation) != null)
	{
		return;
	}
	if (side == 0)
	{
		if (HasWallpaper(side) && wallpaperID == id && wallpaperRotation == rotation)
		{
			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.