OnEventTrigger

OxideCarbonEntity

Called when event trigger occurs.

object OnEventTrigger(TriggeredEventPrefab triggeredEventPrefab)

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

Parameters

triggeredEventPrefab: TriggeredEventPrefab

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 OnEventTrigger(TriggeredEventPrefab triggeredEventPrefab)
{
    Puts("OnEventTrigger");

    // 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 TriggeredEventPrefab.RunEvent()

Passes: TriggeredEventPrefab triggeredEventPrefab

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: JustThisAssembly-CSharp.dll

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

public override void RunEvent()
{
	if (Interface.CallHook("OnEventTrigger", this) != null)
	{
		return;
	}
	Debug.Log("[event] " + targetPrefab.resourcePath);
	BaseEntity baseEntity = GameManager.server.CreateEntity(targetPrefab.resourcePath);
	if ((bool)baseEntity)
	{
		baseEntity.SendMessage("TriggeredEventSpawn", SendMessageOptions.DontRequireReceiver);
// …

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.