Engine API Reference - v2.6.1
    Preparing search index...

    Class RigidBodyComponentSystem

    The RigidBodyComponentSystem maintains the dynamics world for simulating rigid bodies, it also controls global values for the world such as gravity. Note: The RigidBodyComponentSystem is only valid if 3D Physics is enabled in your application. You can enable this in the application settings for your project.

    Hierarchy (View Summary)

    Index

    Properties

    gravity: Vec3 = ...

    The world space vector representing global gravity in the physics simulation. Defaults to [0, -9.81, 0] which is an approximation of the gravitational force on Earth.

    Methods

    • Fire an event, all additional arguments are passed on to the event listener.

      Parameters

      • name: string

        Name of event to fire.

      • Optionalarg1: any

        First argument that is passed to the event handler.

      • Optionalarg2: any

        Second argument that is passed to the event handler.

      • Optionalarg3: any

        Third argument that is passed to the event handler.

      • Optionalarg4: any

        Fourth argument that is passed to the event handler.

      • Optionalarg5: any

        Fifth argument that is passed to the event handler.

      • Optionalarg6: any

        Sixth argument that is passed to the event handler.

      • Optionalarg7: any

        Seventh argument that is passed to the event handler.

      • Optionalarg8: any

        Eighth argument that is passed to the event handler.

      Returns EventHandler

      Self for chaining.

      obj.fire('test', 'This is the message');
      
    • Test if there are any handlers bound to an event name.

      Parameters

      • name: string

        The name of the event to test.

      Returns boolean

      True if the object has handlers bound to the specified event name.

      obj.on('test', () => {}); // bind an event to 'test'
      obj.hasEvent('test'); // returns true
      obj.hasEvent('hello'); // returns false
    • Detach an event handler from an event. If callback is not provided then all callbacks are unbound from the event, if scope is not provided then all events with the callback will be unbound.

      Parameters

      • Optionalname: string

        Name of the event to unbind.

      • Optionalcallback: HandleEventCallback

        Function to be unbound.

      • Optionalscope: any

        Scope that was used as the this when the event is fired.

      Returns EventHandler

      Self for chaining.

      const handler = () => {};
      obj.on('test', handler);

      obj.off(); // Removes all events
      obj.off('test'); // Removes all events called 'test'
      obj.off('test', handler); // Removes all handler functions, called 'test'
      obj.off('test', handler, this); // Removes all handler functions, called 'test' with scope this
    • Attach an event handler to an event.

      Parameters

      • name: string

        Name of the event to bind the callback to.

      • callback: HandleEventCallback

        Function that is called when event is fired. Note the callback is limited to 8 arguments.

      • Optionalscope: any = ...

        Object to use as 'this' when the event is fired, defaults to current this.

      Returns EventHandle

      Can be used for removing event in the future.

      obj.on('test', (a, b) => {
      console.log(a + b);
      });
      obj.fire('test', 1, 2); // prints 3 to the console
      const evt = obj.on('test', (a, b) => {
      console.log(a + b);
      });
      // some time later
      evt.off();
    • Attach an event handler to an event. This handler will be removed after being fired once.

      Parameters

      • name: string

        Name of the event to bind the callback to.

      • callback: HandleEventCallback

        Function that is called when event is fired. Note the callback is limited to 8 arguments.

      • Optionalscope: any = ...

        Object to use as 'this' when the event is fired, defaults to current this.

      Returns EventHandle

      • can be used for removing event in the future.
      obj.once('test', (a, b) => {
      console.log(a + b);
      });
      obj.fire('test', 1, 2); // prints 3 to the console
      obj.fire('test', 1, 2); // not going to get handled
    • Raycast the world and return all entities the ray hits. It returns an array of RaycastResult, one for each hit. If no hits are detected, the returned array will be of length 0. Results are sorted by distance with closest first.

      Parameters

      • start: Vec3

        The world space point where the ray starts.

      • end: Vec3

        The world space point where the ray ends.

      • Optionaloptions: {
            filterCallback?: Function;
            filterCollisionGroup?: number;
            filterCollisionMask?: number;
            filterTags?: any[];
            sort?: boolean;
        } = {}

        The additional options for the raycasting.

        • OptionalfilterCallback?: Function

          Custom function to use to filter entities. Must return true to proceed with result. Takes the entity to evaluate as argument.

        • OptionalfilterCollisionGroup?: number

          Collision group to apply to the raycast.

        • OptionalfilterCollisionMask?: number

          Collision mask to apply to the raycast.

        • OptionalfilterTags?: any[]

          Tags filters. Defined the same way as a Tags#has query but within an array.

        • Optionalsort?: boolean

          Whether to sort raycast results based on distance with closest first. Defaults to false.

      Returns RaycastResult[]

      An array of raycast hit results (0 length if there were no hits).

      // Return all results of a raycast between 0, 2, 2 and 0, -2, -2
      const hits = this.app.systems.rigidbody.raycastAll(new Vec3(0, 2, 2), new Vec3(0, -2, -2));
      // Return all results of a raycast between 0, 2, 2 and 0, -2, -2
      // where hit entity is tagged with `bird` OR `mammal`
      const hits = this.app.systems.rigidbody.raycastAll(new Vec3(0, 2, 2), new Vec3(0, -2, -2), {
      filterTags: [ "bird", "mammal" ]
      });
      // Return all results of a raycast between 0, 2, 2 and 0, -2, -2
      // where hit entity has a `camera` component
      const hits = this.app.systems.rigidbody.raycastAll(new Vec3(0, 2, 2), new Vec3(0, -2, -2), {
      filterCallback: (entity) => entity && entity.camera
      });
      // Return all results of a raycast between 0, 2, 2 and 0, -2, -2
      // where hit entity is tagged with (`carnivore` AND `mammal`) OR (`carnivore` AND `reptile`)
      // and the entity has an `anim` component
      const hits = this.app.systems.rigidbody.raycastAll(new Vec3(0, 2, 2), new Vec3(0, -2, -2), {
      filterTags: [
      [ "carnivore", "mammal" ],
      [ "carnivore", "reptile" ]
      ],
      filterCallback: (entity) => entity && entity.anim
      });
    • Raycast the world and return the first entity the ray hits. Fire a ray into the world from start to end, if the ray hits an entity with a collision component, it returns a RaycastResult, otherwise returns null.

      Parameters

      • start: Vec3

        The world space point where the ray starts.

      • end: Vec3

        The world space point where the ray ends.

      • Optionaloptions: {
            filterCallback?: Function;
            filterCollisionGroup?: number;
            filterCollisionMask?: number;
            filterTags?: any[];
        } = {}

        The additional options for the raycasting.

        • OptionalfilterCallback?: Function

          Custom function to use to filter entities. Must return true to proceed with result. Takes one argument: the entity to evaluate.

        • OptionalfilterCollisionGroup?: number

          Collision group to apply to the raycast.

        • OptionalfilterCollisionMask?: number

          Collision mask to apply to the raycast.

        • OptionalfilterTags?: any[]

          Tags filters. Defined the same way as a Tags#has query but within an array.

      Returns null | RaycastResult

      The result of the raycasting or null if there was no hit.

    Events

    EVENT_CONTACT: string = 'contact'

    Fired when a contact occurs between two rigid bodies. The handler is passed a SingleContactResult object containing details of the contact between the two bodies.

    app.systems.rigidbody.on('contact', (result) => {
    console.log(`Contact between ${result.a.name} and ${result.b.name}`);
    });