GameExtended

Whether game should autospawn player when a new level is loaded. IMPORTANT: this only works when ig.GameExtended#playerClass is set or when player is persistent and the player has been spawned once already!

Source:

• game.js, line 205

See:

• ig.CONFIG.AUTO_SPAWN_PLAYER

Camera used for screen control.
- created on init.

Source:

• game.js, line 263

Class of camera to use when creating ig.GameExtended#camera.

Source:

• game.js, line 249

Settings to merge into ig.GameExtended#camera on init.

Default Value:

• null

Source:

• game.js, line 256

Whether game can search for player by class in ig.GameExtended#getPlayer.

Default Value:

• true

Source:

• game.js, line 220

Whether game can search for player by type in ig.GameExtended#getPlayer.

Default Value:

• true

Source:

• game.js, line 228

Whether game has changed since last update.

Source:

• game.js, line 137

Whether game lights have changed since last update.

Source:

• game.js, line 144

Color to clear screen with.

Source:

• game.js, line 312

See:

• ig.CONFIG.CLEAR_COLOR

Whether game is deferring add, remove, level changing, etc. Tip: this property is briefly set to false during game update when all deferred items are processed.

Source:

• game.js, line 166

Whether game has added or removed entities since last update.

Source:

• game.js, line 151

Whether game has added or removed lights since last update.

Source:

• game.js, line 158

List of entities across all layers, repopulated during update and only when layers have changed.

Source:

• game.js, line 181

Gravity magnitude in positive y direction.

Source:

• game.js, line 242

Whether game has a level currently. Tip: this property is briefly set to false when levels are changing.

Source:

• game.js, line 174

List of layers, sorted by zIndex.

Source:

• game.js, line 103

Layers mapped by name.

Source:

• game.js, line 109

List of lights across all layers, repopulated during update and only when layers have changed.

Source:

• game.js, line 235

Map of entities by name across all layers.

Source:

• game.js, line 189

See:

• ig.EntityExtended#name

Signal dispatched when game is paused.
- created on init.

Source:

• game.js, line 298

Signal dispatched when game is unpaused.
- created on init.

Source:

• game.js, line 305

Map used for pathfinding.

Default Value:

• null

Source:

• game.js, line 291

Whether game is paused. IMPORTANT: does not guarantee that all layers are paused or unpaused!

Source:

• game.js, line 123

Whether pause state is locked.
- set directly or use ig.Game#pause and {@link ig.Game#paused} to toggle lock.

Source:

• game.js, line 130

Map of entities by name across all layers that are persistent within the game, i.e. able to change levels.

Source:

• game.js, line 197

See:

• ig.EntityExtended#persistent

The player class to spawn when using ig.GameExtended#autoSpawnPlayer. Tip: if you don't want player to auto spawn at the start of the game, but you do want player to spawn on every level after game starts, leave this empty, spawn player manually once, and make sure player is ig.EntityExtended#persistent.

Default Value:

• null

Source:

• game.js, line 213

Player manager used to control the player character.
- created on init.

Source:

• game.js, line 284

Class of player manager to use when creating ig.GameExtended#playerManager.

Source:

• game.js, line 270

Settings to merge into ig.GameExtended#playerManager on init.

Default Value:

• null

Source:

• game.js, line 277

Shape(s) of the level inner boundary, used for ig.GameExtended#insideLevel checks.

Source:

• game.js, line 97

Passes to extract shapes from collision map.
- shapes are extracted during ig.GameExtended#loadLevel via ig.GameExtended#createShapes Tip: Impact++ can automatically convert collision maps into shapes (vertices, edges, etc), via shapesPasses.

Default Value:

• gets climbable shapes using options [ { ignoreSolids: true, ignoreOneWays: true } ]

Source:

• game.js, line 80

See:

• ig.utilstile.shapesFromCollisionMap
• ig.utilstile

// will skip extracting shapes from collision map
game.shapesPasses = null;
// after level is loaded, get all edge shapes for lighting
game.shapesPasses = {
     lighting: {
         ignoreClimbables: true,
         discardBoundaryInner: true
     }
};
// after level is loaded, get all climbable shapes
game.shapesPasses = {
     climbables: {
         ignoreSolids: true,
         ignoreOneWays: true
     }
};
// note that by default, Impact++ extracts
// the level boundary inner edge loop
// and all climbable shapes

