M2O Scripting APIScripting reference
    Preparing search index…
    ClassServer API

    Blip

    Replicated map icon that can be positioned in the world or attached to an entity.

    Hierarchy

    • Entity
      • Blip
    Index
    • Creates a script wrapper for an existing blip with this ID; use Blip.create() to create a blip.

      Parameters

      • id: number

        Network entity identifier.

      Returns Blip

    • Attaches this blip to a player so its position follows that entity.

      Parameters

      • player: number | Player

        Player handle or network entity ID to follow.

      Returns void

    • Attaches this blip to a vehicle so its position follows that entity.

      Parameters

      • vehicle: number | Vehicle

        Vehicle handle or network entity ID to follow.

      Returns void

    • Changes the icon displayed by this blip.

      Parameters

      • library: number

        Icon-library identifier.

      • iconId: number

        Icon identifier within the selected library.

      Returns void

    • Parameters

      • world: number

      Returns void

    • Parameters

      • player: Entity | null

      Returns void

    • Returns a readable representation of this blip.

      Returns string

      The blip ID formatted for logging or debugging.

    • Creates and replicates a world-map blip.

      Parameters

      • x: number

        Initial world-space X coordinate.

      • y: number

        Initial world-space Y coordinate.

      • z: number

        Initial world-space Z coordinate.

      • library: number

        Icon-library identifier.

      • iconId: number

        Icon identifier within the selected library.

      • Optionalcolor: number

        Optional game palette color identifier.

      • OptionalvirtualWorld: number

        Optional virtual-world ID used for visibility filtering.

      Returns Blip

      The newly created blip handle.

    color: number

    Current game palette color identifier.

    iconId: number

    Current icon identifier within iconLibrary.

    iconLibrary: number

    Current icon-library identifier.

    id: number
    position: Vector3
    rotation: Vector3 | Quaternion
    virtualWorld: number