Trigger

class Trigger extends Renderable

trigger an event when colliding with another object

Constructor

new Trigger(x: number, y: number) → {}

world.addChild(new me.Trigger(
    x, y, {
        shapes: [new me.Rect(0, 0, 100, 100)],
        "duration" : 250,
        "color" : "#000",
        "to" : "mymap2"
    }
));

Parameters:
Name	Type	Attributes	Default	Description
x	number			the x coordinates of the trigger area
y	number			the y coordinates of the trigger area
settings.width	number	<optional>		width of the trigger area
settings.height	number	<optional>		height of the trigger area
settings.shapes	Array<Rect> \| Array<Polygon> \| Array<Line> \| Array<Ellipse>	<optional>		collision shape(s) that will trigger the event
settings.duration	string	<optional>		Fade duration (in ms)
settings.color	string \| Color	<optional>		Fade color
settings.event	string	<optional>	"level"	the type of event to trigger (only "level" supported for now)
settings.to	string	<optional>		level to load if level trigger
settings.container	string \| Container	<optional>		Target container. See level.load
settings.onLoaded	Function	<optional>		Level loaded callback. See level.load
settings.flatten	boolean	<optional>		Flatten all objects into the target container. See level.load
settings.setViewportBounds	boolean	<optional>		Resize the viewport to match the level. See level.load

Summary

Methods from Trigger

boolean

onCollision(response: ResponseObject, other: Renderable | Container | Entity | Sprite | NineSliceSprite)

protected triggerEvent()

Properties inherited from Renderable

number	alpha = 1.0
boolean	alwaysUpdate = false
Container \| Entity	ancestor = undefined
ObservableVector2d	anchorPoint = <0.5,0.5>
boolean	autoTransform = true
string	blendMode = "normal"
Body	body
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

Properties inherited from Rect

number	bottom
number	centerX
number	centerY
number	height
number	left
number	right
number	top
string	type = "Rectangle"
number	width

Properties inherited from Polygon

Array<Vector2d>

points

Methods inherited from Renderable

number	angleTo(target: Renderable \| Vector2d \| Vector3d)
number	distanceTo(target: Renderable \| Vector2d \| Vector3d)
	draw(renderer: CanvasRenderer \| WebGLRenderer, viewport: Camera2d)
Renderable	flipX(flip: boolean)
Renderable	flipY(flip: boolean)
Vector2d	getAbsolutePosition()
Bounds	getBounds()
number	getOpacity()
Renderable	lookAt(target: Renderable \| Vector2d \| Vector3d)
	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)
Bounds	updateBounds(absolute: boolean)

Methods inherited from Rect

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)

Methods inherited from Polygon

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)

Public Methods

onCollision trigger.js:134

onCollision(response: ResponseObject, other: Renderable | Container | Entity | Sprite | NineSliceSprite) → {boolean}

onCollision callback, triggered in case of collision with this trigger

Parameters:
Name	Type	Description
response	ResponseObject	the collision response object
other	Renderable \| Container \| Entity \| Sprite \| NineSliceSprite	the other renderable touching this one (a reference to response.a or response.b)

Returns:
Type	Description
boolean	true if the object should respond to the collision (its position and velocity will be corrected)

Protected Methods

triggerEvent trigger.js:106

protected triggerEvent() → {}

trigger this event