API: P5 (r1)

This API is for P5 Worlds. It has no Ancient Brain framework. Anything written in P5 should run using this API without change.

This API has the following features:

• Includes P5 graphics library, release 0.7.1.
  • Includes P5 dom and P5 sound (for P5 release 0.7.1).
  • See P5 docs.
• Includes jQuery 3.3.1.
• Loads up lots of CSS - all the CSS used on the AB login pages. At the risk of conflict with user CSS. (Later APIs load up minimal CSS.)

• No Ancient Brain framework.
• World has to do everything. It has to create its own canvas. It has to do its own camera control.
• World author writes normal P5 code, with setup() and draw().
• Run header on RHS. Many P5 worlds use fixed small dimension canvas, which will go in top LHS. So this API puts run header on RHS.
• If World uses Minds, World author must call the Mind themselves inside the draw function:

   AB.mind.getAction ( state );  

• If you turn canvas off ("noCanvas") the API uses the html2canvas library to build a screenshot of your page.
• If you are using "noCanvas", note the html2canvas library has some limitations and may not be able to accurately screenshot your page.

Optional: The "ABWorld" object

This API defines the following "ABWorld" global variable. World authors can ignore the existence of ABWorld entirely.

 

	ABWorld;                 // instance of class ABWorldClass  
 
// Data and methods of ABWorld:
 
	ABWorld.canvas;          // to point to the canvas  		
 
	// useful functions for creating/resizing canvas:

	ABWorld.fullwidth();     // return full width of window on desktop / screen on mobile 
	ABWorld.fullheight();    // return full height of window on desktop / screen on mobile

World code can normally createCanvas() and ignore return. The created canvas should display in the run window. The AB system will find the canvas automatically (e.g. when it needs to do a screenshot). If the canvas does not display normally, or if the AB system fails to find the canvas, you can help it out by creating the canvas as follows:

 

	var canvas = createCanvas ( ... );		 

	ABWorld.setCanvas ( canvas );           // tell the AB system where the canvas is 

Templates

• World with no Mind

• World with Mind
• Mind

Examples

Examples of Worlds that use this API: