Commands

Commands

This page documents all available commands in the ATM Owner System.

---

Player Commands

/atms

Description: Toggle ATM blips on/off on the map

Usage:

/atms

What It Does:

• Shows/hides all ATM blips on the map

• Toggles the blip display state

• Useful for finding ATMs or reducing map clutter

Example:

/atms  -- Toggle blips on/off

Notes:

• Requires Config.ATMBlip.Enabled = true to work

• Blips show as "ATM [ID]" on the map

• State persists until toggled again or server restart

---

/addatm

Description: Add a new ATM to the database at your current location

Usage:

/addatm

What It Does:

1. Opens a menu to configure the new ATM

2. Prompts for owner identifier (optional)

3. Prompts for location selection

4. Prompts for tax percentage

5. Prompts for purchase price

6. Prompts for rent amount

7. Adds ATM to database at your current coordinates

Menu Flow:

1. Owner Identifier (optional) - Leave blank for unowned ATM

2. Location - Select from: North, South, Paleto, Sandy Shores

3. Tax Percentage - Enter tax rate (e.g., 10 for 10%)

4. Price - Enter purchase price (e.g., 10000)

5. Rent - Enter rent amount (e.g., 500)

Example:

/addatm
-- Follow menu prompts

Notes:

• Must be used at the location where you want the ATM

• Coordinates are taken from your current position

• ATM will be available for purchase after creation

• Default settings can be changed later

---

/toggleatmblips

Description: Alternative command to toggle ATM blips (same as /atms)

Usage:

/toggleatmblips

What It Does:

• Same functionality as /atms

• Toggles ATM blips on/off

Example:

/toggleatmblips

---

/nearestatm

Description: Find and display information about the nearest ATM

Usage:

/nearestatm

What It Does:

• Finds the nearest ATM within 50 meters

• Displays ATM ID and distance

• Shows notification with details

Example Output:

Nearest ATM: ID=5 | Distance: 12.3m

Notes:

• Only shows ATMs within 50 meters

• If no ATM nearby, shows distance to nearest ATM

• Useful for finding ATM IDs for management

---

Admin/Development Commands

/scanatms_live

Description: Start/stop live scanning for ATM props on the map

Usage:

/scanatms_live [radius] [interval]

Parameters:

• radius (optional): Scan radius in meters (default: 50.0)

• interval (optional): Scan interval in milliseconds (default: 200)

What It Does:

1. Starts scanning for ATM prop models in the game world

2. Detects ATMs within the specified radius

3. Saves discovered ATMs to atm_scan.json

4. Run again to stop scanning

Example:

/scanatms_live          -- Start with default settings
/scanatms_live 100      -- Start with 100m radius
/scanatms_live 50 500   -- Start with 50m radius, 500ms interval
/scanatms_live          -- Stop scanning

Detected Models:

• prop_atm_01

• prop_atm_02

• prop_atm_03

• prop_fleeca_atm

• prop_atm_01_dam

Notes:

• Best used while flying around the map

• Scans continuously until stopped

• Results saved to atm_scan.json in resource folder

• Use /importatms to import scanned ATMs

---

/importatms

Description: Import scanned ATMs from atm_scan.json to database

Usage:

/importatms

What It Does:

1. Reads scanned ATMs from atm_scan.json

2. Imports ATMs in chunks of 100

3. Adds to database with default settings:

   • Price: $10,000

   • Tax: 10%

   • Location: Auto-categorized by coordinates

   • Rent: $0

Example:

/importatms

Output:

Importing 45 scanned ATMs
Import request sent in chunks; watch console for results
Bulk import finished: 45/45 added

Notes:

• Must run /scanatms_live first to create scan file

• Imports in chunks to prevent database overload

• Skips ATMs that already exist (by coordinates)

• Shows progress in server console

---

Command Permissions

Default Permissions

Player Commands (Available to all players):

• /atms

• /toggleatmblips

• /nearestatm

Admin Commands (No special permissions required, but use responsibly):

• /addatm

• /scanatms_live

• /importatms

Note: The script doesn't enforce command permissions by default. If you need permission-based commands, you can add permission checks in the command handlers.

---

Command Examples

Example 1: Finding ATMs

/atms                    -- Show all ATM blips
/nearestatm             -- Find nearest ATM

Example 2: Adding New ATMs

/addatm                 -- Add ATM at current location
-- Follow menu prompts

Example 3: Bulk Import

/scanatms_live          -- Start scanning
-- Fly around map to discover ATMs
/scanatms_live          -- Stop scanning
/importatms             -- Import to database

Example 4: Managing Blips

/atms                   -- Toggle blips on
/atms                   -- Toggle blips off
/toggleatmblips         -- Alternative toggle

---

Command Troubleshooting

Commands Not Working

Issue: Commands not responding

Solutions:

1. Check if resource is started: ensure godv_buyatm

2. Check server console for errors

3. Verify dependencies are loaded

4. Try restarting the resource

/addatm Menu Not Appearing

Issue: Menu doesn't open when using /addatm

Solutions:

1. Check if ox_lib is installed and running

2. Verify you're not in a vehicle or menu

3. Check server console for errors

4. Try again after a moment

/scanatms_live Not Finding ATMs

Issue: Scanner not detecting ATMs

Solutions:

1. Increase scan radius: /scanatms_live 100

2. Fly closer to ATM locations

3. Check if ATM models exist in game world

4. Verify scanner is running (notification should appear)

/importatms Not Working

Issue: Import fails or shows errors

Solutions:

1. Verify atm_scan.json exists in resource folder

2. Check file is not empty

3. Verify database connection is working

4. Check server console for specific errors

---

Adding Custom Commands

Example: Custom Command Handler

You can add custom commands by modifying the client or server files:

Client-Side Command:

RegisterCommand("mycommand", function()
    -- Your code here
end, false)

Server-Side Command:

RegisterCommand("mycommand", function(source, args)
    -- Your code here
end, false)

With Permission Check:

RegisterCommand("admincommand", function(source, args)
    local xPlayer = iLib.framework.getIdentifier(source)
    -- Check permissions
    if not hasPermission(xPlayer, "admin") then
        return
    end
    -- Your code here
end, false)

---

Command Aliases

You can create command aliases by registering multiple commands:

-- Alias for /atms
RegisterCommand("atmblips", function()
    -- Same code as /atms
end, false)

---

For more information, see:

• Installation Guide

• Configuration Guide

• Troubleshooting