BlastHack Wiki

https://wiki.blast.hk
Admin
BlastHack Wiki provides documentation for MoonLoader and SAMPFUNCS mods, information about opcodes,...
Tokens:1,022,769
Snippets:12,544
Trust Score:9.7
Update:1 week ago
Show doc for...
Tokens:
Raw
### Lua example: start and cancel downloadUrlToFile download

Source: https://wiki.blast.hk/ru/moonloader/lua/downloadUrlToFile

Complete example showing how to start and cancel a download with downloadUrlToFile. Uses a status callback that prints progress and can abort the download by returning false. Press F1 to start, F2 to cancel.

```lua
local dlstatus = require('moonloader').download_status
local vk = require 'vkeys'

function download_handler(id, status, p1, p2)
  if stop_downloading then
    stop_downloading = false
    download_id = nil
    print('Загрузка отменена.')
    return false -- прервать загрузку
  end
  if status == dlstatus.STATUS_DOWNLOADINGDATA then
    print(string.format('Загружено %d из %d.', p1, p2))
  elseif status == dlstatus.STATUS_ENDDOWNLOADDATA then
    print('Загрузка завершена.')
  end
end

function main()
  print('Нажмите F1, чтобы начать загрузку файла.')
  while true do
    wait(0)
    if wasKeyPressed(vk.VK_F1) and not download_id then
      local url = 'http://nonexistentfilehosting.com/nonexistentfile.dat'
      local file_path = getWorkingDirectory() .. '/downloads/file.dat'
      download_id = downloadUrlToFile(url, file_path, download_handler)
      print('Загрузка начата. Нажмите F2, чтобы отменить её.')
    elseif wasKeyPressed(vk.VK_F2) and download_id then
      stop_downloading = true
    end
  end
end
```

--------------------------------

### Lua example using getCharHeightAboveGround

Source: https://wiki.blast.hk/moonloader/lua/getCharHeightAboveGround

Example usage in a MoonLoader Lua script. Waits for SAMP to be available, then continuously gets the height of the player ped and prints it on screen.

```lua
function main()
    while not isSampAvailable() do wait(100) end
    while true do wait(0)
        local height = getCharHeightAboveGround(PLAYER_PED)
        printStringNow(height)
    end
end
```

--------------------------------

### Example: showInfoAndUnload

Source: https://wiki.blast.hk/ru/moonloader/lua/script

Example function that prints script information and unloads the script.

```APIDOC
## Example: showInfoAndUnload

### Description
Example function that prints script information and unloads the script.

### Code
```lua
function showInfoAndUnload()
  -- get the current script object
  local scr = thisScript()
  -- print name, version, and authors to log
  print(string.format("Name: %s, Version: %s, Authors: %s", scr.name, scr.version, table.concat(scr.authors, ", ")))
  -- force unload the script
  scr:unload()
end
```
```

--------------------------------

### Example usage of startCharFire

Source: https://wiki.blast.hk/moonloader/lua/startCharFire

Example usage of startCharFire. Registers a chat command 'fire' that makes the player character burn. Requires SAMP to be available.

```lua
function main()
    while not isSampAvailable() do wait(100) end
  sampRegisterChatCommand("fire", function()
    startCharFire(playerPed)
  end)
  wait(-1)
end
```

--------------------------------

### createPlayer usage example

Source: https://wiki.blast.hk/moonloader/lua/createPlayer

Example call to createPlayer with a model ID of 1 and coordinates. Returns a player handle.

```lua
playerHandle = createPlayer(1, -2540.6995, -21.8837, -2.1360)
```

--------------------------------

### Example usage of sampGetPlayerIdByCharHandle with targeting

Source: https://wiki.blast.hk/ru/moonloader/lua/sampGetPlayerIdByCharHandle

Example script that waits for SAMP to be available, then checks if the player is targeting someone and gets the target's SAMP ID using sampGetPlayerIdByCharHandle. If the right mouse button (PKM) and key '1' are pressed, it retrieves and prints the target's nickname.

```lua
script_name("Example script")

function main()
   while not isSampAvailable() do wait(100) end
   while true do
   wait(0)
   local result, target = getCharPlayerIsTargeting(playerHandle)
   if result then result, playerid = sampGetPlayerIdByCharHandle(target) end -- Если зажата пкм на игроке, то получаем ID.
     if result and isKeyDown(VK_1) then -- Если зажата пкм и кнопка 1 на игроке, то...
        name = sampGetPlayerNickname(playerid) -- получаем nickname игрока по ранее полученному ID.
        print(name) -- Выводим nickname в консоль Sampfuncs.
     end
   end
end
```

--------------------------------

### onQuitGame usage example

Source: https://wiki.blast.hk/moonloader/lua/onQuitGame

Example implementation of the onQuitGame event. It prints a message, calls saveSettings(), and prints a completion message before the game exits.

```lua
-- ...
function onQuitGame()
  print("Saving settings...")
  saveSettings()
  print("Done.")
end
-- ...
```

--------------------------------

### Example usage of testCheat

Source: https://wiki.blast.hk/moonloader/lua/testCheat

