docs(bridge): EventsEnabled's comment says what it gates today
All checks were successful
PR Checks / plugin-checks (pull_request) Successful in 9s

The doc comment on PluginConfig.EventsEnabled still said it "gates
taking a lease only", which stopped being true at protocol 9 when it
began gating every world write (D94). It now lists what the switch
gates as of protocol 14 - a lease, every world write (zones, crates,
NPCs, world calls, Dangerous Treasures, Guarded Crate, raid bases,
console commands), a tally and a run's chat line, and paying coins -
what always works with it off, and that the website can set it without
a reload. Comment only; no behaviour change.

Found while writing the runicgateway.com Rust docs (its PLAN.md §16,
phase 15).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01E14m6SuuY6i1vASFeGDBeY
This commit is contained in:
2026-10-22 15:29:34 -05:00
parent 3c0fcb0003
commit ef9596ce67

View File

@@ -445,12 +445,20 @@ namespace Oxide.Plugins
public string ServerId = "main"; public string ServerId = "main";
/// <summary> /// <summary>
/// Whether the website may borrow values on this server for events (protocol 8, /// Whether the website may run events on this server at all (protocol 8, D76).
/// D76). <b>Off until an operator turns it on.</b> Letting staff moderate from a /// <b>Off until an operator turns it on.</b> Letting staff moderate from a screen
/// screen they are looking at, and letting a schedule change the world at four in /// they are looking at, and letting a schedule change the world at four in the
/// the morning, are different consents, and one switch cannot honestly express /// morning, are different consents, and one switch cannot honestly express both.
/// both. It gates taking a lease only: listing and giving back always work, so /// <para>
/// turning it off never strands a value somebody already borrowed. /// It began as the lease switch and grew with the protocol. It now gates taking a
/// lease (protocol 8), every world write (protocol 9, D94: zones, placed crates and
/// NPCs, and from protocol 14 world calls, Dangerous Treasures, Guarded Crate,
/// raid bases and console commands — <see cref="WorldWritesAllowed"/>), opening a
/// tally and a run's chat line (protocol 10, D107), and paying coins (protocol 14).
/// Listing, giving back, reverting and every read always work, so turning it off
/// never strands anything an event already holds. An admin can set it from the
/// website's config editor, and it takes effect without a reload.
/// </para>
/// </summary> /// </summary>
public bool EventsEnabled = false; public bool EventsEnabled = false;