Lib.Blip

Last updated on

Permission ui.vanilla.map.

Lib.Blip.Place

Creates a blip at a world position.

Lib.Blip.Place(position, options)

Parameters

• position: { x, y, z }
• options?: table — sprite, label, icon, active, visibleThroughWalls, routable, range

Returns

• Result — the handle; errors invalid_position, invalid_options

local pin = Lib.Blip.Place({ x = -1442.2, y = 127.4, z = 18.0 }, { label = 'Night market', routable = true })

Lib.Blip.Follow

Creates a blip that follows an entity.

Lib.Blip.Follow(entity, options)

Parameters

• entity: number
• options?: table

Returns

• Result — the handle; errors invalid_entity, invalid_options

Lib.Blip.Move

Patches a blip; only the fields given change.

Lib.Blip.Move(handle, patch)

Parameters

• handle: string
• patch: table

Returns

• Result — errors invalid_handle, invalid_patch

Lib.Blip.Get

Reads one of your blips.

Lib.Blip.Get(handle)

Parameters

• handle: string

Returns

• Result — error invalid_handle

Lib.Blip.SetActive

Switches a blip on or off without removing it.

Lib.Blip.SetActive(handle, active)

Parameters

• handle: string
• active: boolean

Returns

• Result — error invalid_handle

Lib.Blip.Track

Sets it as the tracked destination.

Lib.Blip.Track(handle)

Parameters

• handle: string

Returns

• Result — error invalid_handle

Lib.Blip.Remove

Removes one blip.

Lib.Blip.Remove(handle)

Parameters

• handle: string

Returns

• Result — error invalid_handle

Lib.Blip.List

Your blips.

Lib.Blip.List()

Returns

• Result — array

Lib.Blip.Clear

Removes every blip your resource owns, including ones made without this module.

Lib.Blip.Clear()

Returns

• Result