Class WorldComponent

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

Remarks

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.

See

World Component

Example

// 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, Expand)

Constructors

constructor

Properties

enabled sceneObject uniqueIdentifier updateOrder worldSettings

Methods

createProbe destroy getSceneObject getTransform getTypeName isOfType isSame

Constructors

Protectedconstructor

Properties

enabled

enabled: boolean

If disabled, the Component will stop enacting its behavior.

ReadonlysceneObject

sceneObject: SceneObject

The scene object this component is on.

ReadonlyuniqueIdentifier

uniqueIdentifier: string

updateOrder

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

worldSettings: WorldSettingsAsset

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

Methods

createProbe

  • createProbe(): Probe

    Create an intersection probe for a specific world.

    Returns Probe

destroy

  • destroy(): void

    Destroys the component.

    Returns void

getSceneObject

getTransform

getTypeName

  • getTypeName(): string

    Returns the name of this object's type.

    Returns string

isOfType

  • isOfType(type: string): boolean

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

    Parameters

    • type: string

    Returns boolean

isSame

  • isSame(other: ScriptObject): 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

Constructors
Properties
Methods
MMNEPVFCICPMFPCPTTAAATR