API Reference

IgeAnimationComponent CLASS

Declared in IgeAnimationComponent.js, Extends IgeEventingClass

The animation component class. Handles defining and controlling frame-based animations based on cells from a texture.

Methods

  • define (String id, Array frames, Number fps, Number loop, Boolean convertIdsToIndex)
  • defined (String id)
  • init (Object entity, Object options)
  • playing ()
  • remove (String id)
  • select (String animId, Object options)
  • setAllFps (Number fps)
  • setFps (String id, Number fps)
  • start (String animId, Object options)
  • stop ()

IgeAudioComponent CLASS

Declared in IgeAudioComponent.js, Extends IgeEventingClass

Manages audio mixing and output.

Methods

IgeBaseScene CLASS

Declared in IgeBaseScene.js, Extends IgeSceneGraph

When loaded into memory using ige.addGraph('IgeBaseScene') will create the scene "baseScene" and the viewport "vp1" that are used in almost all examples and can be used as the base for your scenegraph as well.

Methods

IgeBox2dComponent CLASS

Declared in IgeBox2dComponent.js, Extends IgeEventingClass

The engine's box2d component class.

Methods

IgeBox2dMultiWorldComponent CLASS

Declared in IgeBox2dMultiWorldComponent.js, Extends IgeEventingClass

The engine's box2d multi-world component class.

Methods

IgeCamera CLASS

Declared in IgeCamera.js, Extends IgeEntity

Creates a new camera that will be attached to a viewport.

Methods

IgeCellSheet CLASS

Declared in IgeCellSheet.js, Extends IgeTexture

Creates a new cell sheet. Cell sheets are textures that are automatically split up into individual cells based on a cell width and height.

Methods

IgeClass CLASS

Declared in IgeClass.js

The base class system.

Methods

IgeEditorComponent CLASS

Declared in IgeEditorComponent.js, Extends IgeEventingClass

When added to a viewport, automatically adds entity rotate capabilities to the selected entity in the scenegraph viewer.

Methods

IgeEditorRotateComponent CLASS

Declared in IgeEditorRotateComponent.js, Extends IgeEventingClass

When added to a viewport, automatically adds entity rotate capabilities to the selected entity in the scenegraph viewer.

Methods

IgeEditorTranslateComponent CLASS

Declared in IgeEditorTranslateComponent.js, Extends IgeEventingClass

When added to a viewport, automatically adds entity translate capabilities to the selected entity in the scenegraph viewer.

Methods

IgeEngine CLASS

Declared in IgeEngine.js, Extends IgeEntity

The base engine class definition.

Methods

IgeEntity CLASS

Declared in IgeEntity.js, Extends IgeObject

Creates an entity and handles the entity's life cycle and all related entity actions / methods.

Methods

IgeEntityBox2d CLASS

Declared in IgeEntityBox2d.js, Extends IgeEntity

Creates a new entity with box2d integration.

Methods

IgeEntityCannon CLASS

Declared in IgeEntityCannon.js, Extends IgeEntity

Creates a new entity with CANNON 3d physics integration.

IgeEventingClass CLASS

Declared in IgeEventingClass.js, Extends IgeClass

Creates a new class with the capability to emit events.

Methods

  • emit (Object eventName, Object || Array args)
  • eventList ()
  • off (Boolean eventName, Object evtListener, Function callback)
  • on (String || Array eventName, Function call, Object context, Boolean oneShot, Boolean sendEventName)

IgeFSM CLASS

Declared in IgeFSM.js, Extends IgeClass

A simple finite state machine implementation.

Methods

IgeFontEntity CLASS

Declared in IgeFontEntity.js, Extends IgeUiEntity

Creates a new font entity. A font entity will use a font sheet (IgeFontSheet) or native font and render text.

Methods

IgeFontSheet CLASS

Declared in IgeFontSheet.js, Extends IgeTexture

Creates a new font sheet. A font sheet is an image that contains letters and numbers rendered to specifications. It allows you to use and render text fonts without the font actually existing on the target system that the engine is running in.

Methods

IgeInterval CLASS

Declared in IgeInterval.js, Extends IgeEventingClass

Provides an alternative to setInterval() which works based on the engine's internal time system allowing intervals to fire correctly, taking into account pausing the game and differences in rendering speed etc.

Methods

IgeMap2d CLASS

Declared in IgeMap2d.js, Extends IgeClass

Creates a new map that has two dimensions (x and y) to it's data.

Methods

IgeMapStack2d CLASS

Declared in IgeMapStack2d.js, Extends IgeClass

Creates a new map that has two dimensions (x and y) to it's data and allows multiple items to be stored or "stacked" on a single x, y map position.

Methods

IgeMousePanComponent CLASS

Declared in IgeMousePanComponent.js, Extends IgeEventingClass

When added to a viewport, automatically adds mouse panning capabilities to the viewport's camera.

Methods

IgeMouseZoomComponent CLASS

Declared in IgeMouseZoomComponent.js, Extends IgeEventingClass

When added to a viewport, automatically adds mouse zooming capabilities to the viewport's camera.

Methods

IgeObject CLASS

Declared in IgeObject.js, Extends IgeEventingClass

Creates a new object.

Methods

IgeParticleEmitter CLASS

Declared in IgeParticleEmitter.js, Extends IgeUiEntity