A script example demonstrating how to use testCheat within a main loop to detect the input of the string 'TEST'.

```lua
script_name("Example script")

function main()
if not isSampLoaded() or not isSampfuncsLoaded() then return end
while not isSampAvailable() do wait(100) end
while true do
    wait(0)
    if testCheat("TEST") then
      print("Чит-код активирован")
    end
  end
end
```

--------------------------------

### getCarSpeed usage example

Source: https://wiki.blast.hk/moonloader/lua/getCarSpeed

An example demonstrating how to retrieve the speed of the vehicle the player is currently in and display it on the screen.

```lua
function main()
    while not isSampAvailable() do wait(100) end
    while true do wait(0)
      car = storeCarCharIsInNoSave(PLAYER_PED)
      if isCharInCar(PLAYER_PED,car) then
         speed = getCarSpeed(car)
     local carSpeed = math.ceil(speed)
         printStyledString(carSpeed, 500, 7)
      end
   end
end
```

--------------------------------

### Example usage: display current game time

Source: https://wiki.blast.hk/moonloader/lua/useRenderCommands

Example loop that enables render commands and displays the current game time using setGxtEntry and displayText. Requires the 'lib.game.globals' module.

```lua
local glob = require "lib.game.globals"

function main()
  while true do
    wait(0)
    useRenderCommands(true)
    setGxtEntry("IGTIME", string.format("Time: %02d:%02d", getGameGlobal(glob.Time_Hours), getGameGlobal(glob.Time_Mins)))
    displayText(10, 10, "IGTIME")
  end
end
```

--------------------------------

### script_version usage example

Source: https://wiki.blast.hk/moonloader/lua/script_version

Example of calling script_version with a version string, followed by a main function. The version is set to "0.2.3-beta".

```lua
script_version("0.2.3-beta")

function main()
  -- ...
end
```

--------------------------------

### setUpSkip

Source: https://wiki.blast.hk/ru/moonloader/scripting-api

Sets up a skip point for the player.

```APIDOC
## setUpSkip

### Description
Sets up a skip point for the player.

### Parameters
- **posX** (float) - Required - X coordinate.
- **posY** (float) - Required - Y coordinate.
- **posZ** (float) - Required - Z coordinate.
- **angle** (float) - Required - Angle.
```

--------------------------------

### Example usage of setTaxiLights

Source: https://wiki.blast.hk/moonloader/lua/setTaxiLights

Example usage in a main loop. It checks if the player is in a taxi and turns on the taxi lights using the vehicle handle from storeCarCharIsInNoSave.

```lua
function main()
    while true do wait(0)
        if isCharInTaxi(PLAYER_PED) then
            setTaxiLights(storeCarCharIsInNoSave(PLAYER_PED), true)
         end
    end
end
```

--------------------------------

### getCharModel usage example

Source: https://wiki.blast.hk/moonloader/lua/getCharModel

Example usage of getCharModel with PLAYER_PED to get the player's skin ID and print it.

```lua
id = getCharModel(PLAYER_PED)
print("My skin is "..id)
```

--------------------------------

### setUpSkip

Source: https://wiki.blast.hk/moonloader/scripting-api

Sets up a skip point at the specified position and angle.

```APIDOC
## setUpSkip

### Description
Sets up a skip point at the specified position and angle.

### Method
Function

### Signature
setUpSkip(float posX, float posY, float posZ, float angle)

### Parameters
- **posX** (float) - Required - X coordinate.
- **posY** (float) - Required - Y coordinate.
- **posZ** (float) - Required - Z coordinate.
- **angle** (float) - Required - The angle.

### Return Value
None
```

--------------------------------

### Usage example: setPlay3dAudioStreamAtCoordinates

Source: https://wiki.blast.hk/moonloader/lua/setPlay3dAudioStreamAtCoordinates

Example usage that loads a 3D audio stream, gets the player character's coordinates, sets the stream position, and plays it.

```lua
local as_action = require('moonloader').audiostream_state
local as = load3dAudioStream('moonloader/resource/audio/sound.mp3')
local x, y, z = getCharCoordinates(PLAYER_PED)
setPlay3dAudioStreamAtCoordinates(as, x, y, z)
setAudioStreamState(audio, as_action.PLAY)
```

--------------------------------

### Example usage of sampGetDialogText()

Source: https://wiki.blast.hk/moonloader/lua/sampGetDialogText

Example script that prints the dialog text when the key with virtual code 49 (key '1') is pressed. It waits for SA:MP and SAMPFUNCS to load before running.

```lua
script_name("Example script")

function main()
  if not isSampLoaded() or not isSampfuncsLoaded() then return end
  while not isSampAvailable() do wait(100) end
  while true do
    wait(0)
    if isKeyDown(49) then
      while isKeyDown(49) do wait(80) end
      print(sampGetDialogText())
    end
  end
end
```

--------------------------------

### Example usage of setCharAnimSpeed

Source: https://wiki.blast.hk/moonloader/lua/setCharAnimSpeed

Example usage that sets the animation speed of the player character to 2 for the 'RUN_CIVI' animation in a loop. It waits for SAMP to be available before starting the loop.

