类 Sprite3D

En

The Sprite3D class is used to implement 3D sprites.

Zh

Sprite3D 类用于实现3D精灵。

层级 (查看层级一览)

构造函数

constructor

属性

name tag WORLDINVERTFRONT

访问器

active activeInHierarchy children components destroyed displayedInStage hideFlags id is3D isStatic layer numChildren parent scene stage timer transform url

方法

_getBit _setBit addChild addChildAt addChildren addComponent addComponentInstance bubbleEvent callLater clearTimer clone contains destroy destroyChildren event findChild frameLoop frameOnce getChild getChildAt getChildByName getChildByPath getChildIndex getComponent getComponents hasHideFlag hasListener isAncestorOf off offAll offAllCaller on onAfterDeserialize onAwake once onDestroy onDisable onEnable removeChild removeChildAt removeChildByName removeChildren removeSelf replaceChild runCallLater setChildIndex setChildIndexBefore timerLoop timerOnce instantiate load

构造函数

constructor

  • new Sprite3D(name?: string, isStatic?: boolean): Sprite3D

    参数

    • 可选name: string

      Sprite name.

    • 可选isStatic: boolean

      Whether it is static.

    返回 Sprite3D

    En

    Creates an instance of the Sprite3D class.

    Zh

    创建 Sprite3D 类的实例。

属性

name

name: string = ""

En

Node name.

Zh

节点名称。

tag

tag: string

En

Node tag.

Zh

节点标签。

静态WORLDINVERTFRONT

WORLDINVERTFRONT: number

En

Indicates the front face direction. -1 for inverted back face, 1 for normal situation.

Zh

-1 表示翻转了背面，1 表示正常情况。

访问器

active

activeInHierarchy

  • get activeInHierarchy(): boolean

    返回 boolean

    En

    Whether this node is active in the hierarchy.

    Zh

    该节点在层级中是否激活。

children

components

destroyed

  • get destroyed(): boolean

    返回 boolean

    En

    Whether it has been destroyed. The object cannot be used after being destroyed.

    Zh

    是否已经销毁。对象销毁后不能再使用。

displayedInStage

  • get displayedInStage(): boolean

    返回 boolean

    En

    Indicates whether the node is displayed in the scene.

    Zh

    表示是否在显示列表中显示。

hideFlags

id

is3D

  • get is3D(): boolean

    返回 boolean

    En

    Whether it is a 3D node, i.e., Scene3D, Sprite3D and their derived classes.

    Zh

    是否是3D节点，即Scene3D、Sprite3D及其衍生类。

isStatic

layer

numChildren

parent

scene

stage

timer

transform

url

方法

_getBit

  • _getBit(bit: number): boolean

    参数

    • bit: number

      The bit to get.

    返回 boolean

    The bit value, true or false.

    En

    Get a specific bit of the node.

    Zh

    获取节点的特定位。

_setBit

  • _setBit(bit: number, value: boolean): boolean

    参数

    • bit: number

      The bit to set.

    • value: boolean

      The value to set, true or false.

    返回 boolean

    Whether the bit was changed.

    En

    Set a specific bit of the node.

    Zh

    设置节点的特定位。

addChild

addChildAt

  • addChildAt<T extends Node<T>>(node: T, index: number): T

    类型参数

    参数

    • node: T

      The child node to be inserted.

    • index: number

      The index at which the child node will be inserted.

    返回 T

    The inserted child node.

    En

    Insert a child node at a specific index.

    Zh

    在指定的索引位置插入子节点。

addChildren

addComponent

addComponentInstance

bubbleEvent

  • bubbleEvent(type: string, data?: any): void

    参数

    • type: string

      The event type.

    • 可选data: any

      The event data. An Event object can be passed.

    返回 void

    En

    Bubble an event up the parent chain.

    Zh

    事件冒泡到父节点链。

callLater

  • callLater(method: Function, args?: any[]): void

    参数

    • method: Function

      The callback function.

    • args: any[] = null

      The parameters passed to the callback function.

    返回 void

    En

    Delays the execution of a callback function until the next frame after the current execution block is finished. The callback function will only be executed once. It is generally called before the control is displayed on the screen to delay the calculation of data.

    Zh

    在当前执行块完成后,延迟执行回调函数到下一帧。 回调函数只会被执行一次。一般在控件被显示在屏幕之前调用，用于延迟计算数据。

clearTimer

  • clearTimer(caller: any, method: Function): void

    参数

    • caller: any

      The execution scope of the callback function (this).

    • method: Function

      The callback function.

    返回 void

    En

    Clears a timer.

    Zh

    清除定时器。功能同Laya.timer.clear()。

clone

