API Docs for: 1.0.1

Grape.Game Class

Extends
Defined in: js\grape\game\game.js:2

A class that represents a game. You can create and run multiple games in a single page.

Constructor

Grape.Game

(
  • opts
)

Defined in js\grape\game\game.js:2

Parameters:

  • opts Object

    Initial properties

Methods

createGameLoop

() Grape.GameLoop

Defined in js\grape\game\game.js:44

This method is called once when the game is created. If you want to use a custom game loop for your game, you can override this method.

Returns:

Grape.GameLoop:

The game loop

emit

(
  • event
  • payload
)

Inherited from Grape.EventEmitter: js\grape\etc\event-emitter.js:107

Emits an event to the instance: calls all event listeners subscribed to this event, or the 'any' event.

Parameters:

  • event String

    Event

  • payload

    An object passed as parameter to all event listeners.

frame

()

Defined in js\grape\game\game.js:145

Called by the game loop in each frame.

getRequiredFps

() Number

Defined in js\grape\game\game.js:238

This method is called by the game loop to determine what is the required FPS (Frames Per Second) for the game. By default, this is decided by the "fps" property of the current scene.

Returns:

Number:

FPS

getScene

() Grape.Scene

Defined in js\grape\game\game.js:228

Returns the current scene.

Returns:

Grape.Scene:

getScreen

() HTMLElement

Defined in js\grape\game\game.js:184

Returns the game screen which is appended to the container.

Returns:

HTMLElement:

Screen element

getScreenHeight

() Number

Defined in js\grape\game\game.js:205

Returns the height of the screen.

Returns:

Number:

Height

getScreenWidth

() Number

Defined in js\grape\game\game.js:194

Returns the width of the screen.

Returns:

Number:

Width

off

(
  • event
  • listener
)

Inherited from Grape.EventEmitter: js\grape\etc\event-emitter.js:89

Unsubscribes from an event.

Parameters:

  • event String

    Event

  • listener Function

    Event listener

on

(
  • event
  • listener
)

Inherited from Grape.EventEmitter: js\grape\etc\event-emitter.js:78

Subscribes to an event. The event handler will be called with this instance as context.

Parameters:

  • event String

    The event to subscribe

  • listener Function

    Event listener

render

()

Defined in js\grape\game\game.js:168

Called by the game loop when at least one frame was executed since the last screen update.

setCursor

(
  • cursor
)

Defined in js\grape\game\game.js:216

Sets the cursor style for the screen.

Parameters:

  • cursor String

    new cursor style

start

(
  • [scene]
)

Defined in js\grape\game\game.js:54

Starts the game. Initializes the game screen, the input system, and the game loop.

Parameters:

  • [scene] Grape.Scene optional

    Initial scene, which overrides the initialScene property.

startScene

(
  • scene
)

Defined in js\grape\game\game.js:112

Starts a new scene in the game.

Parameters:

  • scene Scene

    The scene

stop

()

Defined in js\grape\game\game.js:94

Stops the game.

Properties

container

String | HTMLElement

Defined in js\grape\game\game.js:24

The dom element which serves as the screen of the game. The size of the container is not manipulated by the engine, therefore you should set the size of it. The engine handles when this "screen size" changes and updates the displayed views. The container can be an id of a html element or a html element itself.

Default: document.body

initialScene

Function

Defined in js\grape\game\game.js:13

The scene which starts when (re)starting the game. It should be a constructor or a function returning with the scene, not an instantiated scene.

Default: Grape.Scene

Events

any

Inherited from Grape.EventEmitter: js\grape\etc\event-emitter.js:122

Emitted when any event is emitted. The parameters are the event and the payload.

frame

Defined in js\grape\game\game.js:151

Fired in each frame

frame (scene)

Defined in js\grape\game\game.js:157

Fired to the actual scene in each frame

renderLayer (scene)

Defined in js\grape\game\game.js:176

Fired to the current scene in each render frame

start (scene)

Defined in js\grape\game\game.js:138

Emitted to the scene when started. The parameter is the game.

stop

Defined in js\grape\game\game.js:105

Fired when the stop() method is called.

stop (scene)

Defined in js\grape\game\game.js:127

Fired to the scene when the scene is stopped.