Creates a new particle emitter.

Methods

IgePathComponent CLASS

Declared in IgePathComponent.js, Extends IgeEventingClass

Handles entity path traversal.

Methods

IgePathFinder CLASS

Declared in IgePathFinder.js, Extends IgeEventingClass

Creates a new path using the A* path-finding algorithm.

Methods

IgePathNode CLASS

Declared in IgePathNode.js, Extends IgePoint3d

Creates a new path node for use with the IgePathFinder class.

Methods

  • init (Number x, Number y, Number g, Number moveCost, Number h, Object parent, String direction)
  • mode (Number val)

IgePoint2d CLASS

Declared in IgePoint2d.js, Extends IgeClass

Creates a new 2d point (x, y).

Methods

IgePoint3d CLASS

Declared in IgePoint3d.js, Extends IgeClass

Creates a new 3d point (x, y, z).

Methods

IgePoly2d CLASS

Declared in IgePoly2d.js, Extends IgeClass

Creates a new 2d polygon made up of IgePoint2d instances.

Methods

IgeRect CLASS

Declared in IgeRect.js, Extends IgeClass

Creates a new rectangle (x, y, width, height).

Methods

IgeScene2d CLASS

Declared in IgeScene2d.js, Extends IgeEntity

Creates a new 2d scene.

Methods

IgeSpriteSheet CLASS

Declared in IgeSpriteSheet.js, Extends IgeTexture

Creates a new sprite sheet that cuts an image up into arbitrary sections.

Methods

IgeStreamComponent CLASS

Declared in IgeStreamComponent.js, Extends IgeEventingClass

Adds stream capabilities to the network system.

Methods

IgeTexture CLASS

Declared in IgeTexture.js, Extends IgeEventingClass

Creates a new texture.

Methods

IgeTextureAtlas CLASS

Declared in IgeTextureAtlas.js, Extends IgeTextureMap

Texture maps provide a way to display textures across a tile map.

Methods

IgeTextureMap CLASS

Declared in IgeTextureMap.js, Extends IgeTileMap2d

Texture maps provide a way to display textures / cells across a tile map.

Methods

IgeTileMap2d CLASS

Declared in IgeTileMap2d.js, Extends IgeEntity

Tile maps provide a way to align mounted child objects to a tile-based grid. NOTE: These are not to be confused with IgeTextureMap's which allow you to paint a bunch of tiles to a grid.

Methods

IgeTiledComponent CLASS

Declared in IgeTiledComponent.js, Extends IgeClass

Loads slightly modified Tiled-format json map data into the Isogenic Engine.

Methods

IgeTimeout CLASS

Declared in IgeTimeout.js, Extends IgeInterval

Provides an alternative to setTimeout() which works based on the engine's internal time system allowing timeouts to fire correctly, taking into account pausing the game and differences in rendering speed etc.

Methods

IgeTween CLASS

Declared in IgeTween.js, Extends IgeClass

Creates a new tween instance.

Methods

IgeTweenComponent CLASS

Declared in IgeTweenComponent.js, Extends IgeClass

This component is already included in the IgeEngine (ige) instance and is not designed for use in any other way! It handles global tween processing on all tweening values.

Methods

IgeUiElement CLASS

Declared in IgeUiElement.js, Extends IgeUiEntity

Creates a new UI element. UI elements use more resources and CPU than standard IgeEntity instances but provide a rich set of extra positioning and styling methods as well as reacting to styles defined using the IgeUiManagerComponent.

Methods

IgeUiEntity CLASS

Declared in IgeUiEntity.js, Extends IgeEntity

Creates a new UI entity. UI entities use more resources and CPU than standard IgeEntity instances so only use them if an IgeEntity won't do the job.

Methods

    IgeUiLabel CLASS

    Declared in IgeUiLabel.js, Extends IgeUiElement

    Provides a UI label entity. Basic on-screen text label.

    Methods

    IgeUiMenu CLASS

    Declared in IgeUiMenu.js, Extends IgeUiElement

    Provides a UI drop-down menu entity.

    Methods

    IgeUiTextBox CLASS

    Declared in IgeUiTextBox.js, Extends IgeUiElement

    Provides a UI text entry box. When provided with focus this UI entity will capture keyboard input and display it, similar in usage to the HTML input text element.

    Methods

    IgeUiTooltip CLASS

    Declared in IgeUiTooltip.js, Extends IgeUiElement

    Provides a UI tooltip. Change properties (textBox, fonts, backgroundcolor) at free will.

    Methods

    • fontSheet ( fontSheet)
    • height ( px, lockAspect, modifier, noUpdate)
    • init ( parent, mountEntity, width, height, content)
    • setContent ( val)
    • width ( px, lockAspect, modifier, noUpdate)

    IgeViewport CLASS

    Declared in IgeViewport.js, Extends IgeEntity

    Creates a new viewport.

    Methods

    NetIo.Class CLASS

    Declared in index.js, Extends NetIo.EventingClass

    Define the class system.

    Methods

    © Copyright 2013 Irrelon Software Limited. All Rights Reserved. UK Registered Company Number: 07522767
    Isogenic (ī´sōjen´ik): Adj originating from a common source; possessing the same genetic composition.
    Strange Things Happen at the One Two Point