World

const World: object

Defined in: client/api.d.ts:1497

Client-side queries against the currently streamed Mafia II world.

Type Declaration

getGroundZ()

getGroundZ(x, y, z, maxDistance?): number | null

Finds the closest ground surface below a world-space position using the game physics scene.

Parameters

x

number

World-space X coordinate of the ray origin.

y

number

World-space Y coordinate of the ray origin.

z

number

World-space Z coordinate from which to search downward.

maxDistance?

number

Maximum downward probe distance in world units; defaults to 200.

Returns

number | null

The ground Z coordinate, or null when no surface is found, physics is unavailable, or maxDistance is not positive.

raycast()

raycast(from, to, options?): RaycastHit | null

Casts a ray through the streamed physics scene and returns the closest surface it hits, so anything behind a wall is never reported. Only collision is hit: geometry without collision and areas not yet streamed in are invisible to it.

Parameters

from

Vector3

World-space ray start.

to

Vector3

World-space ray end.

options?

RaycastOptions

Optional filters.

Returns

RaycastHit | null

The closest hit, or null when nothing was hit or physics is unavailable.

Example

const hit = World.raycast(from, to);
if (hit && hit.type === "vehicle") {
  // hit.entity is the Vehicle, hit.networkId its id.
}