类 Physics2D

En

2D Physics Engine

Zh

2D物理引擎

层级 (查看层级一览)

构造函数

constructor

属性

_factory

访问器

allowSleeping bodyCount contactCount drawAABB drawCenterOfMass drawJoint drawPair drawShape enableDebugDraw gravity jointCount worldRoot I

方法

destroyWorld enable event getBodyCount getContactCount getJointCount hasListener off offAll offAllCaller on once start stop updatePhysicsByWorldRoot

构造函数

constructor

属性

_factory

_factory: IPhysiscs2DFactory

访问器

allowSleeping

  • get allowSleeping(): boolean

    返回 boolean

    En

    Whether the engine is allowed to sleep. Allowing the engine to sleep can improve stability and performance, but it usually comes at the cost of accuracy.

    Zh

    引擎是否允许休眠。允许引擎休眠可以提高稳定性和性能，但通常会牺牲准确性。

  • set allowSleeping(value: boolean): void

    参数

    • value: boolean

    返回 void

bodyCount

contactCount

drawAABB

  • set drawAABB(enable: boolean): void

    参数

    • enable: boolean

    返回 void

    En

    Whether to draw the AABB of physics objects.

    Zh

    是否绘制物理对象的包围盒。

drawCenterOfMass

  • set drawCenterOfMass(enable: boolean): void

    参数

    • enable: boolean

    返回 void

    En

    Whether to draw the center of mass of physics objects.

    Zh

    是否绘制物理对象的质心。

drawJoint

  • set drawJoint(enable: boolean): void

    参数

    • enable: boolean

    返回 void

    En

    Whether to draw the joints of physics objects.

    Zh

    是否绘制物理对象的关节。

drawPair

  • set drawPair(enable: boolean): void

    参数

    • enable: boolean

    返回 void

    En

    Whether to draw the collision pairs of the physics object.

    Zh

    是否绘制物理对象碰撞对。

drawShape

enableDebugDraw

gravity

  • get gravity(): any

    返回 any

    En

    The gravity of the physics world. The default value is {x: 0, y: 9.8}. Modifying the y direction to make the gravity upward can be done by setting gravity.y to -9.8 directly.

    Zh

    物理世界的重力环境。默认值为 {x: 0, y: 9.8}。 如果要修改y方向使重力方向向上，可以直接设置 gravity.y 为 -9.8。

  • set gravity(value: Vector2): void

    参数

    返回 void

jointCount

worldRoot

  • get worldRoot(): Sprite

    返回 Sprite

    En

    The root container of the physics world. It serves as the coordinate system for the physics world and is used for coordinate transformations. The default value is the stage. Setting a specific container allows for the collective movement of physical objects while keeping the physics world unchanged. Note that translation will only occur once when setting worldRoot. For other situations, use it in conjunction with the updatePhysicsByWorldRoot function.

    Zh

    物理世界的根容器，它作为物理世界的坐标系，用于坐标变换，默认值是舞台（stage）。 设置特定的容器后，可以整体移动物理对象，同时保持物理世界的坐标不变。 注意，只有在设置 worldRoot 时才会平移一次，在其他情况下，请配合使用 updatePhysicsByWorldRoot 函数。

  • set worldRoot(value: Sprite): void

    参数

    返回 void

静态I

方法

destroyWorld

enable

  • enable(): Promise<void>

    返回 Promise<void>

    En

    Enables the physics world. This method initializes the physics engine and starts the simulation.

    Zh

    开启物理世界。此方法初始化物理引擎并启动模拟。

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

    派发事件。

getBodyCount

getContactCount

getJointCount

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 对象是否为特定事件类型注册了任何侦听器。

off

offAll

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 对象注册指定类型的事件侦听器对象，以使侦听器能够接收事件通知。

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 对象注册指定类型的事件侦听器对象，以使侦听器能够接收事件通知，此侦听事件响应一次后自动移除。

start

  • start(): void

    返回 void

    En

    Starts the physics world. This method is called after the physics engine is initialized.

    Zh

    开启物理世界。此方法在物理引擎初始化后被调用。

stop

updatePhysicsByWorldRoot

  • updatePhysicsByWorldRoot(): void

    返回 void

    En

    Manually triggers an update of the physics world after setting the worldRoot.

    Zh

    在设定 worldRoot 后，手动触发物理世界的更新。

显示设置

成员可见性

目录

构造函数
属性
访问器
方法