NEON APIResource-owned streaming leases

Available in Neon, not standard MTA

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

Syntax

Copy signature

bool releaseElementStreamingLease(int token)

GTA task mapping

NATIVE GTA BEHAVIOR

No CTask is created

This releases an MTA streaming reference. Any native task lost during the resulting stream-out is not reconstructed by this function.

Arguments

tokenint

Token returned to this resource by acquireElementStreamingLease.

Returns

true when the owned token was released; false for an unknown, stale, or foreign token.

Ownership and lifecycle

Each token belongs to the client resource that acquired it and contributes one independent streaming reference. Element destruction invalidates its target, explicit release removes it, and resource shutdown releases every surviving token.

Important behavior

• Releasing the last reference allows normal MTA streaming to remove the element again.
• Element destruction makes the retained target safe to discard; resource shutdown releases every remaining token automatically.

Where this comes from

SOURCECLuaElementDefs.cppClient/mods/deathmatch/logic/luadefs/CLuaElementDefs.cpp INTRODUCED / EXTENDED2314459caRead the commit and why the change was made TEST RESOURCE native-simulation-lease-test test-resources/native-simulation-lease-test

RELATED NEON APIS

Continue exploring

Read the system guide →

acquireElementStreamingLease Acquires one resource-owned reference that keeps a streaming-compatible element present in the local GTA world. setPedUseNativeWalkingStyle Makes a ped follow the current skin model's native motion group, or restores MTA's explicit walking-style path. isPedUsingNativeWalkingStyle Reports whether model-native walking-style selection is active for a ped.

← Previous in categoryacquireElementStreamingLease

← Back to the Neon Lua API · How Resource-owned streaming leases works →