Versions Compared

Old Version 6

changes.mady.by.user Aubergine

Saved on

compared with

New Version 7

changes.mady.by.user Aubergine

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt

Infiltrates core systems so that NEXUS can absorb them.

 

Syntax

Code Block
themeRDark
languagejavascript
linenumberstrue
// perform all automatic infiltrations
var success = NEXUS.infiltrate();
 
// perform manual infiltration
var success = NEXUS.infiltrate(system[,infectdisconnect[,obj]]);

Parameters

ParameterMandatoryTypeNotesNEXUS Version
system(error)String

If specified, only the specified system will be infiltrated or disconnected based on the "connect" parameter.

If not specified, all automatic infiltrations will be performed.

v0.1

connect(error)Boolean

This parameter only takes effect if a "system" has been specified:

  • true – infiltrate the specified system
  • false – disconnect from the specified system

Defaults to true.

Note that some systems cannot be disconnected once they have been infiltrated.

 
obj(error) This parameter only takes effect if a "system" has been specified, and defines an optional object to pass to the .test(), .connect() or .disconnect() function associated with the system. 

Return value

ValueTypeNotesNEXUS Version
trueBoolean

The system was successfully infiltrated.

NEXUS will now automatically trigger tasks when the system accessed.

v0.1 and above
falseBoolean

The infiltration or disconnection was unsuccessful.

Possible causes:

  • System (if specified) not found
  • System (if specified) already infiltrated or disconnected
  • Unable to disconnect from system (if specified)
  • Automatic infiltrations already performed (if no system specified)
v0.1 and above
nullNullNo disconnect function was found when trying to disconnect from a system.v0.1 and above
undefinedUndefinedThe specified system definition was not found.v0.1 and above
<error>ErrorIs it a bird? Is it a plane? No, it's an Incoming. Laser. Satellite. Strike.v0.1 and above

Example

Code Block
themeRDark
languagejavascript
linenumberstrue
// perform all automatic infiltrations
NEXUS.infiltrate();
 
// perform specific system infiltration
NEXUS.infiltrate("whatever");
 
// disconnect from specific system
NEXUS.infiltrate("whatever",false);

See also

Div
classbox notice

An Infiltrate Subroutine must be installed before you can use this function. 

Div
classbox

Contents

Assimilate:

Table of Contents
excludeContents

 

Div
classbox

API Browser

Observe:

Child pages (Children Display)
alltrue
depthall
pageAPI
excerpttrue