Method to sort layers by. Defaults to z index sort.

Source:

• game.js, line 115

Deferred add of an item to a layer. IMPORTANT: to create an entity, use ig.GameExtended#spawnEntity.

Source:

• game.js, line 1224

// add item to a different layer than it is on
settings.layerName = 'otherLayer';
// add is actually for changing between layers
settings.forChange = true;

Adds a layer to the active layer list.

Source:

• game.js, line 886

Builds a level immediately. IMPORTANT: for proper stability, use ig.GameExtended#loadLevelDeferred instead.

Source:

• game.js, line 561

Defers build of ig.Game#_levelToBuild. IMPORTANT: for proper stability, use ig.GameExtended#loadLevelDeferred instead.

Source:

• game.js, line 547

Deferred layer settings change.

Source:

• game.js, line 1005

Clears ALL ig.EntityExtended#persistent entities from game cache. IMPORTANT: this does NOT kill the entity.

Source:

• game.js, line 1188

Clears a ig.EntityExtended#persistent entity by name from the game cache, allowing it to be fully reset. IMPORTANT: this does NOT kill the entity.

Source:

• game.js, line 1157

Converts collision map to shapes.

Source:

• game.js, line 821

Draws game.
- clears canvas
- records rounded screen pos
- draws all layers

Source:

• game.js, line 2431

Draws all entities (items) on a layer. IMPORTANT: normally, you will not need to call this function.

Source:

• game.js, line 2459

Flags an entity as killed. Can be used before removal to facilitate death animations.

Source:

• game.js, line 1202

Gets all characters of a particular group.

Source:

• game.js, line 1749

See:

• ig.GameExtended#getEntitiesMatching

Gets all entities of a particular class. IMPORTANT: the name is misleading, but this does not search by ig.EntityExtended.TYPE.

Source:

• game.js, line 1680

See:

• ig.GameExtended#getEntitiesMatching

Gets all entities of a particular group.

Source:

• game.js, line 1729

See:

• ig.GameExtended#getEntitiesMatching

Gets all entities of a particular type. IMPORTANT: this method no longer searches for entities by class, but by their {@ig.EntityExtended#type} property. To search by class, use {@ig.GameExtended#getEntitiesByClass}.

Source:

• game.js, line 1709

See:

• ig.GameExtended#getEntitiesMatching

Gets all matching entities.

Source:

• game.js, line 1818

// the search takes a match function and plain settings object
// each entity is passed to the match function
// if the function returns true, entity is matched
// and the settings control the search
// search only the entities layer
game.getEntitiesMatching( matchBy, {
     layerName: 'entities'
});
// get only the first
game.getEntitiesMatching( matchBy, {
     first: true
});
// skip sorting search results
game.getEntitiesMatching( matchBy, {
     unsorted: true
});
// sort results by distance from 100, 100 instead of the game's sortBy
// this requires the 'from' property
game.getEntitiesMatching( matchBy, {
     byDistance: true,
     from: { x: 100, y: 100 }
});
// sort results by distance from myCharacter
// this requires the 'from' property
game.getEntitiesMatching( matchBy, {
     byDistance: true,
     from: myCharacter
});
// only get entities that are within distance squared
// this requires the 'from' property
game.getEntitiesMatching( matchBy, {
     distanceSquared: 10000,
     from: myCharacter
});
// only get entities that intersect bounds
game.getEntitiesMatching( matchBy, {
     minX: myCharacter.pos.x,
     minY: myCharacter.pos.x,
     maxX: myCharacter.pos.x + myCharacter.size.x,
     maxY: myCharacter.pos.y + myCharacter.size.y
});
// only get entities in line of sight
game.getEntitiesMatching( matchBy, {
     lineOfSight: true
});
// only get entities that are not hidden
game.getEntitiesMatching( matchBy, {
     nonHidden: true
});

Gets a map by matching name.

Source:

• game.js, line 1964

Get the player object. This method searches for name, then class if ig.GameExtended#canSearchForPlayerByClass, then type if ig.GameExtended#canSearchForPlayerByType.

Source:

• game.js, line 1662

Handles input just before entities are updated. If a tap targets a UI element, it will intercept that tap and nothing else will receive it.

Source:

• game.js, line 2199

Initializes game.
- creates camera
- creates signals
- sets layer sort method
- adds layer: backgroundMaps as a map layer with no update
- adds layer: lights
- adds layer: entities
- adds layer: foregroundMaps as a map layer with no update
- adds layer: overlayas an auto sorted layer
- adds layer: ui as an auto sorted layer that cannot be paused
- starts listening for window resize

Source:

• game.js, line 349

Ends input by removing all bindings set in ig.GameExtended#inputStart.

Source:

• game.js, line 2160

Starts input by setting up some default bindings. IMPORTANT: this method is called automatically on game init!

Source:

• game.js, line 2121

// inputStart sets up bindings
// including:
// WASD, ARROWS, Spacebar Jump
// gestures like touch, tap, hold, swipe
// for example touch is bound to both mouse keys
ig.input.bind(ig.KEY.MOUSE1, 'touch');
ig.input.bind(ig.KEY.MOUSE2, 'touch');
// and tap is used in place of click
// to support both desktop and mobile devices
ig.input.bind(ig.KEY.TAP, 'tap');

Whether an entity or position is inside the level. Most accurate when game is using pathfinding and has a collision map, and always true if using neither! Tip: if you are having issues with this method, it is most likely because a) your game has pathfinding disabled, and/or b) your level does not have a continuous border of solid tiles in the collision map!