contains

  • contains(node: Node): boolean

    参数

    • node: Node

      The specified node.

    返回 boolean

    A Boolean value indicating whether the current node contains the specified node.

    En

    Checks whether the current node contains the specified node.

    Zh

    当前容器是否包含指定的节点对象。

destroy

destroyChildren

event

  • event(type: string, data?: any): boolean

    参数

    • type: string

      The type of event.

    • 可选data: any

      (Optional) Data to pass to the callback. If multiple parameters p1, p2, p3, ... need to be passed, use an array structure such as [p1, p2, p3, ...]. If a single parameter p needs to be passed and p is an array, use a structure such as [p]. For other single parameters p, you can directly pass parameter p. If data is Event.EMPTY, it means passing an Event object to the callback function. Note that it is not passing Event.TEMP, but an independent Event object.

    返回 boolean

    True if there are listeners for this event type, false otherwise.

    En

    Dispatch an event.

    Zh

    派发事件。

findChild

  • findChild<T extends Node<T>>(
        name: string,
        classType?: new (...args: any[]) => T,
    ): T

    类型参数

    参数

    • name: string

      The name of the child node to find.

    • 可选classType: new (...args: any[]) => T

      The type of the child node.

    返回 T

    The child node with the specified name.

    En

    Recursively find child nodes, but will not search nodes inside Prefabs.

    Zh

    递归查找子节点，但不会查找Prefab内部的节点。

frameLoop

  • frameLoop(
        delay: number,
        caller: any,
        method: Function,
        args?: any[],
        coverBefore?: boolean,
    ): void

    参数

    • delay: number

      The interval between executions, in frames.

    • caller: any

      The execution scope of the callback function (this).

    • method: Function

      The callback function.

    • args: any[] = null

      The parameters passed to the callback function.

    • coverBefore: boolean = true

      Whether to override the previous delayed execution. The default value is true.

    返回 void

    En

    Repeatedly executes a callback function at a fixed interval based on frame rate.

    Zh

    基于帧率,定时重复执行回调函数。功能同Laya.timer.frameLoop()。

frameOnce

  • frameOnce(
        delay: number,
        caller: any,
        method: Function,
        args?: any[],
        coverBefore?: boolean,
    ): void

    参数

    • delay: number

      The delay time, in frames.

    • caller: any

      The execution scope of the callback function (this).

    • method: Function

      The callback function.

    • args: any[] = null

      The parameters passed to the callback function.

    • coverBefore: boolean = true

      Whether to override the previous delayed execution. The default value is true.

    返回 void

    En

    Executes a callback function once after a specified delay based on frame rate.

    Zh

    基于帧率,在指定延迟时间后执行一次回调函数。功能同Laya.timer.frameOnce()。

getChild

  • getChild<T extends Node<T>>(
        name: string,
        classType?: new (...args: any[]) => T,
    ): T

    类型参数

    参数

    • name: string

      The name of the child node.

    • 可选classType: new (...args: any[]) => T

    返回 T

    The child node with the specified name, or null if not found.

    En

    Get a child node by its name.

    Zh

    根据子节点的名字获取子节点对象。

getChildAt

  • getChildAt<T extends Node<T>>(
        index: number,
        classType?: new (...args: any[]) => T,
    ): T

    类型参数

    参数

    • index: number

      The index of the child node.

    • 可选classType: new (...args: any[]) => T

    返回 T

    The child node at the specified index, or null if the index is out of range.

    En

    Get a child node by its index.

    Zh

    根据子节点的索引位置获取子节点对象。

getChildByName

  • getChildByName<T extends Node<T>>(
        name: string,
        classType?: new (...args: any[]) => T,
    ): T

    类型参数

    参数

    • name: string
    • 可选classType: new (...args: any[]) => T

    返回 T

    En

    Same as getChild，recommended to use getChild

    Zh

    同getChild，推荐使用getChild

getChildByPath

  • getChildByPath<T extends Node<T>>(
        path: String,
        classType?: new (...args: any[]) => T,
    ): T

    类型参数

    参数

    • path: String

      The path of the child node.

    • 可选classType: new (...args: any[]) => T

      The type of the child node.

    返回 T

    The child node with the specified path.

    En

    Get the first child node with the specified path. e.g. getChildByPath("A.B.C") is similar to getChild("A") followed by getChild("B") followed by getChild("C").

    Zh

    获取具有指定路径的第一个子节点。例如 getChildByPath("A.B.C") 类似于 getChild("A") 后跟 getChild("B") 后跟 getChild("C")。

getChildIndex

