Looking for info on the NEXUS faction in the game? It's in the Warzone Encyclopaedia
.suffix()
Determines the appropriate event key suffix based on the passed in object.
Syntax
var suffix = NEXUS.suffix(obj);
Parameters
| Parameter | Mandatory | Type | Notes | NEXUS Version |
|---|---|---|---|---|
| obj |  | Object | The object to to base the suffix on. | v0.1 |
Return value
| Value | Type | Notes | NEXUS Version |
|---|---|---|---|
| <suffix> | String | A string representing the suffix. See documentation for installed Suffix Subroutine for more information and examples. | v0.1 |
| <error> | Error | Is it a bird? Is it a plane? No, it's an Incoming. Laser. Satellite. Strike. | v0.1 and above |
Example
// assuming we have at least one droid var myDroid = enumDroid(me)[0]; var suffix = NEXUS.suffix(myDroid);
See also
- Classify Subroutines – generate object keys
- Suffix Subroutines – add persistent suffix to task names.
A Suffix Subroutine must be installed before you can use this function.
If you pass an 'obj' in to NEXUS() a suffix will automatically be added to the 'taskID', so under normal circumstances you won't need to use NEXUS.suffix() in your code.
Contents
Assimilate:
API Browser
Observe:
- NEXUS() — The API namespace for NEXUS, that doubles up as a function for triggering tasks.
- .infiltrate() — Infiltrates core systems so that NEXUS can absorb them.
- .suffix() — Determines the appropriate event key suffix based on the passed in object.
- .fn — Defines helper functions available to all NEXUS subroutines (and external scripts).
- .actions
- .classify() — Classifies an object using the installed taxonomy in order to derive an "Object Key".
- .default — Stores various defaults for NEXUS subroutines.