```lua
function main()
    while not isSampAvailable() do wait(100) end
    while true do
      wait(0)
      setCharAnimSpeed(PLAYER_PED, 'RUN_CIVI', 2)
    end
end
```

--------------------------------

### setUpSkipAfterMission(float posX, float posY, float posZ, float angle)

Source: https://wiki.blast.hk/ru/moonloader/opcodes

Sets up a skip after mission with position and angle.

```APIDOC
## setUpSkipAfterMission(float posX, float posY, float posZ, float angle)

### Description
Sets up a skip after mission with position and angle.

### Parameters
- **posX** (float) - Required - X position.
- **posY** (float) - Required - Y position.
- **posZ** (float) - Required - Z position.
- **angle** (float) - Required - The angle.

### Return Value
None.
```

--------------------------------

### main() with infinite loop and key handling

Source: https://wiki.blast.hk/ru/moonloader/lua/main

Full example of the main function: loads resources, initializes a counter, and runs an infinite loop that waits zero frames each iteration to avoid freezing the game. It checks if the player is playing and if key 0x31 (1) is pressed, increments a counter, prints a message, and waits 500 ms.

```lua
function main()
  -- загрузим что-нибудь перед тем, как запустить бесконечный цикл
  loadStuff()
  key1_timesPressed = 0

  -- бесконечный цикл - в данном примере именно в нём реализована основная часть скрипта
  while true do
    -- в нём обязательно должна присутствовать хотя-бы нулевая задержка, иначе игра попросту зависнет
    -- объясняется это тем, что весь процесс игры выполняется последовательно, в том числе и скрипты MoonLoader-а
    -- и поэтому периодически игре нужно давать возможность обработаться, делая паузу в каждом бесконечном цикле любого скрипта
    -- нулевая задержка приостановит выполнение скрипта ровно на один кадр (задержка в main не оказывает влияния на выполнение остальных событий)
    wait(0)
    if isPlayerPlaying(playerHandle) then
      if isKeyDown(0x31) then
        key1_timesPressed = key1_timesPressed + 1
        print("Key 1 pressed " .. key1_timesPressed .. " times.")
        wait(500)
      end
      doCoolStuff()
    end
  end
end
```

--------------------------------

### 0BE3: raknet setup_incoming_rpc_hook

Source: https://wiki.blast.hk/gta-sa/opcodes/0BE3

Устанавливает хук на входящие RPC, перенаправляя их в указанный callback (метку) для последующей обработки на локальном клиенте.

```APIDOC
## 0BE3: raknet setup_incoming_rpc_hook

### Description
Перенаправляет входящие RPC в указанный callback (метку) для последующей обработки и принятия на локальном клиенте.

### Method
Опкод (Sanny Builder)

### Endpoint
0BE3

### Parameters
#### Label
- **@label** (label) - Required - Тело хука

### Request Example
```
0BE3: raknet setup_incoming_rpc_hook @label
```

### Response
Нет возвращаемого значения.

### Sanny Builder Syntax
```
0BE3=1,raknet setup_incoming_rpc_hook %1d%
```
```

--------------------------------

### Example usage of removeCharElegantly

Source: https://wiki.blast.hk/moonloader/lua/removeCharElegantly

Example usage of removeCharElegantly. Registers a chat command 'removeplayer' that takes a player ID, gets the character handle, and calls removeCharElegantly if the handle is valid.

```lua
function main()
    if not isSampLoaded() then return end
    while not isSampAvailable() do wait(100) end
    sampRegisterChatCommand('removeplayer', cmd)
    wait(-1)
end

function cmd(arg)
        local id = tonumber(arg)
        if not id or not sampIsPlayerConnected(id) then return end
    local result, ped = sampGetCharHandleBySampPlayerId(id)
    if result then removeCharElegantly(ped) end
end
```

--------------------------------

### Example usage of addOneOffSound

Source: https://wiki.blast.hk/moonloader/lua/addOneOffSound

Example usage of addOneOffSound in a MoonLoader script. It waits for the player to be playing, then plays sound ID 1076 at coordinates (0.0, 0.0, 0.0).

```lua
script_name("Sound Example")

function main()
  while not isPlayerPlaying(playerHandle) do wait(100) end
  addOneOffSound(0.0, 0.0, 0.0, 1076)
  wait(-1)
end
```

--------------------------------

### Example usage of getCharActiveInterior in Lua

Source: https://wiki.blast.hk/moonloader/lua/getCharActiveInterior

Example usage of getCharActiveInterior in a MoonLoader Lua script. It registers a chat command 'test' that gets the interior of the player ped and sends it as a chat message.

```lua
function main()
    while not isSampAvailable() do wait(100) end
    sampRegisterChatCommand("test",function()
        interior = getCharActiveInterior(PLAYER_PED)
        sampAddChatMessage(interior,-1)
    end)
    wait(-1)
end
```

--------------------------------

### setUpConversationNodeWithSpeech(GxtString question, GxtString answerY, GxtString answerN, int questionWav, int answerYWav, int answerNWav)

Source: https://wiki.blast.hk/ru/moonloader/opcodes

Sets up a conversation node with speech.

