Skip to main content

Blips and world

Blip attributes​

BlipOptions contains position { x, y, z }, icon and optional color. Create blips with server.world.createBlip(options), remove one with removeBlip(id) or clear all with clearBlips().

World features​

setDefaultFeature(feature, enabled) supports ambientNpcs, interiors and playerNicknames. ambientNpcs controls the default city population only; those ambient NPCs never consume player slots. This is separate from controlled Server NPCs and static Actors.

server.on("ready", () => {
  server.world.setDefaultFeature("ambientNpcs", true);
  server.world.setDefaultFeature("playerNicknames", true);
  server.world.createBlip({
    position: { x: 2495, y: -1681, z: 13 },
    icon: 5,
    color: 0xff3366ff,
  });
});

Notes​

Coordinates must be finite. The retained world state is replayed to active authenticated players.