类 FreeformLight2D

_extra

_id

_singleton

runInEditor

scriptPath

showLightTexture

静态 只读LIGHTANDSHADOW

静态 只读LIGHTANDSHADOW_ADDMODE

静态 只读LIGHTANDSHADOW_AMBIENT

静态 只读LIGHTANDSHADOW_LIGHT_DIRECTION

静态 只读LIGHTANDSHADOW_PARAM

静态 只读LIGHTANDSHADOW_SUBMODE

antiAlias

• get antiAlias(): boolean

• 返回 boolean

  En

  Is antiAlias

  Zh

  是否抗锯齿

• set antiAlias(value): void

• 参数

  • value: boolean

  返回 void

awaked

• get awaked(): boolean

• 返回 boolean

  En

  whether the component has been awakened.

  Zh

  组件是否已经被唤醒。

color

• get color(): Color

• 返回 Color

  En

  The light color

  Zh

  灯光颜色

• set color(value): void

• 参数

  • value: Color

  返回 void

destroyed

• get destroyed(): boolean

• 返回 boolean

  En

  whether the component has been destroyed.

  Zh

  组件是否已经被销毁。

enabled

• get enabled(): boolean

• 返回 boolean

  En

  whether the component is enabled.

  Zh

  是否启用组件。

• set enabled(value): void

• 参数

  • value: boolean

  返回 void

hideFlags

• get hideFlags(): number

• 返回 number

  En

  The hide flags that determine the hiding behavior of the component.

  Zh

  确定组件隐藏行为的标志。

• set hideFlags(value): void

• 参数

  • value: number

  返回 void

id

• get id(): number

• 返回 number

  En

  The unique identifier for the component.

  Zh

  组件的唯一标识。

intensity

• get intensity(): number

• 返回 number

  En

  The light intensity

  Zh

  灯光强度

• set intensity(value): void

• 参数

  • value: number

  返回 void

layerMask

• get layerMask(): number

• 返回 number

  En

  the layer mask

  Zh

  灯光层遮罩（灯光影响哪些层）

• set layerMask(value): void

• 参数

  • value: number

  返回 void

layers

• get layers(): number[]

• 返回 number[]

  En

  Get light layers

  Zh

  获取灯光层数组（灯光影响哪些层）

lightMode

• get lightMode(): Light2DMode

• 返回 Light2DMode

  En

  The light blend mode

  Zh

  灯光之间混合模式

• set lightMode(value): void

• 参数

  • value: Light2DMode

  返回 void

lightRotation

• get lightRotation(): number

• 返回 number

  En

  The light rotation angle

  Zh

  灯光旋转角度

• set lightRotation(value): void

• 参数

  • value: number

  返回 void

lightScale

• get lightScale(): Vector2

• 返回 Vector2

  En

  The light scale

  Zh

  灯光的缩放值

• set lightScale(value): void

• 参数

  • value: Vector2

  返回 void

order

• get order(): number

• 返回 number

  En

  The light render order

  Zh

  灯光渲染顺序

• set order(value): void

• 参数

  • value: number

  返回 void

sceneMode

• get sceneMode(): Light2DMode

• 返回 Light2DMode

  En

  The scene blend mode

  Zh

  灯光场景混合模式

• set sceneMode(value): void

• 参数

  • value: Light2DMode

  返回 void

shadowColor

• get shadowColor(): Color

• 返回 Color

  En

  The shadow color

  Zh

  阴影颜色

• set shadowColor(value): void

• 参数

  • value: Color

  返回 void

shadowEnable

• get shadowEnable(): boolean

• 返回 boolean

  En

  Is shadow enable, true means enable shadow, false means disable shadow.

  Zh

  阴影是否启用，true 表示启用阴影，false 表示禁用阴影。

• set shadowEnable(value): void

• 参数

  • value: boolean

  返回 void

shadowFilterSmooth

• get shadowFilterSmooth(): number

• 返回 number

  En

  The shadow filter smooth

  Zh

  阴影滤波平滑系数

• set shadowFilterSmooth(value): void

• 参数

  • value: number

  返回 void

shadowFilterType

• get shadowFilterType(): ShadowFilterType

• 返回 ShadowFilterType

  En

  Shadow filter type

  • 0: None: not filter, the edge is completely sharp. The calculation efficiency is the highest, but the visual effect is the worst, suitable for performance-sensitive scenarios.
  • 1: PCF5: Use 5 sampling points for blurring. The edge has a certain smooth effect, but the blur degree is limited, suitable for medium blur requirements.
  • 2: PCF9: Use 9 sampling points for blurring. The edge has a stronger smooth effect, suitable for high-quality shadow scenes. Calculation cost is medium, visual effect is significantly improved.
  • 3: PCF13: Use 13 sampling points for blurring, one of the highest quality blur algorithms. The edge is very soft, suitable for scenes that require extremely

  Zh

  阴影滤波类型

  • 0: None: 没有滤波处理，阴影边缘是完全锐利的。计算效率最高，但视觉效果最差，适合性能敏感的场景。
  • 1: PCF5: 使用 5 个采样点 进行模糊处理。阴影边缘有一定的平滑效果，但模糊程度有限，适合中等模糊需求的场景。计算开销较低，平衡性能和质量。
  • 2: PCF9: 使用 9 个采样点进行模糊处理。阴影边缘有更强的平滑效果，适合高质量光影的场景。计算开销适中，视觉效果明显提升。
  • 3: PCF13: 使用 13 个采样点进行模糊处理，是最高质量的模糊算法之一。阴影边缘非常柔和，适合对视觉质量要求极高的场景。计算开销较高，但效果非常细腻。
