1681-engine / index / Image

Class: Image

Defined in: src/core/Image.ts:6

A textured sprite, centred by default; frames are looked up by name in the texture registry.

Extends

• Sprite<this> & GameObjectMembers<this>

Constructors

Constructor

new Image(
   registry, 
   x, 
   y, 
   key, 
   frame?
): Image;

Defined in: src/core/Image.ts:10

Parameters

Parameter	Type
registry	TextureRegistry
x	number
y	number
key	string
frame?	string | number

Returns

Image

Overrides

GameObject(Sprite).constructor

Properties

active

readonly active: boolean;

Defined in: src/core/gameObject.ts:42

False once destroyed.

Inherited from

GameObject(Sprite).active

---

depth

depth: number;

Defined in: src/core/gameObject.ts:44

The draw order in the world layer (zIndex): bigger is in front.

Inherited from

GameObject(Sprite).depth

---

flipX

flipX: boolean;

Defined in: src/core/gameObject.ts:48

Inherited from

GameObject(Sprite).flipX

---

flipY

flipY: boolean;

Defined in: src/core/gameObject.ts:49

Inherited from

GameObject(Sprite).flipY

---

frameName

frameName: string;

Defined in: src/core/Image.ts:8

---

scaleX

scaleX: number;

Defined in: src/core/gameObject.ts:46

Scale without the flip: stays positive on a mirrored sprite.

Inherited from

GameObject(Sprite).scaleX

---

scaleY

scaleY: number;

Defined in: src/core/gameObject.ts:47

Inherited from

GameObject(Sprite).scaleY

---

scene

scene: Stage;

Defined in: src/core/gameObject.ts:40

Inherited from

GameObject(Sprite).scene

---

textureKey

textureKey: string;

Defined in: src/core/Image.ts:7

Accessors

displayHeight

Get Signature

get displayHeight(): number;

Defined in: src/core/Image.ts:49

Returns

number

Set Signature

set displayHeight(h): void;

Defined in: src/core/Image.ts:53

Parameters

Parameter	Type
h	number

Returns

void

---

displayWidth

Get Signature

get displayWidth(): number;

Defined in: src/core/Image.ts:41

Returns

number

Set Signature

set displayWidth(w): void;

Defined in: src/core/Image.ts:45

Parameters

Parameter	Type
w	number

Returns

void

---

frameHeight

Get Signature

get frameHeight(): number;

Defined in: src/core/Image.ts:37

Returns

number

---

frameWidth

Get Signature

get frameWidth(): number;

Defined in: src/core/Image.ts:33

Width of the frame itself, unscaled.

Returns

number

---

originX

Get Signature

get originX(): number;

Defined in: src/core/Image.ts:24

Returns

number

---

originY

Get Signature

get originY(): number;

Defined in: src/core/Image.ts:28

Returns

number

Methods

clearTint()

clearTint(): this;

Defined in: src/core/gameObject.ts:64

Returns

this

Inherited from

GameObject(Sprite).clearTint

---

destroy()

Call Signature

destroy(options?): void;

Defined in: node_modules/pixi.js/lib/scene/sprite/Sprite.d.ts:222

Destroys this sprite renderable and optionally its texture.

Parameters

Parameter	Type	Description
options?	DestroyOptions	Options parameter. A boolean will act as if all options have been set to that value

Returns

void

Example

sprite.destroy();
sprite.destroy(true);
sprite.destroy({ texture: true, textureSource: true });

Inherited from

GameObject(Sprite).destroy

Call Signature

destroy(): void;

Defined in: src/core/gameObject.ts:67

Returns

void

Inherited from

GameObject(Sprite).destroy

---

setAlpha()

setAlpha(a?): this;

Defined in: src/core/gameObject.ts:55

Parameters

Parameter	Type
a?	number

Returns

this

Inherited from

GameObject(Sprite).setAlpha

---

setAngle()

setAngle(a?): this;

Defined in: src/core/gameObject.ts:59

Parameters

Parameter	Type
a?	number

Returns

this

Inherited from

GameObject(Sprite).setAngle

---

setBlendMode()

setBlendMode(mode): this;

Defined in: src/core/gameObject.ts:60

Parameters

Parameter	Type
mode	BLEND_MODES

Returns

this

Inherited from

GameObject(Sprite).setBlendMode

---

setDepth()

setDepth(d): this;

Defined in: src/core/gameObject.ts:54

Parameters

Parameter	Type
d	number

Returns

this

Inherited from

GameObject(Sprite).setDepth

---

setDisplaySize()

setDisplaySize(w, h): this;

Defined in: src/core/Image.ts:62

Parameters

Parameter	Type
w	number
h	number

Returns

this

---

setFlip()

setFlip(x, y): this;

Defined in: src/core/gameObject.ts:53

Parameters

Parameter	Type
x	boolean
y	boolean

Returns

this

Inherited from

GameObject(Sprite).setFlip

---

setFlipX()

setFlipX(v): this;

Defined in: src/core/gameObject.ts:51

Parameters

Parameter	Type
v	boolean

Returns

this

Inherited from

GameObject(Sprite).setFlipX

---

setFlipY()

setFlipY(v): this;

Defined in: src/core/gameObject.ts:52

Parameters

Parameter	Type
v	boolean

Returns

this

Inherited from

GameObject(Sprite).setFlipY

---

setFrame()

setFrame(frame): this;

Defined in: src/core/Image.ts:66

Parameters

Parameter	Type
frame	string | number

Returns

this

---

setOrigin()

setOrigin(x?, y?): this;

Defined in: src/core/Image.ts:57

Parameters

Parameter	Type	Default value
x	number	0.5
y	number	x

Returns

this

---

setPosition()

setPosition(x?, y?): this;

Defined in: src/core/gameObject.ts:57

Parameters

Parameter	Type
x?	number
y?	number

Returns

this

Inherited from

GameObject(Sprite).setPosition

---

setRotation()

setRotation(r?): this;

Defined in: src/core/gameObject.ts:58

Parameters

Parameter	Type
r?	number

Returns

this

Inherited from

GameObject(Sprite).setRotation

---

setScale()

setScale(x, y?): this;

Defined in: src/core/gameObject.ts:50

Parameters

Parameter	Type
x	number
y?	number

Returns

this

Inherited from

GameObject(Sprite).setScale

---

setScrollFactor()

setScrollFactor(f): this;

Defined in: src/core/gameObject.ts:66

0 pins the object to the screen instead of the world.

Parameters

Parameter	Type
f	number

Returns

this

Inherited from

GameObject(Sprite).setScrollFactor

---

setTexture()

setTexture(key, frame?): this;

Defined in: src/core/Image.ts:72

Parameters

Parameter	Type
key	string
frame?	string | number

Returns

this

---

setTint()

setTint(color?): this;

Defined in: src/core/gameObject.ts:61

Parameters

Parameter	Type
color?	number

Returns

this

Inherited from

GameObject(Sprite).setTint

---

setTintFill()

setTintFill(color): this;

Defined in: src/core/gameObject.ts:63

Paints every opaque pixel in one solid colour (hit flash, silhouettes).

Parameters

Parameter	Type
color	number

Returns

this

Inherited from

GameObject(Sprite).setTintFill

---

setVisible()

setVisible(v): this;

Defined in: src/core/gameObject.ts:56

Parameters

Parameter	Type
v	boolean

Returns

this

Inherited from

GameObject(Sprite).setVisible