`MotionLayer`

interface

One layer, to change without naming it each time (scene.layer).

Name	`MotionLayer`
Kind	interface
Script reaches it as	`MotionScene.layer()` · `MotionScene.clone()`
Since	0.3

Syntax

interface MotionLayer extends MotionLayerInfo { … }

Properties

Name	Type	Description
`id`property	`readonly string`	The layer's id: its own, never shared ("" when there's no such layer).
`name`property	`readonly string`	The layer's name, as Studio shows it (a name can be shared).
`type`property	`readonly string`	The layer's kind: "gradient", "text", "particles"...
`folder`property	`readonly string`	The id of the folder it's in, "" for none.
`exists`property	`readonly boolean`	Whether the layer is there: false for a name no layer has, or one taken out (remove()).
`bounds`property	`readonly MotionBounds \| null`	The box round this layer as it was last drawn, 0 to 1 of the scene, and its turn.

Methods

Signature	Description
`set(setting: string, value: SettingValue): void`method	Changes one of this layer's settings at once.
`animate(setting: string, value: string \| number, seconds: number, options?: MotionAnimateOptions): Promise<boolean>`method	Moves one of this layer's number or colour settings smoothly.
`stopAnimating(setting?: string): void`method	Stops this layer's moves where they are now.
`get(setting: string): SettingValue \| undefined`method	One of this layer's settings: what the script set, or what the scene started with (not what keyframes or the sound make it: see read).
`read(setting: string): SettingValue \| undefined`method	One of this layer's settings as it was last drawn: its keyframes, the sound and the script's moves in.
`show(visible: boolean): void`method	Shows or hides this layer.
`hide(): void`method	Hides this layer.
`text(words: string): void`method	A Text layer's words.
`contains(x: number, y: number): boolean`method	Whether a point of the scene is on this layer, as it was last drawn (its turn and scale in).
`effect(which: string \| number): MotionEffect`method	One of this layer's effects, by its number in the stack or its name (or its kind).
`uniform(name: string, value: SettingValue): void`method	Sets a Shader layer's (or a Shader effect's) own uniform, by name.
`material(name: string, value: SettingValue): void`method	Sets one of the layer's material's own settings, by name.
`bringToFront(): void`method	Moves this layer above the others beside it (in its folder).
`sendToBack(): void`method	Moves this layer below the others beside it (in its folder).
`clone(name?: string): MotionLayer`method	A copy of this layer, just above it, while the scene plays.
`remove(): void`method	Takes this layer out of the scene while it plays (the scene's file is as it was).

`MotionLayer`

Syntax

Properties

Methods

See also

Notes from the community