World

const World: object

Defined in: server/api.d.ts:738

Controls replicated world state and exposes collections of connected players and spawned vehicles.

Type Declaration

players

readonly players: EntityCollection<Player>

Connected players visible to scripts, indexed by network entity ID.

vehicles

readonly vehicles: EntityCollection<Vehicle>

Spawned vehicles visible to scripts, indexed by network entity ID.

cycleTrafficLights()

cycleTrafficLights(): number

Advances the replicated traffic-light cycle by one epoch.

Returns

number

The new monotonically increasing traffic epoch.

getDrivingCoeff()

getDrivingCoeff(): number

Returns the replicated arcade driving coefficient.

Returns

number

A value from 0 for simulation handling to 1 for arcade handling.

getDrivingMode()

getDrivingMode(): "arcade" | "simulation" | "custom"

Returns the named driving-mode category for the current coefficient.

Returns

"arcade" | "simulation" | "custom"

Arcade at coefficient 1, simulation at 0, or custom for an intermediate value.

getRainIntensity()

getRainIntensity(): number

Returns the replicated rain-intensity override.

Returns

number

A value from 0 to 100, or -1 when no override is active.

getTime()

getTime(): WorldTime

Returns the current replicated game time as clock components.

Returns

WorldTime

The current hour and minute.

getTimeNormalized()

getTimeNormalized(): number

Returns the current game time in the engine’s normalized representation.

Returns

number

A value from 0 inclusive to 1 exclusive, where 0 is midnight and 0.5 is noon.

getTimeScale()

getTimeScale(): number

Returns the current game-clock speed multiplier.

Returns

number

The non-negative replicated time scale.

getTrafficEpoch()

getTrafficEpoch(): number

Returns the current replicated traffic-light epoch.

Returns

number

The current traffic cycle counter.

getWeather()

getWeather(): string

Returns the active replicated weather template.

Returns

string

The configured template name, or an empty string when world state is unavailable.

policeDispatch()

policeDispatch(event, x?, y?, z?, range?): void

Broadcasts a police radio event globally or around a world-space position.

Parameters

event

string | number

Police radio event name or numeric event identifier.

x?

number

Optional world-space X coordinate; all four location arguments must be supplied together.

y?

number

Optional world-space Y coordinate.

z?

number

Optional world-space Z coordinate.

range?

number

Optional dispatch radius around the supplied position.

Returns

void

setDrivingMode()

setDrivingMode(mode): void

Sets the replicated vehicle driving model.

Parameters

mode

number | "arcade" | "simulation"

Arcade, simulation (or sim), or a custom arcade coefficient from 0 to 1; numeric values are clamped.

Returns

void

setRainIntensity()

setRainIntensity(value): void

Sets or disables the replicated rain-intensity override.

Parameters

value

number

Rain override from 0 to 100; a negative value disables the override.

Returns

void

setTime()

setTime(hour, minute?): void

Sets the replicated game time.

Parameters

hour

number

Hour of day; the combined time is clamped to the valid 24-hour range.

minute?

number

Minute of the hour; defaults to zero.

Returns

void

setTimeScale()

setTimeScale(scale): void

Sets how quickly replicated game time advances.

Parameters

scale

number

Game-clock speed multiplier; negative values are clamped to zero.

Returns

void

setWeather()

setWeather(templateName): void

Sets the active replicated weather template.

Parameters

templateName

string

Mafia II weather template name to replicate to clients.

Returns

void