Source:

• game.js, line 1640

Removes this item from current layer and adds to new layer.

Source:

• game.js, line 1529

Loads a level immediately. IMPORTANT: for proper stability, use ig.GameExtended#loadLevelDeferred instead.

Source:

• game.js, line 457

Deferred load of a level.

Source:

• game.js, line 442

// these will all load the 'LevelTest1' level
game.loadLevelDeferred( "LevelTest1" );
game.loadLevelDeferred( "Test1" );
game.loadLevelDeferred( "test1" );

Pauses game, provided pause is not locked and a level is not being built. IMPORTANT: locking pause will not allow any other pause or unpause until unlocked!

Source:

• game.js, line 2004

Removes an entity.
- this is not the same as ig.EntityExtended#kill Tip: use this to remove an entity for better stability.

Source:

• game.js, line 1140

See:

• ig.Game#removeItem

Deferred removal of item. IMPORTANT: to kill an entity, use ig.EntityExtended#kill, and to remove an entity, use ig.GameExtended#removeEntity.

Source:

• game.js, line 1387

// remove item from a different layer than it is on
settings.layerName = 'otherLayer';
// removal is actually for changing between layers
settings.forChange = true;

Deferred removal of layer.

Source:

• game.js, line 953

Resets level loading properties.

Source:

• game.js, line 810

Resize the canvas based on the window. Tip: use this to resize Impact++ properly.

Source:

• game.js, line 2480

Resizes game on next update and is much better on performance (max of 1 resize per update).

Source:

• game.js, line 2509

Sort of entities, sorting all layers if no layer name passed.

Source:

• game.js, line 1565

Deferred sort of entities, sorting all layers if no layer name passed.

Source:

• game.js, line 1601

Sort of entities on a specific layer.

Source:

• game.js, line 1587

Deferred sort of entities on a specific layer.

Source:

• game.js, line 1623

Spawns an entity of type. IMPORTANT: use this to instantiate an entity for better stability.

Source:

• game.js, line 1052

Unloads the current level immediately and resets layers, camera, etc. IMPORTANT: for proper stability, use ig.GameExtended#unloadLevelDeferred instead.

Source:

• game.js, line 768

Deferred unload of the current level.

Source:

• game.js, line 758

Unpauses game, provided pause is not locked and a level is not being built.

Source:

• game.js, line 2061

Updates game.
- removes, adds, and changes deferred layers
- removes and adds all deferred items
- loads a new level
- regathers all entities and lights in game if entities have been added or removed
- updates inputs
- updates tweens
- updates layers
- updates camera

Source:

• game.js, line 2274

Update entities in layer. IMPORTANT: normally, you will not need to call this function.

Source:

• game.js, line 2405