Neon Lua API

engineSetRadarMapTile

Registers or replaces a resource-owned TXD in one cell of Neon's sparse 40 × 40 native radar grid.

engineResetRadarMapTile

Removes a radar tile owned by the calling resource and restores the native ocean fallback.

engineGetRadarMapStats

Returns the current extended-radar hook, registration, loading, failure, and source-byte counters.

11 ENTRIES

Server-authoritative models

engineRequestModel

Allocates a stable, resource-owned logical model for an object, vehicle, or ped.

engineFreeModel

Releases a logical model owned by the calling resource after remapping surviving elements to their native parent.

engineGetModelParent

Returns the native GTA parent of an active server-managed logical model.

engineGetModelName

Returns the active model's resource-qualified registry name.

engineGetModelType

Returns whether a server-managed model is an object, vehicle, or ped.

engineGetModelIDFromName

Resolves a server-managed model by resource-local or fully qualified name.

engineGetModels

Enumerates active server-managed logical model IDs, optionally filtered by type.

engineIsModelAllocated

Reports whether a logical model definition is currently active.

engineGetModelAvailableCount

Returns the number of additional model definitions the calling resource may allocate.

engineGetModelRuntimeID

Resolves a stable server model ID to the GTA runtime slot allocated on this client.

engineGetModelServerID

Reverse-resolves a client runtime slot to its stable server logical model ID.

6 ENTRIES

Renderer and distant lights

engineGetRendererStats

Returns current, session-high-water, and capacity counters for Neon's expanded renderer arrays.

engineResetRendererStats

Resets renderer high-water measurements without changing capacities or active objects.

engineSetDistantLightsEnabled

Enables or disables Neon's native Project2DFX distant static lights.

engineSetDistantLightsDrawDistance

Sets the distant-light draw distance.

engineRebuildDistantLights

Refreshes the distant-light catalogue from Neon's startup capture and currently available world data.

engineGetDistantLightStats

Returns Project2DFX catalogue, visible render-queue, and capacity counters.

6 ENTRIES

Native CULL zones

engineGetCullZones

Lists adopted vanilla and custom CULL zones, optionally filtered by zone type.

engineCreateCullZone

Creates a resource-owned native CULL zone and returns its stable ID.

engineSetCullZone

Replaces an owned or claimed zone definition while retaining its stable ID.

engineSetCullZoneEnabled

Enables or disables a custom zone or a vanilla zone claimed by the caller.

engineRemoveCullZone

Deletes an owned custom zone or temporarily removes a claimed vanilla zone.

engineRestoreCullZone

Restores a claimed vanilla zone to its original definition and releases the caller's edit state.

2 ENTRIES

Marker diagnostics

getMarkerLimitStats

Returns MTA marker-streamer usage plus GTA 3D marker, checkpoint, and direction-arrow capacities.

renderScriptImportantArea

Submits GTA's SCM important-area visual: three pulsing additive red cylinders with native ground correction.

3 ENTRIES

Procedural seabed

setWorldSeaBedOuterBoundary

Sets and synchronizes the square procedural-seabed boundary.

resetWorldSeaBedOuterBoundary

Restores and synchronizes GTA's unlimited procedural seabed.

getWorldSeaBedOuterBoundary

Returns the currently applied procedural-seabed boundary.

2 ENTRIES

Model-native walking styles

setPedUseNativeWalkingStyle

Makes a ped follow the current skin model's native motion group, or restores MTA's explicit walking-style path.

client + server

isPedUsingNativeWalkingStyle

Reports whether model-native walking-style selection is active for a ped.

client + server

5 ENTRIES

Synchronized ambient pedestrians

updateAmbientPedPopulationModels

Runs GTA's ped-only zone-model residency pass around an origin without enabling unmanaged population creation.

getAmbientPedSpawnCandidate

Asks GTA's native civilian and path rules for one read-only ambient-ped proposal.

resetAmbientPedPopulationModels

Releases the stock population-model residency established by the ambient-ped update pass.

addPedNativeGunAimedAtEvent

Inserts GTA's real aimed-at event on the authoritative ambient-ped owner.

addPedNativeDamageResponseEvent

Replays GTA's civilian damage decision on the authoritative owner without applying physical damage again.

2 ENTRIES

Resource-owned streaming leases

acquireElementStreamingLease

Acquires one resource-owned reference that keeps a streaming-compatible element present in the local GTA world.

releaseElementStreamingLease

Releases one live element-streaming token owned by the calling resource.

40 ENTRIES

Native ped tasks and gang tags

Movement & social

10 APIs

setPedGoTo

Replaces the owned ped's primary task with GTA's native go-to-and-stand-still task.

setPedChatWith

Starts GTA's native partner-chat task between two distinct peds.

setPedStandStill

Queues GTA's simple stand-still task on a simulated ped.

setPedJump

Starts GTA's native jump, airborne, optional climb, and landing task chain on a ped simulated by this client.

setPedTurnToFace

Queues GTA's native body-turn task so an owned ped faces another live ped.

setPedGoToOffset

Makes a ped seek a radius-and-angle offset around another ped using GTA's native entity task.

setPedWander

Starts GTA's standard on-foot wander task.

setPedScriptedSpeechMuted

Enables or suppresses a ped's GTA scripted speech without muting unrelated game audio.

setPedFacialTalk

Requests GTA's native FACTALK expression on a streamed ped's persistent facial controller.

stopPedFacialTalk

Stops all active requests on a streamed ped's native facial controller.

setPedEnterVehicleEXTENSION

Vehicles & driving

4 APIs

Extends MTA's authoritative vehicle-entry lifecycle with a verified native passenger-entry task after server confirmation.

setPedExitVehicleEXTENSION

Extends MTA's authoritative vehicle-exit lifecycle with a verified native leave-car task on the syncer.

setPedDriveWander

Assigns GTA's indefinite road-cruising task to an owned ped already driving an owned vehicle.

setPedDriveTo

Queues GTA's finite road-driving task for an owned ped in the driver seat of an owned vehicle.

Combat

6 APIs

setPedKillOnFoot

Queues GTA's native on-foot kill task against another ped.

setPedDriveBy

Queues GTA's native gang drive-by task for an owned script ped already riding in an owned vehicle.

setPedShootAt

Replaces the owned ped's primary task with GTA's native coordinate GunControl firing task.

getPedWeaponShootingRate

Reads GTA's current shooting-rate byte from a streamed ped's native instance.

setPedWeaponShootingRate

Sets GTA's persistent shooting-rate byte used by native gun tasks.

setPedWeaponAccuracy

Sets GTA's persistent 0–255 weapon-accuracy byte used for shot spread.

Actor policies

13 APIs

setPedMissionActor

Persists GTA's PED_MISSION classification on a script-created ped across native model recreation.

isPedMissionActor

Reports the locally persisted mission-actor policy, including while the native model is streamed out.

acquirePedNativeEventProfile

Exclusively leases one of Neon's stock native-event adapters for a script ped.

releasePedNativeEventProfile

Releases one native ped event-profile token owned by the calling resource.

isPedNativeEventProfileActive

Reports whether this resource's native event-profile lease is active for the current authoritative ped generation.

setPedStoryProtected

Persists GTA's grouped story-actor protection flags on a script ped across native recreation.

isPedStoryProtected

Reports the locally persisted grouped story-actor protection policy.

setPedSuffersCriticalHits

Persists GTA's critical-hit policy on a script ped without enabling the broader story-protection tuple.

getPedSuffersCriticalHits

Reads the locally persisted critical-hit policy for a script ped, including while it is streamed out.

setPedStayInSamePlace

Persists GTA's scalar stay-in-place flag on a script ped without assigning a stand-still task.

getPedStayInSamePlace

Reads the effective local stay-in-place flag for a script ped.

setPedNeverTargeted

Persists only GTA's never-targeted bit without enabling the grouped protagonist protection policy.

isPedNeverTargeted

Reads the effective local never-targeted policy for a script ped.

Sequences

2 APIs

setPedTaskSequence

Builds and dispatches one native GTA sequence containing up to eight supported child tasks.

getPedTaskSequenceProgress

Returns the zero-based child index of a ped's active native UseSequence task.

Gang tags

5 APIs

setObjectGangTagAlpha

Sets a logical 0–255 Grove-material alpha on a streamed native gang-tag object, or clears the opt-in override.

acquireObjectGangTag

Gives the calling resource exclusive ownership of a supported tag object and registers it with GTA's native spray path.

setObjectGangTagProgress

Applies an authoritative 0–255 progress byte to a gang tag owned by the calling resource.

getObjectGangTagProgress

Reads the persistent progress byte of an acquired gang tag.

releaseObjectGangTag

Unregisters an owned tag from GTA's native spray path and clears its Grove-material override.

6 ENTRIES

Native story vehicle state

setVehicleDoorLockMode

Sets and persists GTA's raw native door-lock mode without reducing it to a boolean.

getVehicleDoorLockMode

Reads the vehicle's raw native door-lock mode, including a locally persisted streamed-out value.

setVehicleTyresCanBurst

Sets and persists GTA's native tyre-burst policy independently from ordinary body damage.

getVehicleTyresCanBurst

Reads the vehicle's live or locally persisted native tyre-burst policy.

setVehiclePhysicalProofs

Sets and persists GTA's five independent physical-proof flags on a vehicle.

setVehicleLoadCollisionFlag

Persists GTA's mission-car collision-loading and physics-to-ghost policy independently from ordinary element collisions.

3 ENTRIES

Native scene primitives

enginePreloadWorldAreaInDirection

Runs GTA's directional scene request and synchronous load sequence used by story transitions.

reportVehicleMissionAudioEvent

Reports one verified GTA script-audio event on a streamed vehicle's native audio entity.

isVehicleOnAllWheels

Reproduces GTA opcode 09D0's exact all-four-contact vehicle gate.

14 ENTRIES

Native script camera

acquireScriptCamera

Acquires the resource-exclusive GTA script camera and returns a generation token.

releaseScriptCamera

Restores captured gameplay camera state and optionally leaves a successful scene under its black fade.

isScriptCameraLeaseActive

Reports whether the calling resource still owns the specified camera generation.

