1681-engine / index / ObjectFactory

Class: ObjectFactory

Defined in: src/core/ObjectFactory.ts:11

scene.add.*: creates an object and puts it on the world layer, where depth sorts it.

Constructors

Constructor

new ObjectFactory(stage): ObjectFactory;

Defined in: src/core/ObjectFactory.ts:12

Parameters

Parameter	Type
stage	Stage

Returns

ObjectFactory

Methods

container()

container(
   x?, 
   y?, 
   children?
): Group;

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

Parameters

Parameter	Type	Default value
x	number	0
y	number	0
children	Container<ContainerChild>[]	[]

Returns

Group

---

existing()

existing<T>(obj): T;

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

Puts an object made elsewhere on the world layer, as the factory's own are (a PixelLayer, a custom class).

Type Parameters

Type Parameter
T extends Container<ContainerChild> & object

Parameters

Parameter	Type
obj	T

Returns

T

---

graphics()

graphics(opts?): Graphics;

Defined in: src/core/ObjectFactory.ts:31

Parameters

Parameter	Type
opts?	{ x?: number; y?: number; }
opts.x?	number
opts.y?	number

Returns

Graphics

---

image()

image(
   x, 
   y, 
   key, 
   frame?
): Image;

Defined in: src/core/ObjectFactory.ts:14

Parameters

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

Returns

Image

---

label()

label(
   x, 
   y, 
   text, 
   fontFamily, 
   size, 
   color, 
   stroke, 
   strokeWidth, 
   resolution, 
   glyphs?
): BitmapLabel;

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

A bitmap-font label (BitmapLabel): cheap to change, for text rewritten many times a second.

Parameters

Parameter	Type	Default value
x	number	undefined
y	number	undefined
text	string	undefined
fontFamily	string	undefined
size	number	undefined
color	string	undefined
stroke	string	undefined
strokeWidth	number	undefined
resolution	number	undefined
glyphs	string	''

Returns

BitmapLabel

---

rectangle()

rectangle(
   x, 
   y, 
   w, 
   h, 
   color, 
   alpha?
): Rectangle;

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

Parameters

Parameter	Type	Default value
x	number	undefined
y	number	undefined
w	number	undefined
h	number	undefined
color	number	undefined
alpha	number	1

Returns

Rectangle

---

still()

still(
   x, 
   y, 
   src
): Image;

Defined in: src/core/ObjectFactory.ts:22

A copy of src as it is drawn right now (afterimages, clones). A live texture, repainted every frame, is snapshotted first, and the snapshot is freed with the copy.

Parameters

Parameter	Type
x	number
y	number
src	Image

Returns

Image

---

text()

text(
   x, 
   y, 
   text, 
   style
): Text;

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

Parameters

Parameter	Type
x	number
y	number
text	string
style	TextStyle

Returns

Text