Blip

An icon on the compass and map. On the server, a blip shows to chosen players wherever they are. In a client script, it appears only on that player's compass and map, and neither the server nor other players know about it. A blip ends with the resource that made it.

blip.create()

Blip.create(options)

Creates a blip.

blip.all()

Blip.all(dimension)

All blips, or on the server, those in one dimension.

blip.getById()

Blip.getById(id)

The blip with this id, or null.

blip.removeAll()

Blip.removeAll(dimension)

Removes all blips, or on the server, optionally those in one dimension.

blip.types()

Blip.types()

Icon names a blip can use, such as 'Shop', 'Home', 'Pub', 'Camp' and 'FastTravel'.

blip.exists

exists

False once removed.

blip.type

type

The icon type. You can assign to it.

blip.markState

markState

The game's mark state of the icon, a whole number, 0 when created. You can assign to it, and anything else throws a TypeError.

blip.label

label

The text with the icon, up to 64 bytes. You can assign to it.

blip.compass

compass

Whether the icon shows on the compass. You can assign to it.

blip.map

map

Whether the icon shows on the map. You can assign to it.

blip.image

image

A .dds picture your resource ships, used as this blip's icon, or '' for its type's icon.

blip.position

position

The location it marks. You can assign to it.

blip.dimension

dimension

Its dimension. Change it with setDimension.

blip.setDimension()

setDimension(world)

Moves the blip to another dimension.

blip.showOnlyTo()

showOnlyTo(target)

Limits who sees it. null shows it to everyone again.

blip.remove()

remove()

Removes the blip.

blip.destroy()

destroy()

Removes the blip, the same as remove.

blip.valid

valid

False once this client blip is removed.

blip.live

live

Whether the compass currently has the mark.

blip.state

state

Client blips only, deprecated since 0.3.4. The old name of markState, which hid an entity's SharedState. It will be removed in a later release, and is left out of the TypeScript declarations.

blip.legend

legend

Client only. Whether this blip follows the map legend's switch for its icon type, as game marks do. True by default. With false, it stays visible when that type is off, so you can hide the game's marks with WorldMap.setMapCategory and show yours with the same icon. Server blips always follow the switch. You can assign to it, and a non-boolean throws a TypeError.

blip.id

id: number

The blip's id.