Class HitBox2DService

Hierarchy

HitBox2DService

Index

Methods

Methods

Static detailedOverlapInformation

detailedOverlapInformation(w: WorldBase, e: Entity, overlap: HitBoxOverlap): DetailedHitBoxOverlap

- Defined in RuntimeFull.ts:4754
Gets detailed information about how two entities overlap, and computes the precise intersection area as a convex polygon with up to eight vertices.

Warning: in cases where two hit areas are just barely touching, the system may report an overlap with an area of zero (zero vertices).

Parameters
- w: WorldBase
- e: Entity
- overlap: HitBoxOverlap
Returns DetailedHitBoxOverlap

Static hitTest

hitTest(w: WorldBase, point: Vector3, camera: Entity): HitTestResult

- Defined in RuntimeFull.ts:4742
Performs a hit test on all entities that have RectHitBox2D or Sprite2DRendererHitBox2D components. Returns the closest hit in z order at point, and outputs the UV Coordinates at the hit location. Returns an empty entity if there is no hit. Input point is in world space, but the z coordinate is ignored.

Parameters
- w: WorldBase
- point: Vector3
- camera: Entity
Returns HitTestResult

Static hitTestCamera

hitTestCamera(w: WorldBase, point: Vector3): Entity

- Defined in RuntimeFull.ts:4748
Gets the topmost camera at point, in world coordinates (ignores the z coordinate). This is useful to pass into hitTest if the camera is not known.

Parameters
- w: WorldBase
- point: Vector3
Returns Entity

Static rayCast

rayCast(w: WorldBase, rayStart: Vector3, rayEnd: Vector3, camera: Entity): RayCastResult

- Defined in RuntimeFull.ts:4745
Performs a 2D hit test along a ray and returns the first hit. Ignores the z coordinate.

Parameters
- w: WorldBase
- rayStart: Vector3
- rayEnd: Vector3
- camera: Entity
Returns RayCastResult

Generated using TypeDoc