Skip to content

Latest commit

 

History

History
88 lines (48 loc) · 7.37 KB

in-game-use-guide.md

File metadata and controls

88 lines (48 loc) · 7.37 KB
description
Instructions on how to use Pro Laser 4 in game.

🎮 In Game Use Guide

Open Lidar Display:

  1. Spawn / Equip Pro Laser 4 Weapon.
  2. Use /lidar or press cfg.toggleMenu control to open lidar display.

Controls:

KeyDescriptionType
IToggle lidar display.Modifiable in FiveM Settings
CChange sniper vs. simulated sight display in 1st person.Static
LEFT MOUSEClock target speed player is aimed at.Static
RIGHT MOUSEToggle aim.Static
RIGHT ARROWOpen history and scroll next, hold to fast scroll.Static
LEFT ARROWClose history and scroll previous, hold to fast scroll.Static
SCROLLWHEEL UPZooms in.Static
SCROLLWHEEL DWNZooms out.Static

Commands:

/lidar same as I key, toggles lidar display.

/lidarwipe clears lidar history save data.

/lidarweapon adds Pro Laser 4 weapon to ped.

/lidarmove to move and resize the on screen display.

/lidarmove true to reset on screen display size and location to defaults.

If logging is enabled & configured:
/lidarrecords opens records tablet to view previous clock data.

Interface Guide

Speed - Range Display / Home

Recalled Events / History

Reticle / Sight Display

Range, Heading, and Entity Type Limitation

The lidar gun can clock AI vehicles up to your view distance (1100-1800 ft max.). Civilian vehicles clock range is limited by FiveM’s OneSync to 400-500 ft. It also has no built-in entity type limitations, it can clock vehicles, bicycles, peds, animals, and aircraft.

Cosine Error

An effect when lidar gun (and therefore beam) and target are not perpendicular to each other. The larger the angle between the instrument and the target the larger the error in clocking a vehicle speed. This error results in an underestimation of the vehicles speed, meaning the display will show a speed less than that of the actual target speed. While we can't actually measure the tangent or simulate the lidar beam, it is a rough estimation based on heading. The reduction also has a random scalar, to help simulate the different surfaces the beam may be hitting each with a different tangent.

It is important for players to be trained on this and understand the effects of Cosine error. The image below describes the mathematical relationship. You can read more at the link below.

Credit: copradar.com/chapts/chapt2/ch2d1.html

Credit: copradar.com/chapts/chapt2/ch2d1.html

{% embed url="https://copradar.com/chapts/chapt2/ch2d1.html" %}

In Vehicle Angle Limits

While in vehicles, you are only able to clock vehicles within 110 degrees right and 178 degrees left, simulating inability to shoot through the rear windows. There are also camera limits when aimed in first person, against these limits causes the screen to jitter as the resource forces your camera back into allowable angles. The camera may also clip against the interior of the vehicle, this is expected and there isn’t really a solution.

In the future this will be expanded to support passenger seat angles: product-roadmaps.md

Angle Limitation In-Vehicle

Calibration / Self-Test Behavior

If cfg.requireCalibration is set to true in config upon opening the lidar display or aiming down HUD sight for the first time the lidar will perform a self-test for 3 to 13 seconds. It will display a progress bar and a self-test timer. After calibration the lidar will display an empty speed-range layout.

Recalled Events Menu

Every entity clocked will be added to the recalled events menu. If the clocked entity is the same as the last entity AND the new speed is higher than the stored speed in the recalled event table then the save data will be overridden to reflect new speed, range, and time.

If (lastVeh == currVeh AND lastVehSpeed < currVehSpeed){
    // update existing data to new speed, range, and time
}

The recalled events menu can be navigated by pressing or holding LEFT ARROW or RIGHT ARROW. Holding either of these for 5 seconds will “fast-scroll” through the events. To close the recalled events menu navigate to the 1st record indicated by 1 in the top left corner and hit LEFT ARROW again. Recalled event data is saved every minute (if new data is present) and loaded on join.

Records Tablet

If persistent-records-and-tablet.md has been setup, then players in-game can review all players past clocks in accordance with logging settings in config.lua. The records tablet is a simulated tablet/laptop application that can retrieve all players previous clocks. It also allows printing clock data which includes information about the lidar gun, it's self-test state, and more.

Users clocks are submitted to the server every minute, if any are pending. All records waiting server side are inserted to the database every 5 minutes. As such, the records tablet can have a delay of up to 6 minutes by default, however this can be changed in the config under cfg.loggingInsertInterval.

Records Tablet Main Screen

Print Preview

Print To Image