getComponent

  • getComponent<T extends Component<T>>(componentType: new () => T): T

    类型参数

    参数

    • componentType: new () => T

      The type of the component.

    返回 T

    The component instance.

    En

    Get a component instance by type. Returns null if not found.

    Zh

    根据类型获取组件实例。如果没有找到则返回null。

getComponents

hasHideFlag

  • hasHideFlag(flag: number): boolean

    参数

    • flag: number

      The hide flag to check.

    返回 boolean

    Whether the node has the specified hide flag.

    En

    Check whether the node has a specific hide flag.

    Zh

    检查节点是否具有特定的隐藏标志。

hasListener

  • hasListener(type: string): boolean

    参数

    • type: string

      The type of event.

    返回 boolean

    True if a listener of the specified type is registered, false otherwise.

    En

    Check if the EventDispatcher object has any listeners registered for a specific type of event.

    Zh

    检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。

isAncestorOf

  • isAncestorOf(node: Node): boolean

    参数

    • node: Node

      The node to check.

    返回 boolean

    True if this node is an ancestor of the given node, false otherwise.

    En

    Check if this node is an ancestor of the given node.

    Zh

    检查本节点是否是某个节点的上层节点。

off

  • off(type: string, listener: Function): EventDispatcher

    参数

    • type: string

      The type of event.

    • listener: Function

      The listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Remove a listener from the EventDispatcher object.

    Zh

    从 EventDispatcher 对象中删除侦听器。

  • off(
        type: string,
        caller: any,
        listener?: Function,
        args?: any[],
    ): EventDispatcher

    参数

    • type: string

      The type of event.

    • caller: any

      The execution scope of the event listener function.

    • 可选listener: Function

      The listener function.

    • 可选args: any[]

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Remove a listener from the EventDispatcher object.

    Zh

    从 EventDispatcher 对象中删除侦听器。

offAll

  • offAll(type?: string): EventDispatcher

    参数

    • 可选type: string

      (Optional) The type of event. If the value is null, all types of listeners on this object are removed.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Remove all listeners of the specified event type from the EventDispatcher object.

    Zh

    从 EventDispatcher 对象中删除指定事件类型的所有侦听器。

offAllCaller

on

  • on(type: string, listener: Function): EventDispatcher

    参数

    • type: string

      The type of event.

    • listener: Function

      The listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Register an event listener object with the EventDispatcher object so that the listener receives event notifications.

    Zh

    使用 EventDispatcher 对象注册指定类型的事件侦听器对象，以使侦听器能够接收事件通知。

  • on(type: string, caller: any, listener: Function, args?: any[]): EventDispatcher

    参数

    • type: string

      The type of event.

    • caller: any

      The execution scope of the event listener function.

    • listener: Function

      The listener function.

    • 可选args: any[]

      (Optional) The callback parameters of the event listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Register an event listener object with the EventDispatcher object so that the listener receives event notifications.

    Zh

    使用 EventDispatcher 对象注册指定类型的事件侦听器对象，以使侦听器能够接收事件通知。

onAfterDeserialize

onAwake

  • onAwake(): void

    返回 void

    En

    The callback function that is executed when the component is activated, at which point all nodes and components have been created. This is a virtual method that needs to be overridden in the subclass.

    Zh

    组件被激活后执行，此时所有节点和组件均已创建完毕，此方法只执行一次。 此方法为虚方法，使用时重写覆盖即可。

once

  • once(type: string, listener: Function): EventDispatcher

    参数

    • type: string

      The type of event.

    • listener: Function

      The listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Register an event listener object with the EventDispatcher object so that the listener receives event notifications. This event listener responds once and is automatically removed after the first call.

    Zh

    使用 EventDispatcher 对象注册指定类型的事件侦听器对象，以使侦听器能够接收事件通知，此侦听事件响应一次后自动移除。

  • once(
        type: string,
        caller: any,
        listener: Function,
        args?: any[],
    ): EventDispatcher

    参数

    • type: string

      The type of event.

    • caller: any

      The execution scope of the event listener function.

    • listener: Function

      The listener function.

    • 可选args: any[]

      (Optional) The callback parameters of the event listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Register an event listener object with the EventDispatcher object so that the listener receives event notifications. This event listener responds once and is automatically removed after the first call.

    Zh

    使用 EventDispatcher 对象注册指定类型的事件侦听器对象，以使侦听器能够接收事件通知，此侦听事件响应一次后自动移除。

onDestroy

  • onDestroy(): void

    返回 void

    En

    The callback function when the node is destroyed. This is a virtual method. You can override it for custom logic when the node is about to be destroyed.

    Zh

    节点被销毁时执行的回调函数。此方法为虚方法，使用时重写覆盖即可。

