`Mote`

class

A thing in the scene with a place, made of components bound to its layers.

Name	`Mote`
Kind	class
Script reaches it as	`import { Mote } from "motion"` · `MotionScene.pickItem()` · `MotionEvents.moteClick` · `MotionEvents.hit` · `MotionEvents.hitEnd` · `MotionEvents.moteEnter` · `MotionEvents.moteLeave`
Since	0.3

Syntax

class Mote { … }

Properties

Name	Type	Description
`id`property	`readonly string`	Its id.
`name`property	`readonly string`	Its name.
`stage`property	`readonly MotionStageApi`	The stage it's on.
`alive`property	`readonly boolean`	Whether it's still there (not destroyed).
`location`property	`Vector3`	Where it is: the scene's pixels (2D, y down) or its 3D layer's units.
`rotation`property	`Rotator`	How it's turned: pitch, yaw, roll (degrees; a 2D mote's turn is its yaw).
`scale`property	`Vector3`	How big it is, each way.
`tags`property	`readonly Set<string>`	Its tags.
`parent`property	`readonly Mote \| null`	The mote it moves with, or null.
`ticking`property	`MotionTicking`	How often it ticks.
`velocity`property	`readonly Vector3`	Its body's speed, as the physics had it this turn ((0, 0, 0) without a body).
`angularVelocity`property	`readonly Rotator`	How fast its body turns, degrees a second.

Methods

Signature	Description
`new Mote(): Mote`constructor	Don't make one with new: stage.spawn makes a mote of your class and puts it on the stage, and Studio makes the ones placed in the scene.
`setLocation(v: Place): void`method	Puts it somewhere.
`addOffset(v: { x?: number; y?: number; z?: number }): void`method	Moves it by so much.
`addLocalOffset(v: { x?: number; y?: number; z?: number }): void`method	Moves it by so much in its own turned frame (its yaw).
`setRotation(r: number \| number[] \| Rotator): void`method	Turns it.
`addRotation(degrees: number): void`method	Turns it by so much (its yaw).
`setScale(s: number \| Place): void`method	Sizes it.
`moveTo(target: Place, options?: { seconds?: number; easing?: "linear" \| "easeIn" \| "easeOut" \| "easeInOut" }): Promise<void>`method	Moves it there over seconds, eased.
`setTimer(seconds: number, fn: () => void, options?: { looping?: boolean }): number` +1 moremethod	Runs a function after seconds (and every seconds, looping): seconds first, as scene.every has them.
`clearTimer(id: number): void`method	Stops a timer.
`attachTo(parent: Mote \| null): void`method	Makes it move with another (null: on its own again), keeping where it is now.
`detach(): void`method	On its own again.
`enableInput(): void`method	Hears the pointer again.
`disableInput(): void`method	Hears the pointer no more (clicks pass through it).
`hasTag(tag: string): boolean`method	Whether it has a tag.
`addTag(tag: string): void`method	Gives it a tag (64 at most).
`removeTag(tag: string): void`method	Takes a tag away.
`component<C extends Component>(name: string): C \| null`method	One of its components, by name.
`destroy(): void`method	Takes it out of the scene.
`setVelocity(v: Place): void`method	Gives its body a speed.
`applyImpulse(v: Place): void`method	Pushes its body: mass times the speed it gains.
`applyForce(v: Place): void`method	A force on its body for the next step: mass times the speed it gains a second.
`applyTorque(t: number \| number[] \| Rotator): void`method	A turning push on its body: the degrees a second it gains, times its inertia.
`sleep(): void`method	Puts its body to sleep: it rests until something touches or pushes it.
`wake(): void`method	Wakes its body.
`onStart(): void`method	It started (what a class overrides).
`onTick(dt: number): void`method	Each of its ticks (as often as its ticking says).
`onEnd(): void`method	It's being destroyed.
`onClicked(hit: MotionHit): void`method	It was clicked.
`onPointerEnter(): void`method	The pointer came over it.
`onPointerLeave(): void`method	The pointer left it.
`onHit(other: Mote): void`method	Its body started touching another's.
`onHitEnd(other: Mote): void`method	Its body stopped touching another's.
`onDragStart(): void`method	The pointer started dragging it (a DragComponent).
`onDrag(location: Vector3): void`method	The pointer dragged it.
`onDragEnd(): void`method	The pointer let it go.

`Mote`

Syntax

Properties

Methods

See also

Notes from the community