Class: Image

Constructor

new Image(pathopt)

Parameters:

Name	Type	Attributes	Description
`path`	String	<optional>	The image filepath. (Can also be a dataURI). If not specified, the image is created with no texture

Source: image.js, line 18

Example

let playerImage = new gameify.Image("images/player.png");

Members

loaded :Boolean

If the image is loaded

Type:

Boolean

Source: image.js, line 57

opacity :Number

The opaciy of the image

Type:

Number

Default Value: 1
Source: image.js, line 53

(readonly) path

The image filepath. Modifying this will not do anything.

Source: image.js, line 48

tileData :Object

If the image was derived from a tileset, details about where it came from. Mostly used for serialization. See example below for schema.

Type:

Object

Source: image.js, line 71

Example

{   // tileData schema:
    tileset: Tileset,
    position: { x: Number, y: Number }
    size: { x: Number, y: Number }
    collisionShape: gameify.shapes.Shape OR undefined,
    tags: [ String ]
}

Methods

changePath(path)

Change and load a new image path. Reset's the image's crop

Parameters:

Name	Type	Description
`path`	string	The new image path

Source: image.js, line 131

crop(x, y, width, height)

Crop the image

Parameters:

Name	Type	Description
`x`	Number	how much to crop of the left of the image
`y`	Number	how much to crop of the right of the image
`width`	Number	how wide the resulting image should be
`height`	Number	how tall the resulting image should be

Source: image.js, line 155

draw(context, x, y, w, h, r)

Draw the image to a context

Parameters:

Name	Type	Description
`context`	CanvasRenderingContext2D	The canvas context to draw to
`x`	Number	The x coordinate to draw at
`y`	Number	The y coordinate to draw at
`w`	Number	Width
`h`	Number	Height
`r`	Number	Rotation, in degrees

Source: image.js, line 185

fromJSON(data, ref) → {gameify.Image}

Creates a object from JSON data

Parameters:

Name	Type	Description
`data`	Object \| Array	Serialized object data (from object.toJSON)
`ref`	function	A function that returns a name for other objects, so they can be restored later

Source: image.js, line 81

Returns:

Type:: gameify.Image

getCrop()

Get the image crop. Returns an object with x, y, width, and height properties.

Source: image.js, line 172

onLoad(callback)

Set a function to be run when the image is loaded

Parameters:

Name	Type	Description
`callback`	function	The function to be called when the image is loaded.

Source: image.js, line 146

toJSON(keyopt, ref) → {Object}

Convert the object to JSON

Parameters:

Name	Type	Attributes	Description
`key`	string	<optional>	Key object is stored under (unused, here for consistency with e.g. Date.toJSON, etc.)
`ref`	function		A function that returns a name for other objects, so they can be restored later

Source: image.js, line 109

Returns:

Type:: Object

uncrop()

Remove crop from the image

Source: image.js, line 165