```APIDOC
## setUpConversationNodeWithSpeech(GxtString question, GxtString answerY, GxtString answerN, int questionWav, int answerYWav, int answerNWav)

### Description
Sets up a conversation node with speech.

### Parameters
- **question** (GxtString) - Required - The question text.
- **answerY** (GxtString) - Required - The yes answer text.
- **answerN** (GxtString) - Required - The no answer text.
- **questionWav** (int) - Required - The question audio ID.
- **answerYWav** (int) - Required - The yes answer audio ID.
- **answerNWav** (int) - Required - The no answer audio ID.

### Return Value
None.
```

--------------------------------

### setUpSkipAfterMission

Source: https://wiki.blast.hk/ru/moonloader/scripting-api

Sets up a skip after mission.

```APIDOC
## setUpSkipAfterMission

### Description
Sets up a skip after mission with the given position and angle.

### Parameters
- **posX** (float) - Required - X coordinate.
- **posY** (float) - Required - Y coordinate.
- **posZ** (float) - Required - Z coordinate.
- **angle** (float) - Required - Heading angle.
```

--------------------------------

### Example usage of getCarModel

Source: https://wiki.blast.hk/moonloader/lua/getCarModel

Example usage of getCarModel. It waits for SAMP, then when ALT+5 is pressed and the player is in a car, it gets the car handle, retrieves the model ID, and prints it to the Sampfuncs console.

```lua
require "lib.moonloader"
function main()
while not isSampAvailable() do wait(100) end
while true do
wait(0)
  if isKeyDown(VK_MENU) and isKeyJustPressed(VK_5) then -- Если нажать ALT + 5, то..
     if isCharInAnyCar(PLAYER_PED) then -- Проверка на транспорт
      local carhandle = storeCarCharIsInNoSave(PLAYER_PED) -- Получения handle транспорта
      local idcar = getCarModel(carhandle) -- Получение ID транспорта
      print(idcar) -- Выводим ID транспорта в консоль Sampfuncs.
      end
   end
end
end
```

--------------------------------

### Usage example: registering a chat command to remove a player

Source: https://wiki.blast.hk/ru/moonloader/lua/removeCharElegantly

This example registers a chat command 'removeplayer' that gets the character handle of a connected player and calls removeCharElegantly to smoothly remove the character.

```lua
function main()
    if not isSampLoaded() then return end
    while not isSampAvailable() do wait(100) end
    sampRegisterChatCommand('removeplayer', cmd)
    wait(-1)
end

function cmd(arg)
        local id = tonumber(arg)
        if not id or not sampIsPlayerConnected(id) then return end
    local result, ped = sampGetCharHandleBySampPlayerId(id)
    if result then removeCharElegantly(ped) end
end
```

--------------------------------

### Example usage of inicfg.load and inicfg.save

Source: https://wiki.blast.hk/moonloader/lua/inicfg

Complete example (example.lua) showing how to load a config with defaults, load another config without defaults (returns nil if missing), modify values, and save both configs. The first load uses the default path ./moonloader/config/example.lua.ini; the second uses the explicit file 'example_another_config'. Saving with inicfg.save returns true on success.

```lua
local inicfg = require 'inicfg'

-- производить загрузку кофигов можно и вне 'main'
local mainIni = inicfg.load({
  settings =
  {
    title = "text",
    text_color = "0xAABBCC"
  },
  location =
  {
    width = 100,
    height = 200,
    pos_x = 20,
    pos_y = 50
  }
}) -- загрузим основной конфиг. путь к файлу не указан, а значит будет загружен файл по пути ./moonloader/config/example.lua.ini

function main()
  -- таблица со значениями по умолчаниями не указана, поэтому если файл не удастся прочитать, будет возвращён nil
  local anotherIni = inicfg.load(nil, "example_another_config")
  -- если файл был успешно загружен
  if anotherIni ~= nil then
    -- выводим прочитанные значения
    print("Old value 1 = " .. anotherIni.main.value1)
    print("Old value 2 = " .. anotherIni.main.value2)
    -- просто сгенерируем 2 случайных значения
    local newV1, newV2 = math.random(100, 1000), math.random(100, 1000)
    -- теперь создадим таблицу с новыми значениями
    local newData = {
      main = {
        value1 = newV1,
        value2 = newV2,
        -- и добавим к ним сумму этих двух значений
        sum = newV1 + newV2
      }
    }
    -- можно сохранять
    if inicfg.save(newData, "example_another_config") then
      print("Success.")
    end
  end

  -- выведем основной конфиг
  print(mainIni.settings.title .. ", color = " .. mainIni.settings.text_color)
  print("Position: ", mainIni.location.pos_x, mainIni.location.pos_y, "Size: ", mainIni.location.width, mainIni.location.height)
  -- отредактируем и сохраним его
  mainIni.settings.title = "Hello"
  mainIni.location.pos_x = 100
  mainIni.location.pos_y = 75
  inicfg.save(mainIni)
end
```

--------------------------------

### Example usage of addExplosion in Lua

Source: https://wiki.blast.hk/moonloader/lua/addExplosion

