NEON APIModel 2DFX effects

Available in Neon, not standard MTA

Removes one 2DFX effect from a model, including an effect GTA shipped.

Syntax

Copy signature

bool removeModel2DFX(int model, int index)

Arguments

modelint

Model ID from 0 through 65535.

indexint

Effect index on the model.

Returns

true when the effect was removed; false for an invalid model or index.

Ownership and lifecycle

Custom effects belong to the resource that added them. Overrides and removals of original GTA effects are stacked per resource, so two resources editing the same model do not clobber each other, and stopping one rolls back only its own layer.

Important behavior

• Removing an original GTA effect is recorded as this resource's override and rolled back when the resource stops.
• Use restoreModel2DFX to put an original effect back without stopping the resource.

Where this comes from

SOURCECLua2DFXDefs.cppClient/mods/deathmatch/logic/luadefs/CLua2DFXDefs.cpp INTRODUCED / EXTENDED27e3972e7Read the commit and why the change was made TEST RESOURCE 2dfx-test test-resources/2dfx-test

RELATED NEON APIS

Continue exploring

Read the system guide →

addModel2DFX Adds a resource-owned 2DFX effect to a GTA model. restoreModel2DFX Restores an original GTA effect that this resource removed. resetModel2DFXEffects Rolls a model back to its original 2DFX state, dropping this resource's additions and overrides.

← Previous in categoryaddModel2DFX Next in category →restoreModel2DFX

← Back to the Neon Lua API · How Model 2DFX effects works →