Exports

Here is the documentation for pengu_digiscanner along with the parameters it uses.

Overview

The SetupDigiScanner function sets up the digital scanner specified parameters at the given coordinates. This documentation provides details on how to use the function, its parameters, and their expected values.

---

Usage

exports['pengu_digiscanner']:SetupDigiScanner(vector3, parameters)

---

Parameters

The '?' symbol directly after a parameter means that parameter is not required unless defined otherwise.

• vector3 (vector3): A vector3 coordinate where the digital scanner target will be located.

• parameters (table): A table containing parameters for setting up the digital scanner.

  • event (string): The event/command/action (function) associated with the digital scanner.

  • args? (table): Arguments for the event associated with the digital scanner.

  • isServer? (boolean): Specifies if the event type is a server side event or not.

  • isCommand? (boolean): Specifies if the event type is a command event or not.

  • isAction? (boolean): Specifies if the event type is an action (function) event or not.

  • blip? (table): Information for creating a blip for the digital scanner target.

    • text? (string): The text to be displayed on the blip.

    • sprite (integer): The sprite ID of the blip (docs).

    • display (integer): The display ID of the blip (docs).

    • scale? (integer): The scale of the blip (1.0 is the normal size).

    • color (integer): The color ID of the blip (docs).

    • opacity? (integer): The opacity of the blip.

  • interact? (table): Information for the interaction scaleform.

    • interactKey (integer): Keycode Integer (docs).

    • interactMessage (string): Message next to the interact button scaleform.

---

Example

local function DoAPrint(args)
    print('Good Job Pengu! '..args['bin'])
end

RegisterCommand('test', function ()
    exports['pengu_scaleform']:SetupDigiScanner(vector3(331.2, -1490.94, 29.27), {
        event = DoAPrint,
        isAction = true,
        args = {['bin'] = 'lol'},
        blip = {
            text = "Surprise Location",
            sprite = 9,
            display = 2,
            scale = 0.7,
            color = 2,
            opacity = 65,
        },
        interact = {
            interactKey = 38,
            interactMessage = 'View Print',
        }
    })
end)

Preview when facing away from target.

Preview when facing towards target (outside of target distance).

Preview inside target distance facing any direction.

Preview of the blip created.