Example usage of addExplosion in a MoonLoader Lua script. It registers a chat command 'test' that gets the player's coordinates and calls addExplosion with radius 35.

```lua
function main()
    while not isSampAvailable() do wait(100) end
    sampRegisterChatCommand("test",function()
        positionX, positionY, positionZ = getCharCoordinates(PLAYER_PED)
        addExplosion(positionX, positionY, positionZ, 35)
    end)
    wait(-1)
end
```

--------------------------------

### onStartNewGame(int mpack)

Source: https://wiki.blast.hk/ru/moonloader/events

Called when a new game starts. The mpack parameter is provided.

```APIDOC
## onStartNewGame(int mpack)

### Description
Called when a new game starts. The mpack parameter is provided.

### Method
Event

### Event Name
onStartNewGame

### Parameters
- **mpack** (int) - Required - The mission pack identifier.

### Return Value
None
```

--------------------------------

### onStartNewGame

Source: https://wiki.blast.hk/moonloader/scripting-api

Event callback triggered when a new game starts.

```APIDOC
## onStartNewGame

### Description
Event callback triggered when a new game starts.

### Parameters
- **mpack** (int) - Required - Mission pack identifier.
```

--------------------------------

### Example usage of getActiveInterior

Source: https://wiki.blast.hk/moonloader/lua/getActiveInterior

Example usage of getActiveInterior in a MoonLoader script. It waits for SAMP to be available, registers a chat command 'test', and when invoked, gets the current interior ID and sends it as a chat message.

```lua
function main()
    while not isSampAvailable() do wait(100) end
    sampRegisterChatCommand("test",function()
        interior = getActiveInterior()
        sampAddChatMessage(interior,-1)
    end)
    wait(-1)
end
```

--------------------------------

### Пример использования startCharFire в скрипте

Source: https://wiki.blast.hk/ru/moonloader/lua/startCharFire

Пример регистрации команды 'fire' через sampRegisterChatCommand, которая вызывает startCharFire(playerPed) для поджигания игрока. Функция main ожидает доступности SAMP.

```lua
function main()
    while not isSampAvailable() do wait(100) end
  sampRegisterChatCommand("fire", function()
    startCharFire(playerPed)
  end)
  wait(-1)
end
```

--------------------------------

### Example: Get and Print Targeted Player's Nickname

Source: https://wiki.blast.hk/moonloader/lua/sampGetPlayerNickname

Example usage of sampGetPlayerNickname. It waits for SA:MP to be available, then when the player targets another character and presses VK_1, it retrieves the target's player ID and prints their nickname.

```lua
script_name("Example script")

function main()
    while not isSampAvailable() do wait(100) end
    while true do
    wait(0)
    local result, target = getCharPlayerIsTargeting(playerHandle)
    if result then result, playerid = sampGetPlayerIdByCharHandle(target) end
      if result and isKeyDown(VK_1) then
         name = sampGetPlayerNickname(playerid)
         print(name)
      end
    end
 end
```

--------------------------------

### startCutscene

Source: https://wiki.blast.hk/moonloader/scripting-api

Starts the loaded cutscene.

```APIDOC
## startCutscene

### Description
Starts the currently loaded cutscene.

### Function Signature
`startCutscene()`
```

--------------------------------

### Example usage of deleteChar in a chat command

Source: https://wiki.blast.hk/moonloader/lua/deleteChar

Example Lua script that registers a chat command 'deletechar' to delete a player character. It uses sampGetCharHandleBySampPlayerId to get the character handle and deleteChar to remove it. If the player is not in the stream zone, it shows an error message.

```lua
-- В функцию main
sampRegisterChatCommand('deletechar', function(id)
    local result, ped = sampGetCharHandleBySampPlayerId(id)
    if result then
        deleteChar(ped)
        sampAddChatMessage('вы удалили игрока: ' .. id, -1)
    else
        sampAddChatMessage('игрок не в зоне стрима!', -1)
    end
end)
```

--------------------------------

### Character and Vehicle Control Functions

Source: https://wiki.blast.hk/moonloader/scripting-api

Functions to control character speech, getting out of upside-down cars, and weapon stuff at 2p game start.

```APIDOC
## shutAllCharsUp(bool enable)

### Description
Mutes or unmutes all characters' speech.

### Parameters
- **enable** (bool) - Required - True to mute all characters, false to unmute.

### Returns
None.

## setCharGetOutUpsideDownCar(Ped ped, bool canGetOut)

### Description
Sets whether a character can get out of an upside-down car.

### Parameters
- **ped** (Ped) - Required - The character.
- **canGetOut** (bool) - Required - True to allow getting out, false to prevent.

### Returns
None.

## doWeaponStuffAtStartOf2pGame()

### Description
Performs weapon-related setup at the start of a two-player game.

### Parameters
None.

### Returns
None.
```

--------------------------------

### 0A35 setUpSkipForVehicleFinishedByScript

Source: https://wiki.blast.hk/ru/moonloader/opcodes

Sets up a skip for a vehicle finished by script.

