Editor Scripting API
    Preparing search index...

    Class BodyComponent

    Rigid body physics component for dynamic objects.

        const model = this.pluginSystem.findInterface(Editor.Model.IModel) as Editor.Model.IModel;
        const scene = model.project.scene;

        const obj = scene.createSceneObject('PhysicsBody');
        const body = obj.addComponent('BodyComponent') as Editor.Components.Physics.BodyComponent;

        body.dynamic = true;
        body.damping = 0.5;
        body.angularDamping = 0.1;
        console.log(`BodyComponent: dynamic=${body.dynamic}, damping=${body.damping}, angularDamping=${body.angularDamping}`);

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    angularDamping bodySetting bodySettingValue damping debugDrawEnabled dynamic enabled filter fitVisual forceCompound id intangible matter meta name overlapFilter rotateSmoothFactor sceneObject shape smooth translateSmoothFactor type worldSettings

    Methods

    getDirectlyReferencedEntities getMeta getOwnedEntities getTypeName getTypeName isOfType isSame

    Constructors

    Properties

    angularDamping: number

    Rotational resistance value.

    bodySetting: BodySetting

    Body configuration mode.

    bodySettingValue: number

    Numeric value for the selected body setting.

    damping: number

    Linear movement resistance value.

    debugDrawEnabled: boolean

    Enable visual debugging of the collider shape.

    dynamic: boolean

    Whether the body is affected by physics forces.

    enabled: boolean

    Whether the component is active.

    filter: Filter

    Collision filtering rules for this collider.

    fitVisual: boolean

    Automatically match collider shape to visual bounds.

    forceCompound: boolean

    Force collision shape to use compound geometry.

    id: Uuid

    The unique id of the entity.

    intangible: boolean

    Disable collision response while maintaining overlap detection.

    matter: Matter

    Physics material properties for this collider.

    meta: Meta

    Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.

    name: string

    Name of the component.

    overlapFilter: Filter

    Filtering rules for overlap queries on this collider.

    rotateSmoothFactor: number

    Damping factor for rotational motion.

    sceneObject: SceneObject

    Scene object this component is attached to.

    shape: Editor.Components.Physics.Shape

    Collision shape definition.

    smooth: boolean

    Enable motion smoothing between physics updates.

    translateSmoothFactor: number

    Damping factor for translational motion.

    type: string

    The entity's type.

    worldSettings: WorldSettingsAsset

    Physics simulation settings for this collider's world.

    Methods

    • Returns true if the object is of the specified type.

      Parameters

      • type: string

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods