Lens Scripting API
    Preparing search index...

    Class WorldComponent

    Groups Physics objects in its subtree into an independent world simulation.

    All simulation occurs within a physics world, each with its own configurable settings (e.g. gravity). When a physics object is placed under a WorldComponent, it belongs to that world and will only interact with other objects in that world. By default, there exists a root-level world for the scene, but multiple worlds may be created to run independent simulations.

    World Component

    // Change gravity in a given World Component

    // @input Physics.WorldComponent worldComponent
    script.worldComponent.worldSettings.gravity = new vec3(0.0, -300.0, 0.0);

    Hierarchy (View Summary)

    Index

    Properties

    enabled isEnabledInHierarchy sceneObject uniqueIdentifier updateOrder worldSettings

    Methods

    createProbe destroy getSceneObject getTransform getTypeName isOfType isSame

    Properties

    enabled: boolean

    If disabled, the Component will stop enacting its behavior.

    isEnabledInHierarchy: boolean

    Returns true if this Component, its SceneObject, and all of that SceneObjects parents are enabled.

    sceneObject: SceneObject

    The SceneObject this component is on.

    uniqueIdentifier: string
    updateOrder: number

    Update order of this world relative to other worlds (lower values are earlier). The implicit root world order is 0, so worlds with negative order will update before the root world, and worlds with non-negative order update after.

    worldSettings: WorldSettingsAsset

    Reference to world settings. If not set, use the default world settings for the project.

    // Change gravity in a given World Component

    // @input Physics.WorldComponent worldComponent
    script.worldComponent.worldSettings.gravity = new vec3(0.0, -300.0, 0.0);

    Methods

    • Create an intersection probe for a specific world.

      Returns Probe

    • Destroys the component.

      Returns void

    • Returns the name of this object's type.

      Returns string

    • Returns true if the object matches or derives from the passed in type.

      Parameters

      • type: string

      Returns boolean

    • Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

      Parameters

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Properties
    Methods