```APIDOC
## setUpSkipForVehicleFinishedByScript(float posX, float posY, float posZ, float angle, Vehicle car)

### Description
Sets up a skip for a vehicle finished by script.

### Parameters
- **posX** (float) - Required - X position.
- **posY** (float) - Required - Y position.
- **posZ** (float) - Required - Z position.
- **angle** (float) - Required - Angle.
- **car** (Vehicle) - Required - The vehicle.

```

--------------------------------

### Использование опкода 0A9A в скрипте

Source: https://wiki.blast.hk/gta-sa/opcodes/0A9A

Пример вызова опкода 0A9A для открытия файла 'settings.ini' в режиме чтения ('r'). Результат сохраняется в переменную 0@.

```sannybuilder
0A9A: 0@ = openfile "settings.ini" mode "r"
```

--------------------------------

### Usage: 0A96: 0@ = actor $PLAYER_ACTOR struct

Source: https://wiki.blast.hk/gta-sa/opcodes/0A96

Sanny Builder example showing how to use opcode 0A96 to get the structure from the player actor handle. The result is stored in variable 0@.

```sannybuilder
0A96: 0@ = actor $PLAYER_ACTOR struct
```

--------------------------------

### Download file with downloadUrlToFile and cancel on key press

Source: https://wiki.blast.hk/moonloader/lua/downloadUrlToFile

Example usage of downloadUrlToFile in a MoonLoader Lua script. It defines a download handler that prints progress and allows cancellation, and a main loop that starts the download on F1 and cancels it on F2. The handler returns false to abort the download when stop_downloading is set.

```lua
local dlstatus = require('moonloader').download_status
local vk = require 'vkeys'

function download_handler(id, status, p1, p2)
  if stop_downloading then
    stop_downloading = false
    download_id = nil
    print('Загрузка отменена.')
    return false -- прервать загрузку
  end
  if status == dlstatus.STATUS_DOWNLOADINGDATA then
    print(string.format('Загружено %d из %d.', p1, p2))
  elseif status == dlstatus.STATUS_ENDDOWNLOADDATA then
    print('Загрузка завершена.')
  end
end

function main()
  print('Нажмите F1, чтобы начать загрузку файла.')
  while true do
    wait(0)
    if wasKeyPressed(vk.VK_F1) and not download_id then
      local url = 'http://nonexistentfilehosting.com/nonexistentfile.dat'
      local file_path = getWorkingDirectory() .. '/downloads/file.dat'
      download_id = downloadUrlToFile(url, file_path, download_handler)
      print('Загрузка начата. Нажмите F2, чтобы отменить её.')
    elseif wasKeyPressed(vk.VK_F2) and download_id then
      stop_downloading = true
    end
  end
end
```

--------------------------------

### clearSkip()

Source: https://wiki.blast.hk/ru/moonloader/opcodes

Clears the skip setup.

```APIDOC
## clearSkip()

### Description
Clears the skip setup.

```

--------------------------------

### Implement main function with infinite loop in Lua

Source: https://wiki.blast.hk/moonloader/lua/main

Example implementation of the main function for a MoonLoader script. Starts a while-true loop that uses wait(0) each iteration to avoid freezing the game, checks player status and key 0x31 (digit 1), increments and prints a counter, and calls doCoolStuff().

```lua
function main()
  -- загрузим что-нибудь перед тем, как запустить бесконечный цикл
  loadStuff()
  key1_timesPressed = 0

  -- бесконечный цикл - в данном примере именно в нём реализована основная часть скрипта
  while true do
    -- в нём обязательно должна присутствовать хотя-бы нулевая задержка, иначе игра попросту зависнет
    -- объясняется это тем, что весь процесс игры выполняется последовательно, в том числе и скрипты MoonLoader-а
    -- и поэтому периодически игре нужно давать возможность обработаться, делая паузу в каждом бесконечном цикле любого скрипта
    -- нулевая задержка приостановит выполнение скрипта ровно на один кадр (задержка в main не оказывает влияния на выполнение остальных событий)
    wait(0)
    if isPlayerPlaying(playerHandle) then
      if isKeyDown(0x31) then
        key1_timesPressed = key1_timesPressed + 1
        print("Key 1 pressed " .. key1_timesPressed .. " times.")
        wait(500)
      end
      doCoolStuff()
    end
  end
end
```

--------------------------------

### onStartNewGame(int mpackNumber)

Source: https://wiki.blast.hk/moonloader/lua/onStartNewGame

Событие onStartNewGame вызывается при старте новой игры в одиночном режиме. Принимает номер пакета миссий.

```APIDOC
## onStartNewGame(int mpackNumber)

### Description
Событие срабатывает при старте новой игры, предназначено только для одиночной игры. Параметр `mpackNumber` - это номер пакета миссий. Система пакетов миссий не используется в оригинальной игре, но используется различными модами (например, DYOM). В оригинальной линии игры это значение равно нулю.

### Parameters
- **mpackNumber** (int) - Required - Номер пакета миссий.

### See Also
- onLoadGame
- onSaveGame
```

--------------------------------

### taskDie usage example

Source: https://wiki.blast.hk/moonloader/lua/taskDie

Example usage of taskDie with the PLAYER_PED handle.

```lua
taskDie(PLAYER_PED)
```

--------------------------------

### CLEO script example using 0C15

