Namespace: osi

osi

Version:
  • 1.0
Since:
  • 19/07/2020
Author:
  • Brennan Wilkes
  • 100322326
Source:

Members

(static, constant) ABOUT :number

About index enum
Type:
  • number
Source:

(static, constant) COMPILING :number

Compiling index enum
Type:
  • number
Source:

(static) concept_art :Array.<string>

List of concept art file names
Type:
  • Array.<string>
Source:

(static) currentPage :number

Variable to keep track of which page index is currently displayed
Type:
  • number
Source:

(static, constant) DEVNOTES :number

Dev notes index enum
Type:
  • number
Source:

(static, constant) DOCS :number

Documentation page index enum
Type:
  • number
Source:

(static, constant) GALLERY :number

Gallery index enum
Type:
  • number
Source:

(static, constant) GALLERYPREVIEW :number

Gallery preview image index enum
Type:
  • number
Source:

(static, constant) GENERATOR :number

Generator index enum
Type:
  • number
Source:

(static, constant) HOMEPAGE :number

Homepage index enum
Type:
  • number
Source:

(static) island :object

Storage for generated Island object
Type:
  • object
Source:

(static) pageHistory :number

Array of the most recent visted pages. Used for "back" functionality
Type:
  • number
Source:

(static, constant) SAFARI :boolean

Safari regex detector
Type:
  • boolean
Source:

(static, constant) SOURCES :number

Sources index enum
Type:
  • number
Source:

(static) USING_MOUSE :boolean

Detects if a user is using a mouse for navigation
Type:
  • boolean
Source:

Methods

(static) changePage(page)

Changes directly to a requested page
Parameters:
Name Type Description
page number Page index to change to
Source:

(static) compileEvent(e)

Event handler for compiling island
Parameters:
Name Type Description
e object Event
Source:

(static) compileIsland()

Grabs relavent information from the form, and generates an Island Updates island instead of returning
Source:

(static) copyEvent(e)

"Edit" clone of image in gallery event
Parameters:
Name Type Description
e object Event
Source:

(static) galleryEvent(e)

Event handler for entering image gallery
Parameters:
Name Type Description
e object Event
Source:

(static) getIslandData(id, param, behaviour) → {string}

Gets a specific island param from the database of island with specific idea
Parameters:
Name Type Description
id number ID to query
param string Param to query for
behaviour function Special behaviour to run. If left undefined, value will be returned
Source:
Returns:
data from database
Type
string

(static) imageClickEvent(e)

Event handler for image gallery image clicks
Parameters:
Name Type Description
e object Event
Source:

(static) main()

Main setup function. Prepares the DOM
Source:

(static) saveEvent(e)

Event handler for saving an image. See Island
Parameters:
Name Type Description
e object Event
Source:

(static) setUpButtonClicks()

Builds the button click events that power the sitemap navigation
Source:

(static) setValidMessage(id, message)

Sets an elements HTML5 validation message using a neat JS trick
Parameters:
Name Type Description
id string of element to search for
message string to set
Source:

(static) spawnParticle()

Spawns a random particle to the screen with random coordinates and deletes it after two seconds
Source:

(static) stackPage()

Add the current page to the history stack
Source:

(static) turnPage(dir)

Runs HTML5 form validation, then calls changePage
Parameters:
Name Type Description
dir number forward or backwards / direction to turn
Source: