Skip to content
MTA:SA Neon Documentation

setFoliageSurface

Client-side
NEON APICustom foliage

Available in Neon, not standard MTA

Changes which GTA surface type a foliage patch grows, rebuilding the native triangle.

Syntax

bool setFoliageSurface(foliage theFoliage, int surface)

Arguments

theFoliagefoliage

Foliage element.

surfaceint

Surface ID from 0 through 255 with plant properties defined.

Returns

true when the surface was accepted and the patch rebuilt; false for an out-of-range surface or one with no plant properties.

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
  • The rebuild is atomic: a rejected surface leaves the patch on its previous one.

OOP aliases

  • foliage:setSurface(surface)
  • foliage.surface

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 →