onDisable

  • onDisable(): void

    返回 void

    En

    The callback function that is executed when the component is disabled, such as when a node is removed from the stage. This is a virtual method that needs to be overridden in the subclass.

    Zh

    组件被禁用时执行，比如从节点从舞台移除后。 此方法为虚方法，使用时重写覆盖即可。

onEnable

  • onEnable(): void

    返回 void

    En

    The callback function that is executed when the component is enabled, such as when a node is added to the stage. This is a virtual method that needs to be overridden in the subclass.

    Zh

    组件被启用后执行，比如节点被添加到舞台后。 此方法为虚方法，使用时重写覆盖即可。

removeChild

removeChildAt

  • removeChildAt(index: number, destroy?: boolean): Node

    参数

    • index: number

      The index of the child node.

    • 可选destroy: boolean

    返回 Node

    The removed node.

    En

    Remove a child node by its index.

    Zh

    根据子节点索引位置,删除对应的子节点对象。

removeChildByName

  • removeChildByName(name: string, destroy?: boolean): Node

    参数

    • name: string

      The name of the child node.

    • 可选destroy: boolean

    返回 Node

    The removed node.

    En

    Remove a child node by its name.

    Zh

    根据子节点名字删除对应的子节点对象,如果找不到不会抛出异常。

removeChildren

  • removeChildren(beginIndex?: number, endIndex?: number, destroy?: boolean): void

    参数

    • 可选beginIndex: number

      The begin index.

    • 可选endIndex: number

      The end index.

    • 可选destroy: boolean

    返回 void

    The node itself.

    En

    Remove all children from this node.

    Zh

    删除指定索引区间的所有子对象。

removeSelf

replaceChild

runCallLater

  • runCallLater(method: Function): void

    参数

    • method: Function

      The name of the callback function to be executed, such as functionName.

    返回 void

    En

    If there are callback functions delayed by callLater, they will be executed immediately.

    Zh

    如果有通过 callLater 延迟执行的回调函数,将立即执行它们。

setChildIndex

  • setChildIndex<T extends Node<T>>(node: T, index: number): T

    类型参数

    参数

    • node: T

      The child node to set the index for.

    • index: number

      The new index of the child node.

    返回 T

    The child node itself.

    En

    Set the index of a child node.

    Zh

    设置子节点的索引位置。

setChildIndexBefore

timerLoop

  • timerLoop(
        delay: number,
        caller: any,
        method: Function,
        args?: any[],
        coverBefore?: boolean,
        jumpFrame?: boolean,
    ): void

    参数

    • delay: number

      The interval between executions, in milliseconds.

    • caller: any

      The execution scope of the callback function (this).

    • method: Function

      The callback function.

    • args: any[] = null

      The parameters passed to the callback function.

    • coverBefore: boolean = true

      Whether to override the previous delayed execution. The default value is true.

    • jumpFrame: boolean = false

      Whether the callback should be executed when the timer jumps frames. The default value is false. If set to true, the callback will be executed multiple times in a single frame if possible, for performance reasons.

    返回 void

    En

    Repeatedly execute a callback function at a fixed interval. This is a wrapper of the loop method in the timer property of the node.

    Zh

    定时重复执行某函数。这是对节点 timer 属性的 loop 方法的封装。

timerOnce

  • timerOnce(
        delay: number,
        caller: any,
        method: Function,
        args?: any[],
        coverBefore?: boolean,
    ): void

    参数

    • delay: number

      The delay time, in milliseconds.

    • caller: any

      The execution scope of the callback function (this).

    • method: Function

      The callback function.

    • args: any[] = null

      The parameters passed to the callback function.

    • coverBefore: boolean = true

      Whether to override the previous delayed execution. The default value is true.

    返回 void

    En

    Executes a callback function once after a specified delay.

    Zh

    在指定延迟时间后执行一次回调函数。功能同Laya.timer.once()。

静态instantiate

  • instantiate(
        original: Sprite3D,
        parent?: Node,
        worldPositionStays?: boolean,
        position?: Vector3,
        rotation?: Quaternion,
    ): Sprite3D

    参数

    • original: Sprite3D

      The original sprite.

    • parent: Node = null

      The parent node. Default is null.

    • worldPositionStays: boolean = true

      Whether to maintain its own world transformation. Default is true.

    • position: Vector3 = null

      World position, effective when worldPositionStays is false. Default is null.

    • rotation: Quaternion = null

      World rotation, effective when worldPositionStays is false. Default is null.

    返回 Sprite3D

    The cloned instance.

    En

    Create a clone instance of the sprite.

    Zh

    创建精灵的克隆实例。

静态load

显示设置

成员可见性

目录

构造函数
属性
访问器
方法