Source: https://wiki.blast.hk/gta-sa/opcodes/0C15

Complete CLEO script example demonstrating the 0C15 opcode. It allocates memory, formats a string, appends another string, logs the result, frees memory, and ends the thread.

```sannybuilder
{$CLEO}
wait 0
0AC8: 0@ = allocate_memory_size 128
0AD3: 0@ = format "Привет"
0C15: strcat destination 0@ source " чувак."
0B78: log "strcat -> %s" 0@
0AC9: free_allocated_memory 0@
0A93: end_custom_thread
```

--------------------------------

### setUpSkipForSpecificVehicle(float posX, float posY, float posZ, float angle, Vehicle car)

Source: https://wiki.blast.hk/ru/moonloader/opcodes

Sets up a skip for a specific vehicle.

```APIDOC
## setUpSkipForSpecificVehicle(float posX, float posY, float posZ, float angle, Vehicle car)

### Description
Sets up a skip for a specific vehicle.

### Parameters
- **posX** (float) - X position.
- **posY** (float) - Y position.
- **posZ** (float) - Z position.
- **angle** (float) - Angle.
- **car** (Vehicle) - The vehicle.

```

--------------------------------

### setCharCollision usage example

Source: https://wiki.blast.hk/moonloader/lua/setCharCollision

Example usage of setCharCollision. Enables collision for the player character.

```lua
setCharCollision(PLAYER_PED, true)
```

--------------------------------

### 0A92 startNewCustomScript

Source: https://wiki.blast.hk/ru/moonloader/opcodes

Starts a new custom script.

```APIDOC
## bool result = startNewCustomScript(zstring filepath, table args)

### Description
Starts a new custom script.

### Parameters
- **filepath** (zstring) - Required - The path to the script file.
- **args** (table) - Required - Arguments to pass to the script.

### Returns
- **result** (bool) - True if the script started successfully, false otherwise.

```

--------------------------------

### Example usage of renderSetTexCoord

Source: https://wiki.blast.hk/ru/moonloader/lua/renderSetTexCoord

Example usage of renderSetTexCoord. It sets the texture coordinate to (0.0, 0.0) before adding a vertex at (100, 100). The example also includes renderColor and renderBindTexture calls to bind the texture.

```lua
renderColor(0xFFFFFFFF)
renderBindTexture(tex)
renderSetTexCoord(0.0, 0.0)
renderVertex(100, 100)
```

--------------------------------

### startSettingUpConversation

Source: https://wiki.blast.hk/moonloader/scripting-api

Starts setting up a conversation.

```APIDOC
## startSettingUpConversation

### Description
Starts setting up a conversation.

### Function Signature
`startSettingUpConversation(Ped ped)`

### Parameters
- **ped** (Ped) - Required - The ped to start the conversation with.
```

--------------------------------

### setAudioStreamState usage example

Source: https://wiki.blast.hk/moonloader/lua/setAudioStreamState

Example of using setAudioStreamState with the audiostream_state constant PLAY from the moonloader module.

```lua
local as_action = require('moonloader').audiostream_state

setAudioStreamState(audio, as_action.PLAY)
```

--------------------------------

### setUpConversationNodeWithSpeech

Source: https://wiki.blast.hk/ru/moonloader/scripting-api

Sets up a conversation node with speech.

```APIDOC
## setUpConversationNodeWithSpeech

### Description
Sets up a conversation node with question and answer texts and associated speech audio.

### Parameters
- **question** (GxtString) - Required - The question text.
- **answerY** (GxtString) - Required - The yes answer text.
- **answerN** (GxtString) - Required - The no answer text.
- **questionWav** (int) - Required - Audio ID for the question.
- **answerYWav** (int) - Required - Audio ID for the yes answer.
- **answerNWav** (int) - Required - Audio ID for the no answer.
```

--------------------------------

### sampGetCurrentServerAddress usage example

Source: https://wiki.blast.hk/moonloader/lua/sampGetCurrentServerAddress

Example usage of sampGetCurrentServerAddress to retrieve the server address and display it in chat.

```lua
ip, port = sampGetCurrentServerAddress()
sampAddChatMessage("Адрес сервера: "..ip..":"..port.."!", -1)
```

--------------------------------

### setUpConversationNodeWithScriptedSpeech(GxtString questionGXT, GxtString answerYesGXT, GxtString answerNoGXT, int questionWAV, int answerYesWAV, int answerNoWAV)

Source: https://wiki.blast.hk/ru/moonloader/scripting-api

Sets up a conversation node with scripted speech for question and answers.

```APIDOC
## setUpConversationNodeWithScriptedSpeech(GxtString questionGXT, GxtString answerYesGXT, GxtString answerNoGXT, int questionWAV, int answerYesWAV, int answerNoWAV)

### Description
Sets up a conversation node with scripted speech for question and answers.

### Parameters
- **questionGXT** (GxtString) - Required - The GXT string for the question.
- **answerYesGXT** (GxtString) - Required - The GXT string for the yes answer.
- **answerNoGXT** (GxtString) - Required - The GXT string for the no answer.
- **questionWAV** (int) - Required - The WAV file identifier for the question.
- **answerYesWAV** (int) - Required - The WAV file identifier for the yes answer.
- **answerNoWAV** (int) - Required - The WAV file identifier for the no answer.

### Returns
None
```

