OnTreeMarkerHit

OxideCarbonEntity

Called when a tree marker hits.

object OnTreeMarkerHit(TreeEntity treeEntity, HitInfo info)

Method changed — check — the game method differs from the one the hook is recorded for in Oxide. The hook is still called, but its place may have shifted — worth checking after an update.

Parameters

treeEntity: TreeEntity
info: HitInfo

Return value

objectThe returned value replaces the game result; null lets the game decide.

Example

object — you can affect the game: return a value to change or cancel the action.

private object OnTreeMarkerHit(TreeEntity treeEntity, HitInfo info)
{
    Puts("OnTreeMarkerHit");

    // change nothing — the game continues as usual
    return null;

    // to affect the game:
    // return false; // your value instead of the game result
}

Works in both Oxide and Carbon: Carbon loads Oxide plugins as is.

Injection point

Rust.opj (Oxide)

bool TreeEntity.DidHitMarker(HitInfo)

Passes: TreeEntity treeEntity, HitInfo info

Method changed — checkReturnBehavior: ExitWhenValidTypeArgumentBehavior: AllAssembly-CSharp.dll

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

public bool DidHitMarker(HitInfo info)
{
	if (xMarker == null)
	{
		return false;
	}
	object returnvar = Interface.CallHook("OnTreeMarkerHit", this, info);
	if (returnvar is bool)
	{
		return (bool)returnvar;
	}
	TreeMarkerData treeMarkerData = PrefabAttribute.server.Find<TreeMarkerData>(prefabID);
	if (treeMarkerData != null)
	{
		if (new Bounds(xMarker.transform.position, Vector3.one * (0.2f + treeMarkerData.HotspotPadding)).Contains(info.HitPositionWorld))
// …

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.