• set shadowFilterType(value): void

• 参数

  • value: ShadowFilterType

  返回 void

shadowLayerMask

• get shadowLayerMask(): number

• 返回 number

  En

  The shadow layer mask

  Zh

  阴影层遮罩（阴影影响哪些层）

• set shadowLayerMask(value): void

• 参数

  • value: number

  返回 void

shadowStrength

• get shadowStrength(): number

• 返回 number

  En

  The shadow strength

  Zh

  阴影强度

• set shadowStrength(value): void

• 参数

  • value: number

  返回 void

destroy

• destroy(): void

• 返回 void

  En

  Destroy components

  Zh

  销毁组件

getGlobalPos

• getGlobalPos(out): Point

• 参数

  • out: Point

  返回 Point

  En

  Get light global position

  Zh

  获取灯光位置的X坐标值（基于全局坐标系）

getLightType

• getLightType(): Light2DType

• 返回 Light2DType

  En

  Get light type

  Zh

  获取灯光类型

hasHideFlag

• hasHideFlag(flag): boolean

• 参数

  • flag: number

    The hide flag to check for.

  返回 boolean

  En

  Checks if the component has a specific hide flag set.

  Zh

  检查组件是否设置了特定的隐藏标志。

isLayerEnable

• isLayerEnable(layer): number

• 参数

  • layer: number

    Specified layer

  返回 number

  En

  Is the light turned on for the specified layer

  Zh

  灯光对指定层是否开启

isShadowLayerEnable

• isShadowLayerEnable(layer): number

• 参数

  • layer: number

    Specified layer

  返回 number

  En

  Is the shadow turned on for the specified layer

  Zh

  阴影对指定层是否开启

onAdded

• onAdded(): void

• 返回 void

  En

  Called after the component is added to a node. Unlike Awake, onAdded is called even if the node is not active.

  Zh

  组件被添加到节点后调用，与 onAwake 不同的是，即使节点未激活也会调用 onAdded。

  Blueprint Event

onAwake

• onAwake(): void

• 返回 void

  En

  Executed after the component is activated. At this point, all nodes and components have been created. This method is executed only once.

  Zh

  组件被激活后执行，此时所有节点和组件均已创建完毕，此方法只执行一次。

  Blueprint Event

onDestroy

• onDestroy(): void

• 返回 void

  En

  Executed when the node is destroyed manually.

  Zh

  手动调用节点销毁时执行。

  Blueprint Event

onDisable

• onDisable(): void

• 返回 void

  En

  Executed when the component is disabled, such as when the node is removed from the stage.

  Zh

  组件被禁用时执行，比如从节点从舞台移除后。

  Blueprint Event

onEnable

• onEnable(): void

• 返回 void

  En

  Executed after the component is enabled, such as when the node is added to the stage.

  Zh

  组件被启用后执行，比如节点被添加到舞台后。

  Blueprint Event

可选onLateUpdate

• onLateUpdate(): void

• 返回 void

  En

  Executed every frame during the late update phase, after the update phase.

  Zh

  每帧更新时执行，在 late update 阶段，update 阶段之后。

  Blueprint Event

可选onPostRender

• onPostRender(): void

• 返回 void

  En

  Executed after rendering.

  Zh

  渲染之后执行。

  Blueprint Event

可选onPreRender

• onPreRender(): void

• 返回 void

  En

  Executed before rendering.

  Zh

  渲染之前执行。

  Blueprint Event

可选onReset

• onReset(): void

• 返回 void

  En

  Resets the component's parameters to their default values. If this function is implemented, the component will be reset and automatically recycled for future use. If not reset, it will not be recycled for reuse.

  Zh

  将组件的参数重置为默认值。如果实现了这个函数，组件将被重置并自动回收到对象池，方便下次复用。 如果没有重置，则不会进行回收复用。

可选onStart

• onStart(): void

• 返回 void

  En

  Executed once, before the first update.

  Zh

  在第一次执行 update 之前执行，只会执行一次。

  Blueprint Default Event

可选onUpdate

• onUpdate(): void

• 返回 void

  En

  Executed every frame during the update phase. Avoid writing complex loop logic or using the getComponent method here.

  Zh

  每帧更新时执行，在 update 阶段。尽量不要在这里写大循环逻辑或使用 getComponent 方法。

  Blueprint Event

setLayerMaskByList

• setLayerMaskByList(layerList): void

• 参数

  • layerList: number[]

    Layer list

  返回 void

  En

  Set layer mask by list

  Zh

  用列表设置灯光层掩码

setShadowLayerMaskByList

• setShadowLayerMaskByList(layerList): void

• 参数

  • layerList: number[]

    Layer list

  返回 void

  En

  Set shadow layer mask by list

  Zh

  用列表设置阴影层掩码