Skip to main content

API Reference

The nexSys global is the primary API surface. It exposes state models, helpers, and queue utilities.

Core​

nexSys.version; // "2.2.7"
nexSys.evt; // EventTarget for UI events
nexSys.component; // React dialog component

System state​

nexSys.sys.isPaused();
nexSys.sys.pause();
nexSys.sys.unpause();
nexSys.sys.slowOn();
nexSys.sys.slowOff();

nexSys.sys.setTarget("Kerrang");
nexSys.sys.isTarget("Kerrang");

Afflictions​

nexSys.getCurrentAffs();

nexSys.haveAff("asthma");
nexSys.haveAffs(["asthma", "slickness"]);
nexSys.haveAnAff(["aeon", "paralysis"]);

nexSys.affPrioSwap("asthma", 2);

Affliction state is also available via nexSys.affs, which contains instances of Aff, AffTimed, and AffCountable.

Defences​

nexSys.getCurrentDefs();

nexSys.haveDef("shield");

nexSys.defPrioSwap("shield", 5);

nexSys.defup();
nexSys.defoff();

nexSys.parry("rl"); // right leg

Balances​

nexSys.getCurrentBals();

nexSys.haveBal("balance");
nexSys.haveBals(["balance", "equilibrium"]);
nexSys.haveABal(["balance", "equilibrium"]);

Balances are exposed via nexSys.bals and include timer information.

Queues​

nexSys.classQueue.add("queue add class attack");
nexSys.freeQueue.prepend(["stand", "sip health"]);

nexSys.fullQueue.clearQueue();

Cache​

nexSys.getCacheOutputs(nexSys.getCurrentAffs());

Cache definitions and mapping tables are available via:

  • nexSys.cacheTable
  • nexSys.tables.herb_name_to_herb
  • nexSys.tables.herb_to_mineral
  • nexSys.tables.mineral_to_herb

Utilities​

nexSys.sendCmd("look");
nexSys.sendInline(["score", "who"]);

nexSys.replace("text", "white", "", "more", "green", "");

nexSys.tabCompletion.tc();

UI and settings​

nexSys.updateAndSaveModel("systemSettings", nexSys.sys.settings);

nexSys.loadCustomSettings();

Classes​

Core model classes are exposed at nexSys.classes:

  • Aff, AffTimed, AffCountable, AffDef
  • Def, DefServerside
  • Balance, BalExtended
  • Cache, Queue, Trackable, Timer, Priority, Priorityqueue

Use these if you build extensions or integrate with other packages.