SA:O APIObject fracture effects

Drops every cached fracture geometry entry.

Syntax

Copy signature

bool clearBreakEffectCache()

Returns

true when the cache was cleared.

Ownership and lifecycle

A break effect belongs to the resource that created it and is removed when that resource stops. Fragment geometry is cached per model, so repeated fractures of the same model reuse the first computed cut until the cache is cleared.

Important behavior

• Worth calling after a scene that fractured many different models, since each entry holds generated geometry.

Where this comes from

SOURCECLuaBreakEffectDefs.cppClient/mods/deathmatch/logic/luadefs/CLuaBreakEffectDefs.cpp INTRODUCED / EXTENDED418f250d6Read the commit and why the change was made TEST RESOURCE break-test test-resources/break-test

RELATED SA:O APIS

Continue exploring

Read the system guide →

createObjectBreakEffect Fractures a streamed object into fragments cut from its own live geometry. setObjectBreakProfile Gives an object durability so ordinary GTA damage fractures it on its own. getObjectBreakProfile Returns the durability profile armed on an object.

← Previous in categorygetBreakEffectCacheSize

← Back to the SA:O Lua API · How Object fracture effects works →