RustTip

OnPhotoCapture

OxideCarbonEntity

Called when photo capture occurs.

object OnPhotoCapture(PhotoEntity local5, Item local1, BasePlayer local0, byte[] local2)
Works — the game method in this build is the one the hook was written for.

Parameters

local5
PhotoEntity
local1
Item
local0
BasePlayer
local2
byte[]

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 OnPhotoCapture(PhotoEntity local5, Item local1, BasePlayer local0, byte[] local2)
{
    Puts("OnPhotoCapture");

    // 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 InstantCameraTool.TakePhoto(BaseEntity.RPCMessage)

Passes: PhotoEntity local5, Item local1, BasePlayer local0, byte[] local2

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

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

// …
	return;
}
if (!(baseNetworkable is PhotoEntity photoEntity))
{
	item2.Remove();
	Debug.LogError("Sub-entity is not a photo");
	return;
}
if (Interface.CallHook("OnPhotoCapture", local5, item, player, array) != null)
{
	return;
}
photoEntity.SetImageData(player.userID, array);
Analytics.Azure.OnUGCCreated(player, photoEntity, "photo", array.Length);
if (!player.inventory.GiveItem(item2))
{
	item2.Drop(player.GetDropPosition(), player.GetDropVelocity());
// …

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.