--------------------------------

### hasDeatharrestBeenExecuted usage example

Source: https://wiki.blast.hk/moonloader/lua/hasDeatharrestBeenExecuted

Example usage: checks if the character is dead or arrested and prints a message if so.

```lua
if hasDeatharrestBeenExecuted() then -- если персонаж мертв, то
print('Вы умерли!') -- вывести "Вы умерли!"
end
```

--------------------------------

### Example usage of slideObject in Lua

Source: https://wiki.blast.hk/ru/moonloader/lua/slideObject

Example usage of slideObject in a MoonLoader script. Creates an object and moves it to specified coordinates, sending chat messages while moving and when finished. Registers a chat command 'ufo' to trigger the example.

```lua
function createSlideObj(modelId, startX, startY, startZ, toX, toY, toZ, speedX, speedY, speedZ)
    local objectHandle = createObject(modelId, startX, startY, startZ)
    local slided = false
    lua_thread.create(function ()
        while not slided do
            wait(0)
            slided = slideObject(objectHandle, toX, toY, toZ, speedX, speedY, speedZ, false)
            sampAddChatMessage('Двигаем объект!', -1)
        end
        sampAddChatMessage('Объект передвинут', -1)
    end)
end
function main()
    while not isSampAvailable() do wait(0) end
    sampRegisterChatCommand('ufo', function()
        local x, y, z = getCharCoordinates(PLAYER_PED)
        local to_x, to_y, to_z = x, y + 100, z + 5
        createSlideObj(18846, x, y, z + 20, to_x, to_y, to_z, 1, 0.1, 0.1)
        sampAddChatMessage('Создали объект', -1)
    end)
    wait(-1)
end
```

--------------------------------

### setUpConversationEndNodeWithSpeech(GxtString gxtString, int speech)

Source: https://wiki.blast.hk/ru/moonloader/opcodes

Sets up a conversation end node with speech.

```APIDOC
## setUpConversationEndNodeWithSpeech(GxtString gxtString, int speech)

### Description
Sets up a conversation end node with speech.

### Parameters
- **gxtString** (GxtString) - Required - The GXT string.
- **speech** (int) - Required - The speech audio ID.

### Return Value
None.
```

--------------------------------

### Example usage of renderDrawBox

Source: https://wiki.blast.hk/moonloader/lua/renderDrawBoxWithBorder

Example call to renderDrawBoxWithBorder (note: the example uses renderDrawBox, not renderDrawBoxWithBorder). Draws a rectangle at (10,15) with size 200x80, fill color 0xAA00CC00, border thickness 3, and border color 0x90000000.

```lua
renderDrawBox(10, 15, 200, 80, 0xAA00CC00, 3, 0x90000000)
```

--------------------------------

### startCredits() - вызов титров

Source: https://wiki.blast.hk/moonloader/lua/startCredits

Вызывает титры после прохождения игры на экран. Функция не принимает аргументов.

```lua
startCredits()
```

--------------------------------

### bool result = startNewCustomScript(zstring filepath, table args)

Source: https://wiki.blast.hk/ru/moonloader/scripting-api

Starts a new custom script with the given file path and arguments.

```APIDOC
## bool result = startNewCustomScript(zstring filepath, table args)

### Description
Starts a new custom script with the given file path and arguments.

### Parameters
- **filepath** (zstring) - Required - The path to the script file.
- **args** (table) - Required - A table of arguments to pass to the script.

### Returns
- **result** (bool) - True if the script started successfully, false otherwise.
```

--------------------------------

### setCarProofs usage example

Source: https://wiki.blast.hk/moonloader/lua/setCarProofs

Example usage: stores the car the player is in and sets all immunity flags to true.

```lua
car = storeCarCharIsInNoSave(playerPed)
setCarProofs(car, true, true, true, true, true)
```

--------------------------------

### setCarCruiseSpeed usage example

Source: https://wiki.blast.hk/moonloader/lua/setCarCruiseSpeed

Example usage of setCarCruiseSpeed, setting the cruise speed of the vehicle 'mycar' to 120.0.

```lua
setCarCruiseSpeed(mycar, 120.0)
```

--------------------------------

### Usage example: registering and handling a chat command

Source: https://wiki.blast.hk/ru/moonloader/lua/sampRegisterChatCommand

Complete example that registers the command 'mycmd' and defines its handler. The handler checks if an argument is provided and prints appropriate messages. The main function waits for SA:MP and SAMPFUNCS to be loaded before registering the command.

```lua
function main()
  if not isSampLoaded() or not isSampfuncsLoaded() then return end
  while not isSampAvailable() do wait(100) end
  sampRegisterChatCommand("mycmd", cmd_mycmd)
  wait(-1)
end

function cmd_mycmd(arg)
  if #arg == 0 then
    print("Command 'mycmd' syntax: /mycmd [something]")
  else
    print("MyCmd: input = " .. arg)
  end
end
```
Tokens:
Raw