Skip to content
MTA:SA Neon Documentation

getFoliageDensity

Client-side
NEON APICustom foliage

Available in Neon, not standard MTA

Returns the density multiplier of a foliage patch.

Syntax

float|false getFoliageDensity(foliage theFoliage)

Arguments

theFoliagefoliage

Foliage element.

Returns

The density from 0.0 through 10.0, or false when the element is not a foliage element.

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.

OOP aliases

  • foliage:getDensity()
  • 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 →