Inform

Inform. A library that makes ModPE so easy you'll pass out.

Cooperation

Cooperation is a "module" in Inform that allows you to interact with other scripts. Here is an example:

// cooperation.js
function newLevel() {
  inform.scripts().find('my_awesome_thing.js')
    .call('hookMethod', ['some argument', 'other argument']);
}

The above code calls the method hookMethod defined in the imported script my_awesome_thing.js, with the parameters 'some argument' and 'other argument'.

This means that if my_awesome_thing.js had this code:

// my_awesome_thing.js
function hookMethod(msg1, msg2) {
    clientMessage(msg1 + ' ' + msg2);
}

Then that means that "some argument other argument" would be printed out to chat.

Expect another script to exist

Using cooperation, you can expect another script to exist. This can be handy if your script is supposed to work with other scripts that are supposed to exist, or else your script will not function correctly.

If the script you are trying to find does not exist, then Inform will throw an error.

function newLevel() {
  inform.scripts().expect('lib.js'); // throws an error if it's not found
}

Check if another script exists

You can also check if another script exists, using has().

// ...
inform.scripts().has('file.js'); // returns true if it is found!
// ...

Setting/getting values in other scripts

Using cooperation, you can also set values in other scripts.

function newLevel() {
  inform.scripts().find('other_script.js').set('someVariable', 2);
}

This will set someVariable to equal to 2 in other_script.js

You can also get variables:

inform.scripts().find('other_script.js').get('someVariable');

IMPORTANT NOTE!!

You should use == instead of === when comparing fetched variables because their type (are usually) not preserved.

Checking for defined things

You can also check if something is defined in another script:

inform.scripts().find('other_script.js').defined('newLevel');

That code checks if newLevel is present in other_script.js.

Building

Make sure that you have npm, node, and Grunt installed. If you just want to use Inform, you don't have to do this. Instead, look at the section below.

$ npm install
$ grunt

Output in build/inform.min.js. Unminified in build/inform.js. If you want to build the tests too, you will have to run this instead:

$ grunt develop

Including Inform in your code

Go to here, then copy the whole thing and paste it in the beginning of your script.

lachlandcp / inform