API:Functions

The Sphere API is the collective name for the set of bindings (functions, objects, and methods) available for use by all Sphere games. The API provides access to a host of convenient features, allowing you to get up and running quickly.

Making new function/object pages

Simple steps:

1. Before getting started, please check the Article standards and practices.
2. Click a red link.
3. Place the following code in the empty edit box:
   1. For a new function: {{subst:functemp|preamble=REPLACEME|function=REPLACEME|object=REPLACEME|returns=REPLACEME|params=REPLACEME}}
   2. For a new object: {{subst:objecttemp|preamble=REPLACEME|function=REPLACEME|object=REPLACEME|returns=REPLACEME|params=REPLACEME}}
4. Check the minor edit flag and save.
5. Click 'edit' at the top of the page to add content.
6. Try to be objective when writing, and save when you're done.
7. Remove description from this page, add page link to list at the top of the matching section.

Core API

The Core API provides low-level access to the engine's features and includes all bindings provided directly by the engine. These bindings are exposed to the global scope and can be used without importing any extra modules.

Sphere Game Platform

• Sphere.APILevel
• Sphere.Compiler
• Sphere.Engine
• Sphere.Game
• Sphere.Version
• Sphere.frameRate
• Sphere.frameSkip
• Sphere.fullScreen
• Sphere.abort()
• Sphere.now()
• Sphere.restart()
• Sphere.setResolution()
• Sphere.shutDown()
• Sphere.sleep()

Debugging

• SSj.flipScreen()
• SSj.log()
• SSj.trace()

Files and Directories

• new DirectoryStream()
  • DirectoryStream::fileCount
  • DirectoryStream::fileName
  • DirectoryStream::position
  • DirectoryStream::dispose()
  • DirectoryStream::next()
  • DirectoryStream::rewind()
• new FileStream()
  • FileStream::fileName
  • FileStream::fileSize
  • FileStream::position
  • FileStream::dispose()
  • FileStream::read()
  • FileStream::write()
• FS.createDirectory()
• FS.deleteFile()
• FS.directoryExists()
• FS.fileExists()
• FS.fullPath()
• FS.readFile()
• FS.relativePath()
• FS.removeDirectory()
• FS.rename()
• FS.writeFile()

Random Number Generation

• RNG.fromSeed()
• RNG.fromState()
• new RNG()
  • RNG::state
  • RNG::next()

Sphere Runtime

The Sphere Runtime is a standard collection of JavaScript modules included with the engine. Some modules can even be used in Cellscripts as well! Unlike the Core API above which was organized by category, the following list is organized by module. Most modules export only a single object or function; to import more than one at a time, you can use an ES2015 import statement and import objects from the sphere-runtime or cell-runtime module, as appropriate:

In a Sphere game

import { from, Music, Thread } from 'sphere-runtime';

In a Cellscript

import { assert, transpile } from 'cell-runtime';

from Module

• from()
  • from::all()
  • from::allIn()
  • from::any()
  • from::anyIn()
  • from::anyIs()
  • from::ascending()
  • from::besides()
  • from::count()
  • from::descending()
  • from::each()
  • from::first()
  • from::from()
  • from::including()
  • from::last()
  • from::random()
  • from::reduce()
  • from::remove()
  • from::sample()
  • from::select()
  • from::shuffle()
  • from::skip()
  • from::take()
  • from::toArray()
  • from::update()
  • from::where()

image Module

• new Image()
  • Image::blitTo()

logger Module

• new Logger()
  • Logger::beginGroup()
  • Logger::endGroup()
  • Logger::write()

music Module

• Music.adjusting
• Music.adjustVolume()
• Music.override()
• Music.play()
• Music.pop()
• Music.push()
• Music.reset()
• Music.play()

prim Module

• Prim.blit()
• Prim.blitSection()
• Prim.drawCircle()
• Prim.drawEllipse()
• Prim.drawLine()
• Prim.drawPoint()
• Prim.drawRectangle()
• Prim.drawSolidCircle()
• Prim.drawSolidEllipse()
• Prim.drawSolidRectangle()
• Prim.fill()

random Module

• Random.chance()
• Random.discrete()
• Random.normal()
• Random.sample()
• Random.string()
• Random.uniform()

thread Module

• Thread.join()
• Thread.self()
• new Thread()
  • Thread::running
  • Thread::start()
  • Thread::stop()

Miscellaneous

• SphereFS - How the file system prefixes work.