类 SpotLight2D

聚灯光

层级 (查看完整内容)

构造函数

constructor

属性

_extra _id _singleton owner runInEditor scriptPath showLightTexture LIGHTANDSHADOW LIGHTANDSHADOW_ADDMODE LIGHTANDSHADOW_AMBIENT LIGHTANDSHADOW_LIGHT_DIRECTION LIGHTANDSHADOW_PARAM LIGHTANDSHADOW_SUBMODE

访问器

antiAlias awaked color destroyed enabled falloffIntensity hideFlags id innerAngle innerRadius intensity layerMask layers lightMode lightRotation lightScale order outerAngle outerRadius sceneMode shadowColor shadowEnable shadowFilterSmooth shadowFilterType shadowLayerMask shadowStrength

方法

destroy getGlobalPos getGlobalPosX getGlobalPosY getLightType hasHideFlag isLayerEnable isShadowLayerEnable onAdded onAwake onDestroy onDisable onEnable onLateUpdate? onPostRender? onPreRender? onReset? onStart? onUpdate? renderLightTexture setLayerMaskByList setShadowLayerMaskByList

构造函数

constructor

属性

_extra

_extra: IComponentExtra

En

Extra data of the node.

Zh

组件的额外数据。IDE内部使用。

Blueprint Ignore

_id

_id: number

En

Unique identifier for the component.

Zh

组件的唯一标识。

_singleton

_singleton: boolean

En

Whether the component is a singleton, meaning only one instance of this type of script can be added to the same node.

Zh

是否为单例，即同一个节点只能添加此类型的脚本一次。

只读owner

owner: Sprite

En

Gets the owner Node to which the component belongs.

Zh

获取组件所属的 Node 节点。

runInEditor

runInEditor: boolean

En

Whether the script can run in the IDE environment.

Zh

是否可以在 IDE 环境中运行。

Blueprint Ignore

scriptPath

scriptPath: string

En

The path of the script file.

Zh

脚本文件的路径。

Blueprint Ignore

showLightTexture

showLightTexture: boolean = false

En

Is show light texture

Zh

是否显示灯光贴图

静态 只读LIGHTANDSHADOW

LIGHTANDSHADOW: number

光影图

静态 只读LIGHTANDSHADOW_ADDMODE

LIGHTANDSHADOW_ADDMODE: number

静态 只读LIGHTANDSHADOW_AMBIENT

LIGHTANDSHADOW_AMBIENT: number

环境光

静态 只读LIGHTANDSHADOW_LIGHT_DIRECTION

LIGHTANDSHADOW_LIGHT_DIRECTION: number

灯光高度值

静态 只读LIGHTANDSHADOW_PARAM

LIGHTANDSHADOW_PARAM: number

光影图尺寸和偏移

静态 只读LIGHTANDSHADOW_SUBMODE

LIGHTANDSHADOW_SUBMODE: number

访问器

antiAlias

awaked

color

destroyed

enabled

falloffIntensity

hideFlags

id

innerAngle

innerRadius

intensity

layerMask

layers

lightMode

lightRotation

lightScale

order

outerAngle

outerRadius

sceneMode

shadowColor

shadowEnable

shadowFilterSmooth

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

  • 参数

    返回 void

shadowLayerMask

shadowStrength

方法

destroy

getGlobalPos

getGlobalPosX

getGlobalPosY

getLightType

hasHideFlag

isLayerEnable

isShadowLayerEnable

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

onDisable

onEnable

可选onLateUpdate

可选onPostRender

可选onPreRender

可选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

可选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

renderLightTexture

setLayerMaskByList

setShadowLayerMaskByList

显示设置

成员可见性

目录

构造函数
属性
访问器
方法