Skip to content
MTA:SA Neon Documentation

setFoliageDensity

Client-side
NEON APICustom foliage

Available in Neon, not standard MTA

Changes how thickly a foliage patch grows, rebuilding the native triangle.

Syntax

bool setFoliageDensity(foliage theFoliage, float density)

Arguments

theFoliagefoliage

Foliage element.

densityfloat

Multiplier from 0.0 through 10.0, where 1.0 is the native density for that surface.

Returns

true when the density was accepted and the patch rebuilt; false for a negative, above-10, or non-finite value.

Ownership and lifecycle

A foliage element belongs to the resource that created it and joins its element group, so stopping the resource removes its patches without explicit cleanup. Every setter rebuilds the native triangle atomically and rolls back to the previous state when the new combination is rejected.

Important behavior
  • 0.0 empties the patch while keeping the element alive.
  • The rebuild is atomic: a rejected density leaves the previous one in place.

OOP aliases

  • foliage:setDensity(density)
  • foliage.density

Where this comes from

SOURCECLuaFoliageDefs.cppClient/mods/deathmatch/logic/luadefs/CLuaFoliageDefs.cpp INTRODUCED / EXTENDED29e4398beRead the commit and why the change was made TEST RESOURCE foliage-test test-resources/foliage-test
RELATED NEON APIS

Continue exploring

Read the system guide →
createFoliage Grows GTA's native plants inside a world-space triangle by registering it with the native plant manager. getFoliageVertices Returns the three world-space corners of a foliage patch. setFoliageVertices Replaces the three corners of a foliage patch and rebuilds the native triangle.

← Back to the Neon Lua API · How Custom foliage works →