NarraLeaf

图层

用于对可显示元素分组的 `Layer` 类,控制层叠顺序与共享变换

此类继承自 Displayble

你可以使用 Layer 类来管理可显示元素的图层

用法

import {Layer} from "narraleaf-react";
const layer = new Layer("图层名称", {
    zIndex: 1
});

const scene = new Scene("带有图层的场景", {
    layers: [layer] // 将图层注册到场景中
});

const image = new Image({ /* ... */}).useLayer(layer); // 将图像链接到图层
layer.opacity(0.5, 1000, "linear"); // 更改图层的不透明度,所有链接到图层的元素都会受到影响

0.26.0 起,图层不会把自己的姿态带出声明它的那个场景。 离开场景现在会把该场景摆上舞台的图层还原到配置的 z-index 与姿态,而不只是还原站在图层上的可显示元素;newGame() 同样如此。在此之前,被移开或淡出的图层会在之后的每个场景里都保持那个样子。故事镜头是刻意的例外:一个故事只拥有一个镜头,而它要跨场景切换地为舞台取景

链式方法

setZIndex

设置图层的 z-index。z-index 越高,图层越靠前

  • zIndex: number - 图层的 z-index

公共方法

constructor

  • name?: string - 图层的名称
  • config?: Partial<ILayerUserConfig> - 图层的配置,参见 ILayerUserConfig

include

将可显示元素包含到图层中

  • elements: (Image | Text)[] | Image | Text - 要包含的可显示元素,例如 ImageText
  • 返回 this

本页目录