API Docs for: 0.1.0
Show:

zerk.game.engine.entity.box Class

Extends zerk.game.engine.entity
Defined in: src/zerk/class/game/engine/entity/box.js:1
Module: zerk

Simple box entity

Methods

_bodyApplyImpulse

(
  • bodyKey
  • degrees
  • power
)
protected

Inherited from zerk.game.engine.entity: src/zerk/class/game/engine/entity.js:297

Applies an impulse to given body

Parameters:

  • bodyKey String
  • degrees Integer
  • power Integer

_createMapBody

() protected

Inherited from zerk.game.engine.entity: src/zerk/class/game/engine/entity.js:281

Create a map to the physics handles of all bodies by their keys

_destroyBody

(
  • bodyKey
)
protected

Inherited from zerk.game.engine.entity: src/zerk/class/game/engine/entity.js:435

Destroys given body

Parameters:

  • bodyKey String

_getBodyLinearVelocity

(
  • bodyKey
)
Object protected

Inherited from zerk.game.engine.entity: src/zerk/class/game/engine/entity.js:421

Returns the linear velocity of given body

Parameters:

  • bodyKey String

Returns:

Object:

_getBodyPosition

(
  • bodyKey
)
Object protected

Inherited from zerk.game.engine.entity: src/zerk/class/game/engine/entity.js:407

Returns position of given body

Parameters:

  • bodyKey String

Returns:

Object: Position

_setBodyKinematic

(
  • bodyKey
)
protected

Inherited from zerk.game.engine.entity: src/zerk/class/game/engine/entity.js:392

Sets given body to be kinematic

Parameters:

  • bodyKey String

_setBodyMoveable

(
  • bodyKey
  • moveable
)
protected

Inherited from zerk.game.engine.entity: src/zerk/class/game/engine/entity.js:372

Sets whether given body is moveable

Parameters:

  • bodyKey String
  • moveable Boolean

_setBodyPosition

(
  • bodyKey
  • position
)
protected

Inherited from zerk.game.engine.entity: src/zerk/class/game/engine/entity.js:342

Sets the position of given body

Parameters:

  • bodyKey String
  • position Object

_setBodySleepingAllowed

(
  • bodyKey
  • allowed
)
protected

Inherited from zerk.game.engine.entity: src/zerk/class/game/engine/entity.js:358

Sets whether given body is allowed to sleep

Parameters:

  • bodyKey String
  • allowed Boolean

_setLinearVelocity

(
  • bodyKey
  • degrees
  • power
)
protected

Inherited from zerk.game.engine.entity: src/zerk/class/game/engine/entity.js:320

Sets the linear velocity of given body

Parameters:

  • bodyKey String
  • degrees Integer
  • power Integer

applyConfig

(
  • config
)

Inherited from zerk.game.engine.entity: src/zerk/class/game/engine/entity.js:253

Apply configuration object

Parameters:

  • config Object

destroy

()

Inherited from zerk.game.engine.entity: src/zerk/class/game/engine/entity.js:115

Destroys this entity and removes it from the world

fireEvent

(
  • event
)
Boolen

Inherited from zerk.observable: src/zerk/class/observable.js:111

Fire event

Parameters:

  • event String

    Event name

Returns:

Boolen: Returns false when the bubble was canceled

getBody

(
  • key
)
zerk.game.engine.physics.body

Inherited from zerk.game.engine.entity: src/zerk/class/game/engine/entity.js:268

Returns a body by key

Parameters:

  • key String

    Key of the body

Returns:

zerk.game.engine.physics.body: Body instance

init

(
  • engine
  • config
)

Inherited from zerk.observable but overwritten in src/zerk/class/game/engine/entity/box.js:23

Class constructor

Parameters:

on

(
  • event
  • callback
  • scope
)

Inherited from zerk.observable: src/zerk/class/observable.js:37

Register event handler

Parameters:

  • event String

    Event name

  • callback Function

    Callback function. Return false to cancel event bubble.

  • scope Object

    Scope to be used in callback function

setup

()

Inherited from zerk.game.engine.entity but overwritten in src/zerk/class/game/engine/entity/box.js:47

Setup bodies

un

(
  • event
  • callback
)
Boolen

Inherited from zerk.observable: src/zerk/class/observable.js:79

Unregister event handler

Parameters:

  • event String

    Event name

  • callback Function

    Callback function

Returns:

Boolen: Returns true on success

Properties

_eventListeners

Array protected

Inherited from zerk.observable: src/zerk/class/observable.js:17

List of event handlers

height

Integer

Inherited from zerk.game.engine.entity: src/zerk/class/game/engine/entity.js:75

Height of the entity

name

String

Inherited from zerk.game.engine.entity but overwritten in src/zerk/class/game/engine/entity/box.js:15

Name of the entity

width

Integer

Inherited from zerk.game.engine.entity: src/zerk/class/game/engine/entity.js:67

Width of the entity

Events

contactbegin

Inherited from zerk.game.engine.entity: src/zerk/class/game/engine/entity.js:31

Fires when two fixtures start colliding

Event Payload:

contactend

Inherited from zerk.game.engine.entity: src/zerk/class/game/engine/entity.js:40

Fires when two fixtures stop colliding

Event Payload:

contactpostsolve

Inherited from zerk.game.engine.entity: src/zerk/class/game/engine/entity.js:49

Fires before two fixtures start colliding

Event Payload:

spawn

Inherited from zerk.game.engine.entity: src/zerk/class/game/engine/entity.js:17

Fires when the entity gets spawned

tick

Inherited from zerk.game.engine.entity: src/zerk/class/game/engine/entity.js:24

Fires every world simulation tick