World

import { world, buckets, doors, characters } from "@aicore-fivem/lib/server";

worldCopy Anchor Link

Time and weather through ai-core, whatever weather script runs (Renewed-Weathersync, av_weather, cd_easytime, qb-weathersync). While none runs, reads answer null and changes answer false.

world.getWeatherCopy Anchor Link

Side: Server · Waits: no

world.getWeather(): string | null

local weather = aiLib.world.getWeather()

Returns the current weather type as the weather script reports it (CLEAR, RAIN...), or null while none runs.

const raining = ["RAIN", "THUNDER"].includes(world.getWeather() ?? "");

world.setWeatherCopy Anchor Link

Sets the weather.

Side: Server · Waits: no

world.setWeather(type: Weather): boolean

local ok = aiLib.world.setWeather(weather)

Returns true when set, false while no weather script runs or the value is not a string.

import { addCommand, world } from "@aicore-fivem/lib/server";
import { isWeather } from "@aicore-fivem/shared";

addCommand("weather", { restricted: true, params: [{ name: "type", type: "string" }] }, (_source, { type }) => {
  const upper = type.toUpperCase();
  if (isWeather(upper)) world.setWeather(upper);
});

world.getTimeCopy Anchor Link

Side: Server · Waits: no

world.getTime(): { hour: number; minute: number } | null

local time = aiLib.world.getTime() -- { hour, minute } or nil

Returns the in-game time, or null while no weather script runs.

const time = world.getTime();
const night = time !== null && (time.hour >= 22 || time.hour < 6);

world.setTimeCopy Anchor Link

Sets the in-game time.

Side: Server · Waits: no

world.setTime(hour: number, minute?: number): boolean

local ok = aiLib.world.setTime(hour, minute)

Returns true when set, false while no weather script runs.

world.setTime(12, 30);

world.setBlackoutCopy Anchor Link

Turns the city blackout on or off.

Side: Server · Waits: no

world.setBlackout(on: boolean): boolean

local ok = aiLib.world.setBlackout(on)

Returns true when applied, false while no weather script runs or it has no blackout.

world.setBlackout(true); // the power plant was sabotaged

world.freezeTimeCopy Anchor Link

Stops or restarts the in-game clock.

Side: Server · Waits: no

world.freezeTime(on: boolean): boolean

local ok = aiLib.world.freezeTime(on)

Returns true when applied, false while no weather script runs or it cannot freeze time.

world.setTime(20, 0);
world.freezeTime(true);

bucketsCopy Anchor Link

Routing buckets (separate worlds: an apartment interior, an instance) from ai-core's allocator, so no two scripts ever share one. Never pick bucket numbers yourself (1000 + n). No Lua twin: call ai-core's exports AcquireBucket(tag) / ReleaseBucket(id).

buckets.acquireCopy Anchor Link

Takes a free bucket for this resource. It has no population (no ambient peds and cars) and strict entity lockdown.

Side: Server · Waits: no

buckets.acquire(tag: string): number

Returns the bucket id.

import { buckets } from "@aicore-fivem/lib/server";

const bucket = buckets.acquire(`property:${propertyId}`);
SetPlayerRoutingBucket(String(source), bucket);

buckets.releaseCopy Anchor Link

Gives a bucket back once its players are out.

Side: Server · Waits: no

buckets.release(id: number): boolean

Returns true when released. Every bucket of a stopped resource goes back by itself.

SetPlayerRoutingBucket(String(source), 0);
buckets.release(bucket);

doorsCopy Anchor Link

Door locks through ai-core's door lock layer, by the door lock script's own door id. No Lua twin: call ai-core's exports SetDoorLocked, IsDoorLocked.

doors.setLockedCopy Anchor Link

Locks or unlocks a door.

Side: Server · Waits: no

doors.setLocked(id: string, locked: boolean, by?: number): boolean

Returns true when a door script took it, false otherwise.

if (outcome === "won") doors.setLocked("bank_vault", false, source);

doors.isLockedCopy Anchor Link

Side: Server · Waits: no

doors.isLocked(id: string): boolean | null

Returns true or false, or null when unknown (no door lock, no such door, or the script cannot tell on the server).

if (doors.isLocked("bank_vault") === false) return fail("ALREADY_OPEN");

doors.providerCopy Anchor Link

Side: Server · Waits: no

doors.provider(): string | null

Returns the door lock script that answers, or null when none runs.

console.log(`doors through ${doors.provider() ?? "nothing"}`);

charactersCopy Anchor Link

Stored characters through ai-core. Loaded characters go through online and ai-core's player exports.

characters.setOfflinePositionCopy Anchor Link

Moves a stored (not loaded) character's spawn point, for example a sleeping body that was carried away. ai-core writes it once no load or unload save holds the character.

Side: Server · Waits: no

characters.setOfflinePosition(charId: number, position: { x: number; y: number; z: number; heading?: number }): boolean

No Lua twin: call ai-core's export SetOfflinePosition(charId, position).

Returns true when accepted. false when the character is loaded or the values are wrong.

characters.setOfflinePosition(sleeperCharId, { x: 340.2, y: -1396.7, z: 32.5, heading: 50 });