AxLoader

Summary

AxLoader
Functions
startLoading	Begin loading a folder.
fromBuffers	Gets the archive from the cached buffer and the patch/base buffer.
getVersion	Takes an archive and returns the version number.
isUpdateNeeded	Reads the cached version and determines if it is up to date.
setCached	Sets the cached data for a folder.
getCached	Gets the cached data for a folder.
clearCached	Removes items from the cache.
postProcess	Runs all the functions in the tasks array against all the properties on files.
fileLoadCallback	The callback for when a file is extracted out of the archive.
getAvalibleFileList	Gets a list of the avalible files for download.
getMostAppropriateFile	Gets the file that should be downloaded.
Variables
POST_TASKS	A collection of postprocessing functions for passing to startLoading’s postTasks parameter.
Functions
EVAL_AS_JS	Evaluates a script files in a special way that plays nicely with the debugger.
STRINGIFY	Decode files into strings if they match the passed extionstion.
PARSE_AS_JSON	Decode files into strings if they match the passed extionstion.
USE_AS_CSS	Decode files into strings if they match the passed extionstion.
BASE64IFY	Decode files into base64strings if they match the passed extionstion.
BASE64IFY_FILES_WITH_EXT	Decode files into base64strings if they match the passed extionstion.
REMOVE_FILE_EXTS	Removes file extentions.
EXPAND_FOLDERS	Expands the folder structure of the files in the archive.
Variables
FILTER	Contains post processing tasks that filter out files for other post tasks.
Functions
WITH_EXT	A filter that calls the passed function if the name matches the passed file extention.
WITH_FILE	A filter than calls the passed function if the names match.
WITH_FILE	A filter than calls the passed function if the names match.
WITHOUT	A filter than calls the passed function if the names don’t match.
decodeString	Returns a string from a UTF8 encoded arraybuffer.
decodeBase64	https://developer.mozilla.org/en-US/docs/Web/JavaScript/Base64_encoding_and_decoding
encodeBase64	https://developer.mozilla.org/en-US/docs/Web/JavaScript/Base64_encoding_and_decoding
checkForUpdates	Passes true to the callback if there are updates.

Functions

startLoading

function startLoading( folder,
events,
postTasks )

Begin loading a folder.

Parameters

folder	(String) Which folder to load.
events	(Object) An object containing all the callbacks. (onError, onProgress, onComplete).
postTasks	(Array) A list of things to do to process the data after loading it.

fromBuffers

function fromBuffers( cached,
uptodate,
folder,
events,
postTasks )

Gets the archive from the cached buffer and the patch/base buffer. Calls the onComplete event when done.

Parameters

cached	The cached version of the file.
uptodate	The up to date base version or patch to an up to date version from the cached version.
folder	The name of the origin folder.
events	The events object passed to startLoading.
postTasks	A list of functions to call on each of the files.

getVersion

function getVersion( ar )

Takes an archive and returns the version number.

Parameters

ar	An archive.

Returns

(number) Version number.

isUpdateNeeded

function isUpdateNeeded( filename,
cachedArchive )

Reads the cached version and determines if it is up to date.

Parameters

version

the current up to date version.

Returns

(boolean) True if up to date.

setCached

function setCached( folder,
buffer )

Sets the cached data for a folder.

Parameters

folder	The name of the origin of the buffer.
buffer	The buffer to cache.

getCached

function getCached( folder )

Gets the cached data for a folder.

Parameters

folder

The name of the origin of the buffer.

Retruns

The cached buffer.

clearCached

var clearCached = function ( rest )

Removes items from the cache.

Parameters

rest...

The cached folders to remove.

postProcess

function postProcess( files,
tasks )

Runs all the functions in the tasks array against all the properties on files.

Parameters

files	(Object) An object containing all the file data.
tasks	(Array) An array of functions to call for each file.

fileLoadCallback

The callback for when a file is extracted out of the archive.

Properties

name	(String) The name of the file.
folder	(String) The name of the asset folder wr’re loading
data	(Uint8Array) The binary data of the file.
output	(Object) The data gets put here.

getAvalibleFileList

function getAvalibleFileList( callback )

Gets a list of the avalible files for download.

Parameters

callback

(Function) Callback on done. Takes an array of strings.

getMostAppropriateFile

function getMostAppropriateFile( folder,
cachedVersion,
callback )

Gets the file that should be downloaded. Always picks the file with the highest version number, non-numeric values have a version value of -1. If a patch exists from the cached version to the highest version, that will be picked over the base version.

Parameters

folder	(String) The data being requested
callback	(Function) On done. Takes one parameter, the picked file name.

Variables

POST_TASKS

A collection of postprocessing functions for passing to startLoading’s postTasks parameter.

All of them take the same set of parameters. Parameters: name - the name of the file. data - the data in the file. output - the object onto which the files should be attached.

Functions

EVAL_AS_JS

EVAL_AS_JS: function ( name,
data,
output )

Evaluates a script files in a special way that plays nicely with the debugger.

STRINGIFY

STRINGIFY: function ( name,
data,
output )

Decode files into strings if they match the passed extionstion.

Parameters

ext	The extention to match. Don’t include the dot.

PARSE_AS_JSON

PARSE_AS_JSON: function ( name,
data,
output )

Decode files into strings if they match the passed extionstion.

Parameters

ext	The extention to match. Don’t inclide the dot.

USE_AS_CSS

USE_AS_CSS: function ( name,
data,
output )

Decode files into strings if they match the passed extionstion.

Parameters

ext	The extention to match. Don’t inclide the dot.

BASE64IFY

BASE64IFY: function ( name,
data,
output )

Decode files into base64strings if they match the passed extionstion.

Parameters

mime	the mime type of the file. If included, files will be transformed into a data url, otherwise it will be plain data.

BASE64IFY_FILES_WITH_EXT

Decode files into base64strings if they match the passed extionstion.

Parameters

mime	the mime type of the file.

REMOVE_FILE_EXTS

REMOVE_FILE_EXTS: function ( name,
data,
output )

Removes file extentions.

EXPAND_FOLDERS

EXPAND_FOLDERS: function ( name,
data,
output )

Expands the folder structure of the files in the archive. So for example, if you have a file called “folder/file”, you’ll be able to access it using assets.folder.file instead of assets[“folder/file”].

Variables

FILTER

var FILTER

Contains post processing tasks that filter out files for other post tasks.

Functions

WITH_EXT

WITH_EXT: function ( ext,
f )

A filter that calls the passed function if the name matches the passed file extention.

WITH_FILE

WITH_FILE: function ( n,
f )

A filter than calls the passed function if the names match.

WITH_FILE

A filter than calls the passed function if the names match.

WITHOUT

WITHOUT: function ( re,
f )

A filter than calls the passed function if the names don’t match.

decodeString

function decodeString ( buffer )

Returns a string from a UTF8 encoded arraybuffer. Comes from: https://gist.github.com/boushley/5471599

Parameters

buffer

(ArrayBuffer) The buffer with the encoded string data.

Returns

(String) The string representation of buffer.

decodeBase64

function decodeBase64( sBase64,
nBlocksSize )

Base 64 decoding function from

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Base64_encoding_and_decoding

encodeBase64

function encodeBase64 ( aBytes )

Base 64 encoding function from

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Base64_encoding_and_decoding

checkForUpdates

var checkForUpdates = function ( callback )

Passes true to the callback if there are updates. Applies updates if any. It is safe to call startLoading while checking for updates. It will just wait for it to finish.