setScriptCameraFixed

Activates GTA's fixed script camera and native point-at control.

moveScriptCamera

Starts GTA's native camera-position vector track.

trackScriptCamera

Starts GTA's native look-at target vector track.

setScriptCameraPersist

Selects whether completed position and target tracks retain their endpoints.

resetScriptCamera

Resets GTA's scriptable camera interpolation components without releasing the lease.

fadeScriptCamera

Runs GTA's native fade under the current camera lease.

isScriptCameraFading

Reports the native fade state for the current camera generation.

isScriptCameraMoveRunning

Reports whether the native position track is still running.

isScriptCameraTrackRunning

Reports whether the native look-at track is still running.

setScriptCameraWidescreen

Uses GTA's native widescreen transition under the current lease.

setScriptCameraNearClip

Sets GTA's scripted near clip, or clears the override with false.

11 ENTRIES

Native file cutscenes

requestFileCutscene

Acquires the exclusive camera lease, optionally owns GTA's visible world area, and starts loading a stock file cutscene.

isFileCutsceneLeaseActive

Reports whether the calling resource still owns this file-cutscene generation.

isFileCutsceneLoaded

Reports whether GTA has finished loading the owned DAT/CUT/IFP cutscene data.

startFileCutscene

Starts an owned, fully loaded native file cutscene exactly once.

fadeFileCutscene

Runs GTA's native fade while the file-cutscene lease is active.

isFileCutsceneFading

Reports the native fade state for the current file-cutscene generation.

isFileCutsceneFinished

Reports native camera-spline completion after this lease successfully started playback.

isFileCutsceneSkipInputPressed

Reads GTA's original cutscene skip input without applying the skip locally.

wasFileCutsceneSkipped

Reports whether GTA's native skip path completed the owned playback.

skipFileCutscene

Applies GTA's native skip path to the owned playback.

releaseFileCutscene

Deletes the owned native cutscene and restores the camera, near clip, widescreen, and controls captured by its lease.

6 ENTRIES

Native mission and frontend audio

playMissionPassedTune

Plays one of GTA's two native mission-passed beat tracks.

requestMissionAudio

Preloads a supported GTA script-audio event and returns a resource-owned opaque handle.

isMissionAudioLoaded

Reports whether an owned native mission-audio event has finished loading.

playMissionAudio

Starts one loaded mission-audio handle exactly once through GTA's native player.

isMissionAudioFinished

Reports natural completion after playback has started.

releaseMissionAudio

Clears an owned native event and releases its physical mission-audio slot.

4 ENTRIES

Resource-owned vehicle audio

engineLoadVehicleAudioConfig

Acquires the client-wide vehicle-audio lease and loads Soundize-compatible model definitions from the calling resource.

engineReloadVehicleAudioConfig

Reparses the current owner's definitions and schedules a clean lazy restart of the vehicle-audio banks.

engineUnloadVehicleAudioConfig

Stops the calling resource's custom vehicle audio, restores GTA audio, and releases the global lease.

enginePlayVehicleAudioBackfire

Plays a normal or high custom backfire on a vehicle already active in the owned audio system.

7 ENTRIES

Native mission text

acquireMissionText

Exclusively loads one GTA mission GXT block for the calling resource.

showMissionText

Queues a translated key through GTA's native small-message PRINT_NOW path.

showMissionHelp

Displays a translated key through GTA's native help-message HUD.

showMissionBigText

Queues GTA's native big mission text, optionally substituting one number.

clearMissionTexts

Clears the calling resource's tracked small and big native messages.

clearMissionHelp

Clears the calling resource's native help message.

releaseMissionText

Clears owned messages/help and releases the exclusive mission-text lease.

5 ENTRIES

Native vehicle recordings

requestVehicleRecording

Acquires and requests one registered GTA carrec recording for the calling resource.

isVehicleRecordingLoaded

Reports whether a registered recording currently has a streamed native frame buffer.

startVehiclePlayback

Starts direct non-looped GTA recorded-car playback on a vehicle owned by the local unoccupied-vehicle syncer.

stopVehiclePlayback

Stops playback when the calling resource owns the vehicle's active native slot.

isVehiclePlaybackActive

Reports whether GTA's native 16-slot player currently contains the vehicle.

6 ENTRIES

Verified Neon identity and bans

isPlayerNeonAuthenticated

Reports whether the server accepted a signed Neon Identity ticket for this player connection.

getPlayerNeonID

Returns the verified global Neon account UUID attached to a player connection.

getPlayerDiscordID

Returns the Discord identifier carried by a player's verified Neon Identity ticket.

getBanNeonID

Reads the Neon account UUID stored on a server ban.

getBanDiscordID

Reads the Discord identifier stored on a server ban.

addBanEXTENSION

Extends MTA's existing ban constructor with optional verified Neon and Discord identity fields.

2 ENTRIES

Existing API extensions

setGlitchEnabledEXTENSION

Adds the Neon-only fastweaponstrafe option to MTA's existing synchronized glitch API.

isGlitchEnabledEXTENSION

Reads the synchronized Neon fastweaponstrafe state through MTA's existing glitch API.