Entity

class Entity extends Renderable

a Generic Object Entity

Constructor

new Entity(x: number, y: number, settings: object) → {}

Parameters:
Name	Type	Attributes	Default	Description
x	number			the x coordinates of the entity object
y	number			the y coordinates of the entity object
settings	object			Entity properties, to be defined through Tiled or when calling the entity constructor
settings.width	number			the physical width the entity takes up in game
settings.height	number			the physical height the entity takes up in game
settings.name	string	<optional>		object entity name
settings.id	string	<optional>		object unique IDs
settings.image	Image \| string	<optional>		resource name of a spritesheet to use for the entity renderable component
settings.anchorPoint	Vector2d	<optional>	0.0	Entity anchor point
settings.framewidth	number	<optional>	settings.width	width of a single frame in the given spritesheet
settings.frameheight	number	<optional>	settings.width	height of a single frame in the given spritesheet
settings.type	string	<optional>		object type
settings.collisionMask	number	<optional>		Mask collision detection for this object
settings.shapes	Array<Rect> \| Array<Polygon> \| Array<Line> \| Array<Ellipse>	<optional>		the initial list of collision shapes (usually populated through Tiled)

	onBodyUpdate() update the bounds when the body is modified
	onDeactivateEvent() onDeactivateEvent Notification function
Bounds	updateBounds(absolute: boolean)
	protected draw(renderer: CanvasRenderer \| WebGLRenderer, viewport: Camera2d)

number	alpha = 1.0
boolean	alwaysUpdate = false
Container \| Entity	ancestor = undefined
ObservableVector2d	anchorPoint = <0.5,0.5>
boolean	autoTransform = true
string	blendMode = "normal"
Matrix2d	currentTransform
number	depth
boolean	floating = false
string	GUID
boolean	inViewport = false
boolean	isDirty = true
boolean	isFlippedX
boolean	isFlippedY
boolean	isFloating
boolean	isKinematic = true
boolean	isPersistent = false
Rect \| RoundRect \| Polygon \| Line \| Ellipse	mask = undefined
string	name = ""
Function	onVisibilityChange = undefined
Application	parentApp
ObservableVector3d	pos
GLShader	shader = undefined
Color	tint = (255, 255, 255)
boolean	updateWhenPaused = false

Array<Vector2d>

points

number	angleTo(target: Renderable \| Vector2d \| Vector3d)
number	distanceTo(target: Renderable \| Vector2d \| Vector3d)
Renderable	flipX(flip: boolean)
Renderable	flipY(flip: boolean)
Vector2d	getAbsolutePosition()
Bounds	getBounds()
number	getOpacity()
Renderable	lookAt(target: Renderable \| Vector2d \| Vector3d)
boolean	onCollision(response: ResponseObject, other: Renderable \| Container \| Entity \| Sprite \| NineSliceSprite)
	onDestroyEvent()
	postDraw(renderer: CanvasRenderer \| WebGLRenderer)
	preDraw(renderer: CanvasRenderer \| WebGLRenderer)
Renderable	rotate(angle: number, v: Vector2d \| ObservableVector2d)
Renderable	scale(x: number, y: number)
Renderable	scaleV(v: Vector2d)
	setOpacity(alpha: number)
Renderable	transform(m: Matrix2d)
boolean	update(dt: number)

Rect	centerOn(x: number, y: number)
Rect	clone()
boolean	contains(x: number \| Vector2d \| Rect, y: number)
Rect	copy(rect: Rect)
boolean	equals(rect: Rect)
boolean	isFinite()
boolean	overlaps(rect: Rect)
Rect	resize(w: number, h: number)
Rect	setShape(x: number, y: number, w: number \| Vector2d<Array>, h: number)
Polygon	toPolygon()
Rect	union(rect: Rect)

Array<number>	getIndices()
boolean	isConvex()
Polygon	recalc()
Polygon	setVertices(vertices: Array<Vector2d>)
	shift(x: number \| Vector2d, y: number)
Polygon	to2d()
Polygon	toIso()
Polygon	translate(x: number \| Vector2d, y: number)

alive entity.js:78

alive: boolean = true

boolean

dead/living state of the entity
default value : true

body entity.js:95

body: Body

Body

the entity body object

id entity.js:72

id: number

number

object unique ID (as defined in Tiled)

renderable entity.js:115

renderable: Renderable

Renderable

The entity renderable component (can be any objects deriving from me.Renderable, like me.Sprite for example)

type entity.js:66

type: string

string

object type (as defined in Tiled)

onBodyUpdate entity.js:175

onBodyUpdate() → {}

update the bounds when the body is modified

onDeactivateEvent entity.js:237

onDeactivateEvent() → {}

onDeactivateEvent Notification function

updateBounds entity.js:142

updateBounds(absolute: boolean) → {Bounds}

update the bounding box for this entity.

Parameters:
Name	Type	Attributes	Default	Description
absolute	boolean	<optional>	true	update the bounds size and position in (world) absolute coordinates

Returns:
Type	Description
Bounds	this entity bounding box Rectangle object

draw entity.js:202

protected draw(renderer: CanvasRenderer | WebGLRenderer, viewport: Camera2d) → {}

draw this entity (automatically called by melonJS)

Parameters:
Name	Type	Attributes	Description
renderer	CanvasRenderer \| WebGLRenderer		a renderer instance
viewport	Camera2d	<optional>	the viewport to (re)draw